Logo
MicroStrategy REST API API Documentation

Update a transformation

PATCH {{baseUrl}}/api/model/transformations/:transformationId

Updates a specific transformation in the changeset, based on the definition provided in the request body. It returns the transformation's updated definition in the changeset.

In the request body, attributes contains a list of transformation attributes. Each transformation attribute contains baseAttribute and forms. * baseAttribute: refer to a normal attribute the transformation attribute based on. * forms: a list of transformation attribute forms, which are generated according to base attribute key forms. Each transformation attribute form contains: * lookupTable: required for the object to be commited to the metadata. * expression: Needs to be in either tree or tokens format. * Tokens are a semi-structured representation of MicroStrategy expression text that includes object references.

Provide mappingType, to define a mapping relationship. It can be either one_to_one or many_to_many.

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.

To save the newly created transformation to the metadata, commit using the changeset commit API.

 

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 (Required) Changeset ID




RESPONSES

Curl
curl -X PATCH 'baseUrl/api/model/transformations/:transformationId?showExpressionAs=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Changeset: rd_changesetId' -d '{"information":{"name":"Last year's","destinationFolderId":"publicObjectsFolderId"},"attributes":[{"baseAttribute":{"objectId":"8D679D5111D3E4981000E787EC6DE8A4"},"forms":[{"id":"45C11FA478E745FEA08D781CEA190FE5","lookupTable":{"objectId":"8D6793C211D3E4981000E787EC6DE8A4"},"expression":{"tokens":[{"value":"YEAR_ID - 1"}]}}]}],"mappingType":"one_to_one"}'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS