Create an incremental refresh report through Modeling service
POST {{baseUrl}}/api/model/incrementalRefresh
Create an incremental refresh report. The API creates an incremental refresh report definition. This doesn't refresh the target cube's data. You need to use POST /api/incrementalRefresh/{incrementalRefreshReportId} to refreh the target cube's data. In the request body, For custom expressions, The project ID is required to create an incremental refresh report in metadata. An authorization token is required to execute the request and can be obtained using Authentication endpoints.filter
needs to be in either tree
or tokens
format. If both are provided, only tree
is used.expression
needs to be in either tree
or tokens
format. If both are provided, only tree
is used. For inline custom expressions, only the tree
format is supported.
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
, RevenueID), (>
, GreaterThanID), (Cost
, Cost_ID).
Body
PARAM
| Key | Datatype | Required | Description |
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. | |
showExpressionAs
|
string | This parameter specifies the format in which the expressions are returned in response. | |
showFilterTokens
|
boolean | Specify whether the "condition" in filter is returned in "tokens" format, along with "text" and "tree" formats. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Curl curl -X POST 'baseUrl/api/model/incrementalRefresh?showAdvancedProperties=true&showExpressionAs=tree&showFilterTokens=true' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -d '{"information":{"destinationFolderId":"publicObjectsFolderId","subType":"report_increment_refresh","name":"IRR_new"},"targetCube":{"objectId":"6C204A564286DEB3E2CACB98762272C0","subType":"report_cube","name":"Profit and Revenue Cube"},"incrementType":"filter","refreshType":"update_only"}' ENDPOINTS |