Create an instance of a document
POST {{baseUrl}}/api/documents/:documentId/instances
Execute a specific dossier and create an instance of the dossier. A dossier and a document have the same base object; a dossier is simply a different view of the document. The request returns the message ID of the dossier instance that was created. 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. The body parameter in the request contains linking and bookmark information for the dossier.You can apply filter criteria in the request body.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | 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 | |
Prefer | string | Prefer--allow client to set preferences. Currently, respond-async allows client to execute in async mode | |
Content-Type | string |