MicroStrategy REST API API Documentation
Export a document to .mstr file
POST {{baseUrl}}/api/documents/:id/instances/:instanceId/mstr
Export a specific document in a specific project to an .mstr file. You obtain the authorization token needed to execute the request using POST /auth/login and the project ID using GET /project; you specify the authorization token and the project ID in the request header. You identify the document by specifying the document ID and the document instance ID in the path of the request; you get the document instance ID using POST /documents/{id}/instances.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID |
RESPONSES
status OK
| The response is too large. Please view the response at https://github.com/MicroStrategy/rest-api-playground/blob/main/sample-responses/Dossiers-and-Documents/export-a-document-to-mstr-file/200-OK.json. |
Curl
curl -X POST 'baseUrl/api/documents/:id/instances/:instanceId/mstr?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'
ENDPOINTS