Getting the Details of a Universe (Web Intelligence)

Usage

Gets the details of a universe referenced by its ID.

Request

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

Where:

  • <aggregated> is an optional, Boolean parameter that is supported if the universe is UNX only. It is ignored if the universe is UNV.

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 or application/json

Response body: details of the universe, see Universes.

Example

The master view is granted

GET /universes/9100?aggregated=false

or

GET /universes/9100

<universe>
    <id>9100</id>
    <cuid>AftJgs7FPGNBmkdNDnoG8Aw</cuid>
    <name>unx2</name>
    <type>unx</type>
    <folderId>9089</folderId>
    <path>Application Folder/Root Folder/Universes/</path>
    <connected>true</connected>
    <outline aggregated="false">
        <folder>
            <name>City</name>
            <item type="BODimension" dataType="Numeric">
                <name>City Id</name>
                <id>DO1</id>
                <path>City|folder\City Id|dimension</path>
            </item>
            <item type="BODimension" dataType="String">
                <name>City</name>
                <id>DO2</id>
                <path>City|folder\City|dimension</path>
            </item>
            <item type="BODimension" dataType="Numeric">
                <name>Region Id</name>
                <id>DO3</id>
                <path>City|folder\Region Id|dimension</path>
            </item>
        </folder>
        <folder>
            <name>Country</name>
            <item type="BODimension" dataType="Numeric">
                <name>Country Id</name>
                <id>DO4</id>
                <path>Country|folder\Country Id|dimension</path>
            </item>
            <item type="BODimension" dataType="String">
                <name>Country</name>
                <id>DO5</id>
                <path>Country|folder\Country|dimension</path>
            </item>
        </folder>
        <folder>
            <name>Customer</name>
            <item type="BODimension" dataType="Numeric">
               <name>Cust Id</name>
                <id>DO6</id>
                <path>Customer|folder\Cust Id|dimension</path>
            </item>
            <item type="BODimension" dataType="String">
                <name>First Name</name>
                <id>DO7</id>
                <path>Customer|folder\First Name|dimension</path>
            </item>
            ...
            <item type="BODimension" dataType="Numeric">
                <name>City Id</name>
                <id>DOc</id>
                <path>Customer|folder\City Id|dimension</path>
            ...
        </folder>
        ...
        <folder>
            <name>Reject</name>
            <item type="BODimension" dataType="Numeric">
                <name>Item Id</name>
                <id>DO1e</id>
                <path>Reject|folder\Item Id|dimension</path>
            </item>
            <item type="BODimension" dataType="dateTime">
                <name>Inspection Time</name>
                <id>DO1f</id>
                <path>Reject|folder\Inspection Time|dimension</path>
            </item>
            <item type="BODimension" dataType="String">
                <name>Defect Type</name>
                <id>DO20</id>
                <path>Reject|folder\Defect Type|dimension</path>
            </item>
            <item type="BODimension" dataType="String">
                <name>Nb Rejected</name>
                <id>DO21</id>
                <path>Reject|folder\Nb Rejected|dimension</path>
            </item>
        </folder>
        <folder>
            <name>Inspection</name>
            <item type="BODimension" dataType="Numeric">
                <name>Item Id</name>
                <id>DO22</id>
                <path>Inspection|folder\Item Id|dimension</path>
            </item>
            <item type="BODimension" dataType="dateTime">
                <name>Inspection Time</name>
                <id>DO23</id>
                <path>Inspection|folder\Inspection Time|dimension</path>
            </item>
            <item type="BODimension" dataType="String">
                <name>Nb Inspected</name>
                <id>DO24</id>
                <path>Inspection|folder\Nb Inspected|dimension</path>
            </item>
        </folder>
        ...       
        <folder>
            <name>unv2 Measures</name>
            <item type="Measure" dataType="Numeric">
                <name>Number of Measurement Value</name>
                <id>DO35</id>
                <path>unv2 Measures|folder\Number of Measurement Value|measure</path>
            </item>
            <item type="Measure" dataType="Numeric">
                <name>Min of Measurement Value</name>
                <id>DDO36</id>
                <path>unv2 Measures|folder\Min of Measurement Value|measure</path>
            </item>
            ...
            <item type="Measure" dataType="Numeric">
                <name>Number of Nb Rejected</name>
                <id>DO39</id>
                <path>unv2 Measures|folder\Number of Nb Rejected|measure</path>
            </item>
        </folder>
    </outline>
</universe>

Example

The master view is denied

GET /universes/9100?aggregated=false

or

GET /universes/9100

Response:

<universe>
    <id>9100</id>
    <cuid>AftJgs7FPGNBmkdNDnoG8Aw</cuid>
    <name>unx2</name>
    <type>unx</type>
    <folderId>9089</folderId>
    <path>Application Folder/Root Folder/Universes/</path>
    <connected>true</connected>
    <outline aggregated="false">
        <businessViewName>MyView</businessViewName>
        <folder>
            ...
    </outline>
</universe>

Example

The call requests an aggregated outline

GET /universes/9100?aggregated=true

Response:

<universe>
    <id>9100</id>
    <cuid>AftJgs7FPGNBmkdNDnoG8Aw</cuid>
    <name>unx2</name>
    <type>unx</type>
    <folderId>9089</folderId>
    <path>Application Folder/Root Folder/Universes/</path>
    <connected>true</connected>
    <outline aggregated="true">
        <folder>
            ...
    </outline>
</universe>