Read a drill map
GET {{baseUrl}}/api/model/drillMaps/:drillMapId
The response returns the definition of a single drill map. The project ID is required to return a drill map's definition in metadata. The changeset ID is required to return a drill map'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. 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.
Body
PARAM
Key | Datatype | Required | Description |
showFields
|
string | Specify what additional information is returned. Only "acl" is supported. If acl, the access control list for each object is included. |
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": "0BA90A3C9EAE4F3F89441B7051B381F3",
"primaryLocale": "en-US",
"objectId": "381C062C774E46F1903B678EFE35FA78",
"subType": "drill_map",
"name": "Test DrillMap",
"destinationFolderId": "D3C7D461F69C4610AA6BAA5EF51F4125"
},
"drillPaths": [
{
"type": "up",
"target": {
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name": "Year"
},
"priority": "low",
"options": {
"setName": "Set1",
Curl curl -X GET 'baseUrl/api/model/drillMaps/:drillMapId?showFields=acl' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'X-MSTR-MS-Changeset: rd_changesetId' ENDPOINTS |