Export a document to Excel
POST {{baseUrl}}/api/documents/:id/instances/:instanceId/excel
Export a document from a specific document instance to an Excel file. You obtain the authorization token needed to execute the request using POST /auth/login and the project ID using GET /project; you pass the authorization token and the project ID in the request header. You identify the document, the document instance, and the visualization in the path of the request, by specifying the document ID, the document instance ID, and the key that identifies the visualization; you get the document instance ID using POST /documents/{id}/instances. The body of the request contains formatting information. Both grid and graph are supported for documents; only grid is supported for dossiers.
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 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-excel/200-OK.xlsx. |
ENDPOINTS