Get the hierarchy of a dossier
GET {{baseUrl}}/api/v2/dossiers/:dossierId/definition
Get the hierarchy of a specific dossier including with crossTab in visualization in a specific project. A dossier and a document have the same base object; a dossier is simply a different view of the document. This request returns the tree structure of the dossier - root, chapters, current chapter, pages, in-canvas/chapter-level selectors,visualization as filter, dataset infos and visualizations. 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 by specifying the dossier ID in the path of the request; you are using the document/dossier ID that was generated by another API.
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 |
RESPONSES
status
ENDPOINTS