Getting the Details of a Universe (Semantic Layer)

Gets the details of a UNX universe referenced by its ID.

Request

GET <slURL>/universes/{universeId}?aggregated={true|false}

Where:

  • {universeId} is the universe identifier retrieved from the list of universes
  • aggregated is an optional, Boolean parameter.

The universe details returned depend on the aggregated value:

  • If true, the call returns the outline containing all folders and objects granted to the user. This outline merges all granted objects from the granted business view and contains all objects properties such as ID, path, and name.
  • If false, the call returns the master view if granted or the default view if the master view is denied. The default view name is returned in the outline using the <businessViewName> element. This behavior is the one implemented in the SDK versions prior to 4.1 SP5.

If the master view is granted, then the outline returned with the calls .../{universeId}?aggregated=false and .../{universeId}?aggregated=true are the same, except the aggregated outline attribute value.

Response

Response type: application/xml

Response body: details of the universe, see Universe XML Grammar.

Example

The master view is granted

GET <slURL>/universes/5808?aggregated=false

or

GET <slURL>/universes/5808

Response:

<universe>
    <id>5808</id>
    <cuid>AUW2qRdU0IdPkyhlpZWrxvo</cuid> 
    <name>Warehouse.unx</name>
    <type>unx</type>
    <folderId>5807</folderId>
    <maxRowsRetrieved>5000</maxRowsRetrieved>
    <maxRetrievalTime>600</maxRetrievalTime>
    <outline aggregated="false">
        <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>

Example

The master view is denied

GET <slURL>/universes/5808?aggregated=false

or

GET <slURL>/universes/5808

Response:

<universe>
    <id>5808</id>
    <cuid>AUW2qRdU0IdPkyhlpZWrxvo</cuid> 
    <name>Warehouse.unx</name>
    <type>unx</type>
    <folderId>5807</folderId>
    <maxRowsRetrieved>5000</maxRowsRetrieved>
    <maxRetrievalTime>600</maxRetrievalTime>
    <outline aggregated="false">
        <businessViewName>MyView</businessViewName>
        <folder>
            ...
    </outline>
</universe>

Example

The call requests an aggregated outline

GET <slURL>/universes/5808?aggregated=true

Response:

<universe>
    <id>5808</id>
    <cuid>AUW2qRdU0IdPkyhlpZWrxvo</cuid> 
    <name>Warehouse.unx</name>
    <type>unx</type>
    <folderId>5807</folderId>
    <maxRowsRetrieved>5000</maxRowsRetrieved>
    <maxRetrievalTime>600</maxRetrievalTime>
    <outline aggregated="true">
        <folder>
            ...
    </outline>
</universe>