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.

multipart/form-data

Body

required

file binaryrequired
metadata object

Information about the document.

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

201

The document was uploaded successfully.

application/json

Schema

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

Information about the document.

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.

Example (from schema)

{
  "camunda.document.type": "camunda",
  "storeId": "string",
  "documentId": "string",
  "metadata": {
    "contentType": "string",
    "fileName": "string",
    "expiresAt": "2024-12-13T13:19:42.598Z",
    "size": 0,
    "customProperties": {}
  }
}

400

The document upload failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...