@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias CreateDocumentLinkData

    type CreateDocumentLinkData = {
        body?: DocumentLinkRequest;
        path: { documentId: DocumentId };
        query: { contentHash: string; storeId?: string };
        url: "/documents/{documentId}/links";
    }
    Index

    Properties

    body? path query url

    Properties

    Optionalbody

    body?: DocumentLinkRequest
    path: { documentId: DocumentId }

    Type Declaration

    • documentId: DocumentId

      The ID of the document to link.

    query: { contentHash: string; storeId?: string }

    Type Declaration

    • 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.

    • OptionalstoreId?: string

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

    url: "/documents/{documentId}/links"

    Settings

    Member Visibility

    On This Page

    Properties