Logo
MicroStrategy REST API API Documentation

Create a drill map

POST {{baseUrl}}/api/model/drillMaps

Creates a new drill map in the changeset, based on the definition provided in the request body. The definition of the newly created drill map is returned in the response.

In the request body, there are two main parts:

  • Information: Stores basic drill map information such as name, subType, destinationFolderId, etc. name and destinationFolderId are required fields.
  • DrillPaths: Stores an array of drill path objects.

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 drill map to the metadata, commit using the changeset commit API.

 

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-MS-Changeset
string (Required) Changeset ID
X-MSTR-AuthToken
string (Required) Authorization Token




RESPONSES

status Created

{ "information": { "versionId": "0BA90A3C9EAE4F3F89441B7051B381F3", "primaryLocale": "en-US", "objectId": "381C062C774E46F1903B678EFE35FA78", "subType": "drill_map", "name": "Test DrillMap", "destinationFolderId": "D3C7D461F69C4610AA6BAA5EF51F4125" }, "drillPaths": [] }



Curl
curl -X POST 'baseUrl/api/model/drillMaps?showFields=acl' -H 'X-MSTR-MS-Changeset: rd_changesetId' -H 'X-MSTR-AuthToken: authToken' -d '{"information":{"name":"Test DrillMap","destinationFolderId":"publicReportsFolderId"}}'

ENDPOINTS