Dimension GetList

Retrieves information about a dimension or multiple dimensions. For example, the timestamp of the last update, load status, and so on.

Request

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Dimension" Method="GetList">
    <Alea:Dimensions NameFilter="Product" detailed="true" WithHierarchies="true"/>
  </Alea:Request>
</Alea:Document>

If NameFilter is not present or empty, information about all accessible dimensions is returned. If NameFilter is specified, it is interpreted as a regular expression. The NameFilter attribute is optional.

If the detailed attribute is set to true, detailed information is returned. This attribute is optional. The default is false.

If the WithHierarchies attribute is set to true, a list of hierarchies for each dimension is returned. This attribute is optional. The default is false. Hierarchy information is available only on dimensions that are in memory, the dimensions will be loaded if they are not already in memory.

Answer

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Return>
      <Alea:Dimensions Count="1">
        <Alea:DimensionInfo Name="PRODUCT">
          <Alea:Description>Product</Alea:Description>
          <Alea:DACCube Name="#DAC PRODUCT" />
          <Alea:AttributeTable ID="1" FieldCount="9" />
          <Alea:AttributeTable ID="2" FieldCount="5" />
          <Alea:ElementCount Value="66" />
          <Alea:HighestLevel Value="3" />
          <Alea:Loaded Value="true" />
          <Alea:Modified Value="false" />
          <Alea:TimeStamp Value="1483969820" LastModified="2017-01-09T13:50:20.000" />
          <Alea:UserDefined Value="0" />
          <Alea:ODBOType Value="2" />
          <Alea:ListHierarchies>
            <Alea:Hierarchy Name="PRODUCT" HierarchyType="Parent/Child" DefaultHierarchy="true">
              <Alea:Description>Product</Alea:Description>
              <Alea:UserDefaultElement Name="All Tires" />
              <Alea:Levels>
                <Alea:Level Number="0" Name="All" />
                <Alea:Level Number="1" Name="Product Group" />
                <Alea:Level Number="2" Name="Tire" />
                <Alea:Level Number="3" Name="Size" />
              </Alea:Levels>
            </Alea:Hierarchy>
            <Alea:Hierarchy Name="Speed Rating" HierarchyType="Attribute-driven">
              <Alea:Description>Tires by Speed Rating</Alea:Description>
              <Alea:UserDefaultElement Name="All Speed Ratings" />
              <Alea:Levels>
                <Alea:Level Number="0" Name="All" />
                <Alea:Level Number="1" Name="Speed Ratings" />
                <Alea:Level Number="2" Name="Tires" />
              </Alea:Levels>
            </Alea:Hierarchy>
            <Alea:Hierarchy Name="Tire Size" HierarchyType="Attribute-driven">
              <Alea:Description>Tires by Size</Alea:Description>
              <Alea:UserDefaultElement Name="All Sizes" />
              <Alea:Levels>
                <Alea:Level Number="0" Name="All" />
                <Alea:Level Number="1" Name="Sizes" />
                <Alea:Level Number="2" Name="Tires" />
              </Alea:Levels>
            </Alea:Hierarchy>
          </Alea:ListHierarchies>
        </Alea:DimensionInfo>
      </Alea:Dimensions>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>


Element	Description
`Alea:DACCube`	The `Name` attribute contains the name of the Dimension Access Control (DAC) cube. If no DAC cube has been defined for this dimension, the `Name` attribute is an empty string.
`Alea:AttributeTable`	Contains the ID of an attribute table (1-3) and the count of its fields in the `FieldCount` attribute. There can be up to three attribute tables.
`Alea:ElementCount`	The number of elements of the dimension.
`Alea:HighestLevel`	The highest level number among all the hierarchies of the dimension. See `Alea:Levels`. If all dimension elements are on the top level, the number 0 will be returned.
`Alea:Loaded`	Indicates if the dimension is loaded into memory.
`Alea:Modified`	Indicates if the dimension was altered since the last save.
`Alea:TimeStamp`	The `LastModified` attribute provides the date and time in UTC. The `Value` attribute is deprecated and should no longer be used.
`Alea:UserDefined`	User defined additional information (number).
`Alea:ODBOType`	The possible values for the `ODBOType` are documented with the Dimension PutProperties function.
`Alea:Hierarchy`	Besides the name of the hierarchy, it contains the boolean `DefaultHierarchy` attribute which indicates if this hierarchy is the default hierarchy for this dimension. It also contains the `HierarchyType` attribute which can have one of these values: Parent/Child Attribute-driven
`Alea:Hierarchy / Alea:Description`	The description of the hierarchy.
`Alea:Hierarchy / Alea:Levels`	The list of `Alea:Level` elements with the `Number` attribute (the level number) and the `Name` attribute (the level name). If a level name was not defined explicitly, the default level name is returned.
`Alea:Hierarchy / Alea:UserDefaultElement`	The user specific default element of the hierarchy (for the user who executed the XML function). If no element on the hierarchy is visible to the user, the `Name` attribute is empty.

Error

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Error ErrorID="error_code"/>
  </Alea:Request>
</Alea:Document>