Update an incremental refresh report
PUT {{baseUrl}}/api/model/incrementalRefresh/:irrId?showExpressionAs=tree&showFilterTokens=true
Creates a new user hierarchy in the changeset, based on the definition provided in request body. The definition of the newly created user hierarchy is returned in response. User hierarchies have different subtypes. Currently, we support the following subtypes:
* dimensionuser: This user hierarchy is for drilling.
* dimensionuser_hierarchy: This user hierarchy is for browsing. In the request body, there are four main parts:
* Information: Stores basic user hierarchy information such as name, subType, destinationFolderId, etc. name is required field.
* UseAsDrillHierarchy: This Boolean field indicates the user hierarchy subtype. False means the subtype is dimensionuserhierarchy; otherwise, it is dimension_user. This field is required.
* Attributes: Stores the hierarchy attributes for the user hierarchy in a list. Each hierarchy attribute contains an objectId, name, entryPoint, filters, elementDisplayOption, and limit. objectId, entryPoint, and elementDisplayOption are required fields.
* Relationships: Stores the hierarchy relationships for the user hierarchy in a list. Each hierarchy relationship contains parent, and child. parent and child are required fields. Each user hierarchy should have at least one entry attribute for browsing. The entryPoint field in a hierarchy attribute is Boolean. It indicates whether the current attribute is a single entry point attribute. Users can define filters and element display options to control element display for each hierarchy attribute. ElementDisplayOption contains the following values:
* allelements: This attribute shows all elements when browsing.
* noelements: This attribute does not show any elements when browsing.
* limitedelements: This attribute shows limited elements when browsing, within the defined limit. The limit field is only required for limitedelements. 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 user hierarchy to the metadata, commit using the changeset commit API.
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. | |
showFilterTokens
|
boolean | Specify whether the "condition" in threshold is returned in "tokens" format, along with "text" and "tree" formats. The "condition" in threshold is presented in the following formats: "text": A human readable, but non-parsable text, describing a condition's qualification. "tree": A tree data structure fully defining the condition's qualification. "tokens": A list of parsed tokens that define a condition'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. | |
showAdvancedProperties
|
boolean | Specify whether to retrieve the values of the advanced properties. The advanced properties are presented in the following groups: "vldbProperties": A list of properties as determined by the common infrastructure. "metricJoinTypes": A list of Metric Join Types, one for each metric that appears in the template. "attributeJoinTypes": A list of Attribute Join Types, one for each attribute that appears in the template. If omitted or false, nothing will be returned for the advanced properties. If true, all applicable advanced properties are returned.
Curl curl -X PUT 'baseUrl/api/model/incrementalRefresh/:irrId?showExpressionAs=tree&showFilterTokens=true?showExpressionAs=tree&showFilterTokens=true&showAdvancedProperties=true' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"incrementType":"report","refreshType":"update","advancedProperties":{"vldbProperties":{"AnalyticalEngineProperties":{".":{"ConsolidationSubtotal":{"name":"ConsolidationSubtotal","value":"false"}}}}}}' ENDPOINTS |