MicroStrategy REST API API Documentation
Read a transformation
GET {{baseUrl}}/api/model/transformations/:transformationId
The response returns the definition of a single transformation. 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.
Body
PARAM
| Key | Datatype | Required | Description |
showExpressionAs
|
null | 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. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
status OK
| {
"information": {
"versionId": "E17480BC6B014CB39AC352F561C51975",
"primaryLocale": "en-US",
"objectId": "3627081C5E9F4E83B606C87A2D062045",
"subType": "role_transformation",
"name": "Last year's",
"destinationFolderId": "98FE182C2A10427EACE0CD30B6768258"
},
"attributes": [
{
"id": "89C719CB25BD484694DE4186057421F6",
"baseAttribute": {
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name&qu Curl curl -X GET 'baseUrl/api/model/transformations/:transformationId?showExpressionAs=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Changeset: rd_changesetId' ENDPOINTS |