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.
This endpoint is an alpha feature and may be subject to change in future releases.
Request
Query Parameters
The ID of the document store to upload the document to.
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
metadata object
The content type of the document.
The name of the file.
The date and time when the document expires.
The size of the document in bytes.
customProperties object
Custom properties of the document.
Additional properties allowed.
Responses
- 201
- 400
The document was uploaded successfully.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [camunda]
Document discriminator. Always set to "camunda".
The ID of the document store.
The ID of the document.
metadata object
The content type of the document.
The name of the file.
The date and time when the document expires.
The size of the document in bytes.
customProperties object
Custom properties of the document.
Additional properties allowed.
{
"camunda.document.type": "camunda",
"storeId": "string",
"documentId": "string",
"metadata": {
"contentType": "string",
"fileName": "string",
"expiresAt": "2024-11-07T21:11:50.863Z",
"size": 0,
"customProperties": {}
}
}
The document upload failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}