MicroStrategy REST API API Documentation
Download a package binary
GET {{baseUrl}}/api/packages/:packageId/binary
Download a package binary. 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 provide the ID of the package you want to download in the path of the request which can be obtained using POST /packages.
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 | Project ID |
RESPONSES
status OK
| The response is a binary file. Please view the sample response binary file at https://github.com/MicroStrategy/rest-api-playground/blob/main/sample-responses/Packages/download-a-package-binary/200-OK. |
Curl
curl -X GET 'baseUrl/api/packages/:packageId/binary?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'
ENDPOINTS