Skip to main content
GET
/
process-definition
/
key
/
{key}
Get
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition/key/{key} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "invoice:1:c3a63aaa-2046-11e7-8f94-34f39ab71d4e",
  "key": "invoice",
  "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
  "description": null,
  "name": "Invoice Receipt",
  "version": 1,
  "resource": "invoice.v1.bpmn",
  "deploymentId": "c398cd26-2046-11e7-8f94-34f39ab71d4e",
  "diagram": null,
  "suspended": false,
  "tenantId": null,
  "versionTag": null,
  "historyTimeToLive": 5,
  "startableInTasklist": true
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

key
string
required

The key of the process definition (the latest version thereof) to be retrieved.

Response

Request successful.

id
string | null

The id of the process definition

key
string | null

The key of the process definition, i.e., the id of the BPMN 2.0 XML process definition.

category
string | null

The category of the process definition.

description
string | null

The description of the process definition.

name
string | null

The name of the process definition.

version
integer | null

The version of the process definition that the engine assigned to it.

resource
string | null

The file name of the process definition.

deploymentId
string | null

The deployment id of the process definition.

diagram
string | null

The file name of the process definition diagram, if it exists.

suspended
boolean | null

A flag indicating whether the definition is suspended or not.

tenantId
string | null

The tenant id of the process definition.

versionTag
string | null

The version tag of the process definition.

historyTimeToLive
integer | null

History time to live value of the process definition. Is used within History cleanup.

Required range: x >= 0
startableInTasklist
boolean | null

A flag indicating whether the process definition is startable in Tasklist or not.