Get the definition 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.

Request Params

KeyDatatypeRequiredDescription
fieldsstringComma 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

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token
X-MSTR-ProjectIDstring(Required) Project ID