Dimension ListSubsets (12.0.1)
Retrieves a list of subsets bound to a specified hierarchy or from all hierarchies of the specified dimension.
Request
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="1" Class="Dimension" Method="ListSubsets">
<Alea:Dimension Name="DimName" Access="All">
<Alea:Hierarchy Name="HierarchyName" />
</Alea:Dimension>
</Alea:Request>
</Alea:Document>
This table describes the structure of the
Alea:Dimension
XML element for ListSubsets
:
XML object | Description |
---|---|
@Name
|
Mandatory. The dimension name. |
@Access
|
Optional. You
can specify the access type of the subsets to return:
|
Alea:Hierarchy |
Optional. If missing, the default hierarchy is used. |
@Name |
Optional. Use to request subsets from a specific hierarchy. Or, use an asterisk (*) to request subsets of all hierarchies. If missing, the default hierarchy is used. |
This request returns all subsets for all hierarchies of a dimension:
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="1" Class="Dimension" Method="ListSubsets">
<Alea:Dimension Name="DimName">
<Alea:Hierarchy Name="*" />
</Alea:Dimension>
</Alea:Request>
</Alea:Document>
This request returns all subsets for the default hierarchy of a dimension:
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="1" Class="Dimension" Method="ListSubsets">
<Alea:Dimension Name="DimName" />
</Alea:Request>
</Alea:Document>
Answer
The hierarchy name is always returned. If a hierarchy name is not specified in the request, the default hierarchy name is returned.
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001">
<Alea:Return>
<Alea:Dimension Name="D212">
<Alea:Hierarchy Name="test2">
<Alea:Subset Name=" 1" Public="true" User="Admin" UserData="0" Type="9">
<Alea:Description>Test</Alea:Description>
</Alea:Subset>
</Alea:Hierarchy>
</Alea:Dimension>
</Alea:Return>
</Alea:Request>
</Alea:Document>
This table describes the values returned for the XML Type
attribute. The Type
attribute is a bitfield.
Flag | Value | Description |
---|---|---|
SST_PUBLIC |
0x01 | Global subset |
SST_PRIVATE |
0x02 | Private subset |
SST_STATIC |
0x08 | Static subset |
SST_DATA_QUERY |
0x10 | Dynamic subset, data query |
SST_ATTR_QUERY |
0x20 | Dynamic subset, attribute query |
SST_ALL |
(SST_PUBLIC / SST_PRIVATE) | All public subsets and my private subsets. This flag is not returned but can be used in the request to filter the results. |
SST_ALLSUBSETS |
0x04 | All public and private subsets. This flag is not returned but can be used in the request to filter the results. |
Error
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="007">
<Alea:Error ErrorID="error_code"/>
</Alea:Request>
</Alea:Document>