Get the hierarchy of a dossier
GET {{baseUrl}}/api/v2/dossiers/:dossierId/definition?fields=Excepteur Lorem
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, pages/chapter-level selectors, 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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | Comma separated top-level field whitelist. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of 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: OK
{"id":"sunt adipisicing quis","name":"qui ipsum est dolor","chapters":[{"key":"laboris incididunt","name":"ullamco amet in anim deserunt","pages":[{"key":"anim ea nostrud","name":"ipsum in","visualizations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"key":"fugiat in in consequat ullamco","name":"id","visualizations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"filters":[{"key":"sunt proident voluptate eu","name":"enim Duis","summary":"dolor in fugiat","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"key":"tempor occaecat et aute","name":"Du","summary":"ipsum id consequat","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"filtersPanelStack":{"key":"est velit in"}},{"key":"Excepteur dolor","name":"L","pages":[{"key":"laboris fugiat culpa consequat enim","name":"proide","visualizations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"key":"laborum minim eu nisi","name":"eiusmod id laborum esse","visualizations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"filters":[{"key":"reprehenderit do veniam labore","name":"voluptate","summary":"pariatur dolore Duis quis aliquip","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"key":"laboris pariatur ex ipsum","name":"ad do cillum dolore","summary":"anim aliqua sit dolor dolore","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"filtersPanelStack":{"key":"ad adipisici"}}]}