Universes

Remember The RESTful Web Service SDKs support relational universes created with the information design tool (UNX) and with the universe design tool (UNV).
Response Body Schema (XML)

(GET .../universes/<universeID>)

<universe>
    <id>
    <cuid>
    <name>
    <description>
    <type>
    <folderId>
    <path>
    <maxRowsRetrieved>
    <maxRetrievalTime>
    <connected>
    <outline aggregated="Boolean">
        <businessViewName>
        <item>
        <folder>
            <id>
            <name>
            <description>
            <customProperty name="string">
            <item>
            <folder>
Element Type or Value Description
<id> integer The universe identifier
<cuid> string The unique CUID of the universe in the CMS repository
<name> string The universe name in the requested locale
<description> string The universe description
<type> unv|unx The universe type
<folderId> integer The ID of the folder that contains the universe in the CMS repository
<path> string The universe path in the CMS repository (returned if the GET call is made with the Web Intelligence RESTful Web Service SDK)
<maxRowsRetrieved> integer An option that defines the restrictions from the data source that can apply to queries
<maxRetrievalTime> integer An option that defines the restrictions from the data source that can apply to queries
<connected> Boolean true if the connection with the RDBMS is set (returned if the GET call is made with the Web Intelligence RESTful Web Service SDK)
<outline> N/A The business layer details.

Attribute: aggregated (Boolean)

  • If aggregated is true, the outline is aggregated.
  • If aggregated is false, the outline is the master view if it is granted, or the default view if the master view is denied.
Element Type Description
<businessViewName> string The name of the default view if the master view is denied
<item> N/A An object of the universe
<folder> N/A A UNX universe folder or UNV universe class
<item type="string" dataType="string" hasLov="Boolean" forResult="Boolean" forFilter="Boolean" forSort="Boolean">
    <id>
    <name>
    <description>
    <customProperty name="string">
    <item>
    <path>
    <aggregationFunction>
Element Type Description
<id> string The object identifier
<name> string The object name
<description> string The object description
<customProperty> string Optional custom property for UNX universes only

Attribute: name (string)

<item> N/A A child object
<path> string The object full path, which adheres to some particular rules. See Object Full Paths.
<aggregationFunction> Average|Sum|Count|First|Last

|Max|Min|Delegated|none

The aggregation function used for measures only. Default is none.
Note These attributes cannot be used with folders and predefined filters.
Attribute Type or Value Description
type string The object type in the universe (dimension, measure, attribute, and so on)
dataType String|Numeric|DateTime The object data type
hasLov Boolean Specifies whether the object has a list of values (for dimensions, measures, attributes, levels and hierarchies)
forResult Boolean Specifies whether the object can be used as a result object (default is true)
forFilter Boolean Specifies whether the object can be used as filter (default is true)
forSort Boolean Specifies whether the object can be used to sort data (default is true)
Element Type or Value Description
<id> string The folder identifier (for UNX universes only)
<name> string The folder name
<description> string The folder description
<customProperty> string Optional custom property for UNX universes only

Attribute: name (string)

<item> N/A An object of the folder
<folder> N/A A subfolder