Cube GetPerspectivesList

Retrieves a list of perspectives that are visible to the sender.

Request

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="14" Class="Cube" Method="GetPerspectivesList">
    <!-- exactly one of the following two filters must be used -->
    <Alea:Perspectives NameFilter="SalesPerspectiveLC1" detailed="true" />
    <Alea:Cubes NameFilter="SALES" detailed="true" />
  </Alea:Request>
</Alea:Document>

The NameFilter attribute indicates the selection of perspectives. It is optional. If NameFilter is missing or empty, all visible perspectives are returned. If NameFilter is specified, then it is interpreted as a regular expression that matches the perspectives based either on their names or on their base cube names.

Use the detailed attribute to retrieve additional details about the perspectives. That is, the timestamp of their creation and their validity. The detailed attribute is optional. Its default is false.

Answer

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="14">
    <Alea:Return>
      <Alea:Perspectives Count="1">
        <Alea:PerspectiveInfo Name="SalesPerspectiveLC1">
          <Alea:Cube>SALES</Alea:Cube> 
          <Alea:Description>Sales cube - the perspective for the context local currency 1</Alea:Description>
          <Alea:ContextRelated>true</Alea:ContextRelated> 
          <Alea:TimeStamp LastModified="2022-09-14T10:40:42.232" /> 
          <Alea:Valid>true</Alea:Valid> 
        </Alea:PerspectiveInfo>
      </Alea:Perspectives>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

Error

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

Example

This is an example of an answer when the detailed attribute was false or not specified:

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="14">
    <Alea:Return>
      <Alea:Perspectives Count="1">
        <Alea:PerspectiveInfo Name="SalesPerspectiveLC1">
          <Alea:Cube>SALES</Alea:Cube>
          <Alea:Description>Sales cube - the perspective for the context local currency 1</Alea:Description>
          <Alea:ContextRelated>true</Alea:ContextRelated>
        </Alea:PerspectiveInfo>
      </Alea:Perspectives>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>
Related topics