Getting the Details of a Universe (Semantic Layer)

Usage

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

Request

GET /universes/<universeID>?aggregated=<aggregated>

Where:

  • <aggregated> is an optional, Boolean parameter that indicates if the outline must be aggregated. Default value is false.
Influence of the aggregated Parameter

The UNX universe details returned depend on the <aggregated> parameter value:

  • 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 true, the call returns an aggregated 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 the master view is granted, then the outline returned with the calls .../<universeID>?aggregated=false and .../<universeID>?aggregated=true are the same, except the value of aggregated outline attribute.

Even if UNV universes do not support the concept of view introduced with UNX universes, for API consistency, the BI Semantic Layer RESTful Web Service can also behave as if a UNV universe had only one master view containing all the universe content. When returning this view, the <aggregated> parameter has no impact on the response and the value of the aggregated outline attribute is false in the response.
Response

Response type: application/xml or application/json

Response body: the details of the universe. See Universes.

Example

The Master View is Granted

GET /universes/5808?aggregated=false

or

GET /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" hasLov="false">
                <id>_IBo8ObIhEeCk0Ylv-tlF2Q</id>
                <name>Customer Id</name>
                <path>Customer|folder\Customer Id|dimension</path>
            </item>
            <item dataType="String" type="Dimension" hasLov="false">
                <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" hasLov="false">
                    <id>_IBo8MrIhEeCk0Ylv-tlF2Q</id>
                    <name>Continent Id</name>
                    <path>Customer|folder\Geography|folder\Continent Id|dimension</path>
                </item>
                <item dataType="String" type="Dimension" hasLov="false">
                    <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" hasLov="false">
                <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" hasLov="false">
                <id>_oGzSYLaaEeCH2d6gof1MOA</id>
                <name>Reference Quarter</name>
                <path>Quarterly KPIs|folder\Reference Quarter|measure</path>
                <aggregationFunction>Sum</aggregationFunction>
            </item>
            <item dataType="Numeric" type="Measure" hasLov="false">
                <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" hasLov="false">
                <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 /universes/5808?aggregated=false

or

GET /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 /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>