Getting the Details of a Universe

Gets the details of a universe referenced by its ID.
Note The detailed information of the universe describes only the default perspective.
Request

GET <webiURL>/universes/{universeId}

Where:

  • {universeId} is the universe identifier
Response

Response type: application/xml or application/json

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

  • <id>
  • <cuid>
  • <name> in the requested locale
  • <type>
  • <folderId>, which is the ID of the folder that contains the universe in the CMS repository
  • <connected>, which is true if the connection with the RDBMS is set
  • <outline>, which describes the business layer details:
    • <folder>
    • <item>, which type is BODimension, 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

Example

GET <webiURL>/universes/9100

<universe>
    <id>9100</id>
    <cuid>AftJgs7FPGNBmkdNDnoG8Aw</cuid>
    <name>unv2</name>
    <type>unv</type>
    <folderId>9089</folderId>
    <connected>true</connected>
    <outline>
        <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>