Get the hierarchy of a dossier from the instance
GET {{baseUrl}}/api/v2/dossiers/:dossierId/instances/:instanceId/definition
Get the hierarchy of a specific dossier in a specific project from instance. This API is specifically work to get dossier definition for the prompts which has no default answers.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 can get the dossier instance id through API POST /dossiers/{id}/instances.
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 OK
| {
"id": "CF13BCDA409911243371CA980BAAE749",
"name": "Retail Sales Report",
"currentChapter": "K36",
"chapters": [
{
"key": "K36",
"name": "Yearly Sales Report",
"pages": [
{
"key": "W62",
"name": "Performance Tracking",
"visualizations": [
{
"key": "W63",
"name": "KPI: Profit by Category",
"visualizationType": "kpi"
},
{
"key": "W75",
"name": "KPI: Profit by City",
"visualizationType": "kpi"
}
]
},
{
"key": "W92",
"name": "Category Sales",
"visualizations": [
Curl curl -X GET 'baseUrl/api/v2/dossiers/:dossierId/instances/:instanceId/definition?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |