Skip to main content
Version: 8.9 (unreleased)

Type Alias: GetDocumentData

type GetDocumentData = object;

Defined in: gen/types.gen.ts:10145

Properties​

body?​

optional body: never;

Defined in: gen/types.gen.ts:10146

path​

path: object;

Defined in: gen/types.gen.ts:10147

documentId​

documentId: DocumentId;

The ID of the document to download.

query?​

optional query: object;

Defined in: gen/types.gen.ts:10153

contentHash?​

optional contentHash: string;

The hash of the document content that was computed by the document store during upload. The hash is part of the document reference that is returned when uploading a document. If the client fails to provide the correct hash, the request will be rejected.

storeId?​

optional storeId: string;

The ID of the document store to download the document from.

url​

url: "/documents/{documentId}";

Defined in: gen/types.gen.ts:10164