Logo
MicroStrategy REST API API Documentation

Get PDF export result

GET {{baseUrl}}/api/documents/:id/instances/:instanceId/pdf/results/:resultId

Get the result of the PDF exporting using export result ID. 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 and the document instance 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; you get the result ID using POST {id}/instances/{instanceId}/pdf with Prefer respond-async header.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
X-MSTR-ProjectID
string (Required) Project ID
Prefer
string Prefer--allow client to set preferences. Currently, respond-async allows client to execute in async mode




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/get-pdf-export-result/200-OK.json.



Curl
curl -X GET 'baseUrl/api/documents/:id/instances/:instanceId/pdf/results/:resultId' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Prefer: respond-async'

ENDPOINTS