Get the hierarchy of a dossier
GET {{baseUrl}}/api/dossiers/:dossierId/definition?fields=Excepteur Lorem
Get the hierarchy of 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. 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 sit ","name":"fugiat cillum anim ut","chapters":[{"key":"sint in","name":"aliqua nulla Ut","pages":[{"key":"pariatur ad nisi et dolor","name":"fugiat magna do","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":"Ut al","name":"culpa dolor amet veniam mollit","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":"elit","name":"eu aliqua do","summary":"Excepteur incid","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"key":"in voluptate","name":"eiusmod in","summary":"in ipsum","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"filtersPanelStack":{"key":"qui"}},{"key":"Excepteur sit id in","name":"id sunt minim in eiusmod","pages":[{"key":"minim null","name":"magna Duis","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":"aliquip mollit s","name":"dolore consequat","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":"non Ut nostrud proid","name":"eiusmod consequat nostrud","summary":"qui ex ad Lorem","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"key":"sunt mollit","name":"officia incididunt eu","summary":"aliqua sunt irure culpa offic","source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"filtersPanelStack":{"key":"conseq"}}]}