MicroStrategy REST API API Documentation
Create an instance of a document
POST {{baseUrl}}/api/documents/:id/instances
Execute a specific document in a specific project and create an instance of the document. The request returns the message ID of the document instance that was created. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You identify the document by specifying the document ID in the path of the request.
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 | |
Content-Type
|
string |
RESPONSES
status Created
| {
"status": 1,
"mid": "8645F712C548CAAB72BFE19FE43E3C72"
} |
Curl
curl -X POST 'baseUrl/api/documents/:id/instances?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json'
ENDPOINTS