Get process definition (alpha)
GET/process-definitions/:processDefinitionKey
Returns process definition as JSON.
Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.
This endpoint is an alpha feature and may be subject to change in future releases.
Request
Path Parameters
The assigned key of the process definition, which acts as a unique identifier for this process definition.
Responses
- 200
- 400
- 404
- 500
The process definition is successfully returned.
- application/json
- Schema
- Example (from schema)
Schema
The key for this process definition.
Name of this process definition.
Resource name for this process definition.
Version of this process definition.
Version tag of this process definition.
Process definition ID of this process definition.
Tenant ID of this process definition.
{
"processDefinitionKey": 0,
"name": "string",
"resourceName": "string",
"version": 0,
"versionTag": "string",
"processDefinitionId": "string",
"tenantId": "string"
}
The process definition request 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"
}
The process definition with the given key was not found. 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"
}
An internal error occurred while processing the request.
- 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"
}