Read a consolidation
GET {{baseUrl}}/api/model/consolidations/:consolidationId
This API gets a detailed definition for a specified consolidation. An information field describes the common object information such as the object ID, creation time, version ID, etc. A drillMap field describes the object
reference information of the drillMap that can be used when drilling. The elements field describes embedded consolidation elements defined in this consolidation.
A subtotal field describes the aggregation behavior and is disabled by default. The project ID is required to return a consolidation's definition in metadata. The changeset ID is required to return a consolidation's definition within a specific changeset.
To execute the request, either the project ID or changeset ID needs to be provided. If both are provided, only the changeset ID is used. A 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 |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Project ID | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
status OK
| {
"information": {
"versionId": "60E586C4CAB748CB9FCB0E3B9BF04B9A",
"primaryLocale": "en-US",
"objectId": "78B5870872E140FBA196428AA97CCE94",
"subType": "consolidation",
"name": "New Consolidation2",
"destinationFolderId": "98FE182C2A10427EACE0CD30B6768258"
},
"drillMap": {
"objectId": "431367544A6C1EC401599989093E375C",
"subType": "drill_map",
"name": "Category Sales Report prompted on Category Item Drill Map"
},
"elements": [
{
"id": "6004F7D6703049389BCA5F87B4E7FAFF",
"name": "element1",
"type": "calculation",
"format": {
"header": [],
"values": []
},
"expression": {
"text": "1",
"tree": {
"type": "constant",
"variant": {
"type": "double",
"value": "1.0"
}
}
}
}
],
"subtotal": "enable"
} |