Universe XML Grammar

The following XML describes the global structure of a universe as returned by the calls .../universes/{universeId} of the RESTful Web Service SDKs.

<universe>
    <id>
    <cuid>
    <name>
    <description>
    <type>
    <folderId>
    <maxRowsRetrieved>
    <maxRetrievalTime>
    <connected>
    <outline aggregated="true|false">
        <businessViewName>
        <folder>
            <id>
            <name>
            <item dataType="string" type="string">
                <id>
                <name>
                <path>

The universe details are described using the following children elements:

Child Element Description
<id> The universe identifier
<cuid> The unique CUID of the universe in the CMS repository
<name> The universe name in the requested locale
<description> The universe description
<type> The universe type:
  • unx only if the call is made with the Semantic Layer RESTful Web Service SDK
  • unx or unv if the call is made with the Web Intelligence RESTful Web Service SDK
<folderId> The ID of the folder that contains the universe in the CMS repository
<path> The universe path in the CMS repository
<customProperty> Optional custom properties
<maxRowsRetrieved> An option that defines the restrictions from the data source that can apply to queries
<maxRetrievalTime> An option that defines the restrictions from the data source that can apply to queries
<connected> A Boolean value that is 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> The business layer details. <outline> has the aggregated attribute that indicates whether the universe outline is aggregated:
  • 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.

The following table shows the <outline> children elements.

Child Element Description
<businessViewName> The name of the default view if the master view is denied
<folder> A universe folder in the CMS repository. Folders can have custom properties.
The following table shows the <folder> children elements.
Child Element Description
<id> The folder identifier
<name> The folder name
<item> An object of the folder. Item type can be:
  • Dimension, Measure, Attribute or Filter if the call is made with the BI Semantic Layer RESTful Web Service SDK
  • BODimension, Measure, Attribute or Filter if the call is made with the Web Intelligence RESTful Web Service SDK

Each item has a <name>, an <id>, and a <path>. The item path is the object full path and is available only for .unx universes. It adheres to some particular rules. See Naming the Object Full Paths.

The following table describes the <item> attributes.

Note These attributes cannot be used with folders and predefined filters.
Attribute Description
dataType The object data type (string, number, date, or dateTime)
forResult Specifies whether the object can be used as a result object (default is true)
forFilter Specifies whether the object can be used as filter (default is true)
forSort Specifies whether the object can be used to sort data (default is true)
aggregationFunction The aggregation function used for measures only (none, which is the default, Average, Sum, Count, First, Last, Max, Min, or Delegated)