Type Alias DocumentMetadataResponse

Information about the document that is returned in responses.

type DocumentMetadataResponse = {
    contentType: string;
    customProperties: { [key: string]: unknown };
    expiresAt: string | null;
    fileName: string;
    processDefinitionId: ProcessDefinitionId | null;
    processInstanceKey: ProcessInstanceKey | null;
    size: number;
}

Properties

contentType: string

The content type of the document.

customProperties: { [key: string]: unknown }

Custom properties of the document.

expiresAt: string | null

The date and time when the document expires.

fileName: string

The name of the file.

processDefinitionId: ProcessDefinitionId | null

The ID of the process definition that created the document.

processInstanceKey: ProcessInstanceKey | null

The key of the process instance that created the document.

size: number

The size of the document in bytes.