Skip to main content
Version: Next

Upload document (alpha)

POST 

/documents

Upload a document to the Camunda 8 cluster.

Note that this currently only supports an in-memory document store, which is not meant for production use.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

Query Parameters

    storeId string

    The ID of the document store to upload the document to.

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

Body

required
    file binaryrequired
    metadata object
    contentType string

    The content type of the document.

    fileName string

    The name of the file.

    expiresAt date-time

    The date and time when the document expires.

    size int64

    The size of the document in bytes.

    customProperties object

    Custom properties of the document.

    property name* any

    Additional properties allowed.

Responses

The document was uploaded successfully.

Schema
    camunda.document.type string

    Possible values: [camunda]

    Document discriminator. Always set to "camunda".

    storeId string

    The ID of the document store.

    documentId string

    The ID of the document.

    metadata object
    contentType string

    The content type of the document.

    fileName string

    The name of the file.

    expiresAt date-time

    The date and time when the document expires.

    size int64

    The size of the document in bytes.

    customProperties object

    Custom properties of the document.

    property name* any

    Additional properties allowed.

Loading...