Logo
MicroStrategy REST API API Documentation

Delete a derived element in report through Modelling Service

DELETE {{baseUrl}}/api/model/reports/:reportId/derivedElements/:derivedElementId

This API will delete the specified derived element in report. Please be noted that for standalone derived element, it will not be deleted from metadata.Instead, this API just removed the reference from report to standalone derived element.

A report instance ID is required to execute the request, and it can be obtained using the report instance creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.

Set Prefer to respond-async to execute this API asynchronously. Use GET /model/reports/{reportId}/derivedElements/{derivedElementId} API to check the status.

 

Body PARAM

Key Datatype Required Description 
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.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
X-MSTR-MS-Instance
string (Required) Report instance ID
Prefer
string




RESPONSES

Curl
curl -X DELETE 'baseUrl/api/model/reports/:reportId/derivedElements/:derivedElementId?showExpressionAs=tree' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-MS-Instance: rd_reportInstanceId' -H 'Prefer: respond-async'

ENDPOINTS