Getting the Details of a Universe

Gets the details of a universe referenced by its ID.

Note This service supports the localization in HTTP request headers via Accept-Language or X-SAP-PVL, that are used to localize the User Interface for universe metadata loading, error messages, and resource names.
Request

GET <slURL>/universes/{universeId}

Where:

  • {universeId} is the universe identifier retrieved from the list of universes
Response

Response type: application/xml

Response body: details of the universe made of the following information:

  • <id>
  • <cuid>
  • <name> in the requested locale
  • <type> (unx)
  • <folderId>, which is the ID of the folder that contains the universe in the CMS repository
  • <customProperty> (optional)

Options define the restrictions from the data source that can apply to queries:

  • <maxRowsRetrieved>
  • <maxRetrievalTime>

Business layer details are described in the <outline> using the following attributes:

  • <folder>
  • <item>, which type is Dimension, Measure, Attribute or Filter.
  • Each item has name, id, and path.

    The item path is the object full path and adheres to some particular rules. See Naming the Object Full Paths

Folders and items can have custom properties.

Items can have the following attributes:

  • dataType (string, number, date, or dateTime)
  • forResult, if the object can be used as a result object (default is true)
  • forFilter, if the object can be used as filter (default is true)
  • forSort, if the object can be used as to sort data (default is true)
  • aggregationFunction (none, which is the default, Average, Sum, Count, First, Last, Max, Min, or Delegated). Is for measures only.
Note These attributes cannot be used with folders and predefined filters.

Example

GET <slURL>/universes/5808

<universe>
    <id>5808</id>
    <cuid>AUW2qRdU0IdPkyhlpZWrxvo</cuid> 
    <name>Warehouse.unx</name>
    <type>unx</type>
    <folderId>5807</folderId>
    <maxRowsRetrieved>5000</maxRowsRetrieved>
    <maxRetrievalTime>600</maxRetrievalTime>
    <outline>
        <folder>
            <id>_IBo8OLIhEeCk0Ylv-tlF2Q</id>
            <name>Customer</name>
            <item dataType="Numeric" type="Dimension">
                <id>_IBo8ObIhEeCk0Ylv-tlF2Q</id>
                <name>Customer Id</name>
                <path>Customer|folder\Customer Id|dimension</path>
            </item>
            <item dataType="String" type="Dimension">
                <id>_IBo8OrIhEeCk0Ylv-tlF2Q</id>
                <name>Customer</name>
                <path>Customer|folder\Customer|dimension</path>
 	          </item>
            <folder>
                <id>_IBo8LbIhEeCk0Ylv-tlF2Q</id>
                <name>Geography</name>
                <item dataType="Numeric" type="Dimension">
                    <id>_IBo8MrIhEeCk0Ylv-tlF2Q</id>
                    <name>Continent Id</name>
                    <path>Customer|folder\Geography|folder\Continent Id|dimension</path>
                </item>
                <item dataType="String" type="Dimension">
                    <id>_IBo8M7IhEeCk0Ylv-tlF2Q</id>
                    <name>Continent</name>
                    <path>Customer|folder\Geography|folder\Continent|dimension</path>
                </item>
                ...
            </folder>
        </folder>
	       ...
        <folder>
            <id>_IB8eE7IhEeCk0Ylv-tlF2Q</id>
            <name>Inventory</name>
            <item dataType="Numeric" type="Measure">
                <id>_IB8eFrIhEeCk0Ylv-tlF2Q</id>
                <name>Stock Level</name>
                <path>Inventory|folder\Stock Level|measure</path>
            </item>
            <item type="Filter">
                <id>_V5_GkLR_EeCZotjuycya1A</id>
                <name>Stock Below Minimum</name>
                <path>Inventory|folder\Stock Below Minimum|filter</path>
            </item>
        </folder>
        <folder>
            <id>_H4I54LaXEeCH2d6gof1MOA</id>
            <name>Quarterly KPIs</name>
            <item dataType="Numeric" type="Measure">
                <id>_oGzSYLaaEeCH2d6gof1MOA</id>
                <name>Reference Quarter</name>
                <path>Quarterly KPIs|folder\Reference Quarter|measure</path>
                <aggregationFunction>Sum</aggregationFunction>
            </item>
            <item dataType="Numeric" type="Measure">
                <id>_vsi7wLaaEeCH2d6gof1MOA</id>
                <name>Same Quarter Last Year</name>
                <path>Quarterly KPIs|folder\Same Quarter Last Year|measure</path>
                <aggregationFunction>Sum</aggregationFunction>
            </item>
            <item dataType="Numeric" type="Measure">
                <id>_68SKoLaaEeCH2d6gof1MOA</id>
                <name>YTY Change</name>
                <description>Year-to-Year Change</description>
                <path>Quarterly KPIs|folder\YTY Change|measure</path>
                <aggregationFunction>Sum</aggregationFunction>
            </item>
            ...
        </folder>    
    </outline>
</universe>