Get the query details of grid/graph visualizations in the dossier.
GET {{baseUrl}}/api/dossiers/:dossierId/instances/:instanceId/queryDetails
Get the query details of a visualization in a specific dossier in a specific project. A dossier and a document have the same base object; a dossier is simply a different view of the document. 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 dossier, the dossier instance, the dossier chapter, and the dossier visualization in the path of the request, by specifying the IDs of the dossier and dossier instance and the keys of the chapter and visualization. You are using the document/dossier ID that was generated by another API. You obtain the dossier instance ID using POST /dossiers/{dossierId}/instances. You obtain the dossier chapter key and the dossier visualization key using GET /api/v2/dossiers/{dossierId}/definition. It is important to note that the chapter and page active in this instance is possible to be changed.
Body
PARAM
| Key | Datatype | Required | Description |
chapterKey
|
null | Chapter key | |
visualizationKey
|
null | Visualization key | |
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
ENDPOINTS