Create document link (alpha)

POST 
/documents/:documentId/links

Create a link to a document in 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 link.

Query Parameters

storeId string

The ID of the document store to link 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.

application/json

Body

timeToLive int64

Default value: 3600000

The time-to-live of the document link in ms.

Responses

201

The document link was created successfully.

application/json

Schema

Schema

url string

The link to the document.

expiresAt date-time

The date and time when the link expires.

Example (from schema)

{
  "url": "string",
  "expiresAt": "2025-01-09T15:07:17.572Z"
}

400

The document link creation 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...