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

    Type Alias CreateDocumentData

    type CreateDocumentData = {
        body: { file: Blob | File; metadata?: DocumentMetadata };
        path?: never;
        query?: { documentId?: string; storeId?: string };
        url: "/documents";
    }
    Index

    Properties

    body path? query? url

    Properties

    body

    body: { file: Blob | File; metadata?: DocumentMetadata }
    path?: never
    query?: { documentId?: string; storeId?: string }

    Type Declaration

    • OptionaldocumentId?: string

      The ID of the document to upload. If not provided, a new ID will be generated. Specifying an existing ID will result in an error if the document already exists.

    • OptionalstoreId?: string

      The ID of the document store to upload the documents to. Currently, only a single document store is supported per cluster. However, this attribute is included to allow for potential future support of multiple document stores.

    url: "/documents"

    Settings

    Member Visibility

    On This Page

    Properties