Interface: IDocumentManagementGetRequest

Request to get a document from an auditable item graph vertex.

Properties

headers?

optional headers: object

The headers which can be used to determine the response data type.

accept

accept: "application/json" | "application/ld+json"

---

pathParams

pathParams: object

The path parameters.

auditableItemGraphDocumentId

auditableItemGraphDocumentId: string

The full id of the document to get.

---

query?

optional query: object

The query parameters.

includeBlobStorageMetadata?

optional includeBlobStorageMetadata: string | boolean

Include the blob storage metadata in the response.

Default

false

includeBlobStorageData?

optional includeBlobStorageData: string | boolean

Include the blob storage data in the response.

Default

false

includeAttestation?

optional includeAttestation: string | boolean

Include the attestation information in the response.

Default

false

includeRemoved?

optional includeRemoved: string | boolean

Include deleted documents in the response.

Default

false

extractRuleGroupId?

optional extractRuleGroupId: string

If provided will extract data from the document using the specified rule group id.

extractMimeType?

optional extractMimeType: string

By default extraction will auto detect the mime type of the document, this can be used to override the detection.

pageSize?

optional pageSize: string | number

Page size of items to return, defaults to 1 so only most recent is returned.

Default

1

cursor?

optional cursor: string

The cursor to get the next chunk of revisions.