Read a cube
GET {{baseUrl}}/api/model/cubes/:cubeId
The response returns the definition of a single attribute. The project ID is required to return an attribute's definition in the metadata.
The changeset ID is required to return an attribute's definition within a specific changeset.
To execute the request, either the project ID or changeset ID needs to be provided.
If both are provided, only the changeset ID is used. The changeset ID can be obtained using the changeset creation API.
An authorization token is required to execute the request and can be obtained using Authentication endpoints.relationships
is a read-only field and it returns the relationship(s) of this attribute as a set of tuples (pairs of related attributes) with their relationship type (1-N, 1-1, etc.) and corresponding relationship table.
It contains the same information as GET systemHierarchy/attributes/{attributeId}/relationships.
To update the relationship(s) of the attribute, use PUT systemHierarchy/attributes/{attributeId}/relationships.
Body
PARAM
| Key | Datatype | Required | Description |
showFilterTokens
|
boolean | Specify whether the cube "filter" is returned in "tokens" format, along with "text" and "tree" formats. The cube filter is presented in the following formats: "text": A human readable, but non-parsable text, describing a filter's qualification. "tree": A tree data structure fully defining the filter's qualification. "tokens": A list of parsed tokens that define a filter's qualification. Be aware that generating tokens requires additional time. If omitted or false, only "text" and "tree" formats are returned. If true, all "text", "tree" and "tokens" formats are returned. | |
showExpressionAs
|
string | This parameter specifies the format in which the expressions are returned in response. This parameter applies to the expressions in a fact or attribute and custom expressions used in a filter, prompt, security filter, custom group, etc. Expressions are presented in the following formats: "text": A human readable, but non-parsable text, describing the expression. This is the default format that is always returned in the response. "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Note that generating tokens requires additional time. Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). If omitted, the expression is returned in "text" format. If tree, the expression is returned in "text" and "tree" formats. If tokens, the expression is returned in "text" and "tokens" formats. Available values : tokens, tree |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Curl curl -X GET 'baseUrl/api/model/cubes/:cubeId?showFilterTokens=false&showExpressionAs=tokens' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |