Retrieve a published shortcut for a document
GET {{baseUrl}}/api/documents/:id/instances/:instanceId/shortcut
Retrieve a published shortcut from a specific document instance. Whenever a document is published, a shortcut is created in the target user’s library to that document instance (base object). 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 document and the document instance by specifying the document ID and the document instance ID in the path of the request; you get the document instance ID using POST /documents/{id}/instances. The response includes information about the shortcut (name, ID and whether the current user owns the shortcut), as well as the document (base object) it targets.
Body
PARAM
| Key | Datatype | Required | Description |
includeTOC
|
boolean | Whether Dossier TOC (Table of Content) information with chapters & Pages should be included | |
includePrompted
|
boolean | Whether prompted property should be included | |
includeCurrentBookmark
|
boolean | Whether Dossier Current Bookmark information should be included | |
includeDossierHashes
|
boolean | Whether the Dossier version hashes should be included. | |
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 |