Download document (alpha)

GET 
/documents/:documentId

Download a document from 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

Path Parameters

documentId stringrequired

The ID of the document to download.

Query Parameters

storeId string

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

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. This header is required when hash verification is enabled for the document store. If hash verification is enabled and the client fails to provide the correct hash, the request will be rejected.

Responses

200

The document was downloaded successfully.

application/octet-stream

Schema

Schema

string

404

The document with the given ID was not found.

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"
}

500

An internal error occurred while processing the request.

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