Get process definition by key (alpha)

GET 
/process-definitions/:processDefinitionKey

Returns process definition as JSON.

note

This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. See the Camunda 8 REST API overview for further details.

Request

Path Parameters

processDefinitionKey int64required

The assigned key of the process definition, which acts as a unique identifier for this process definition.

Responses

200

The process definition is successfully returned.

application/json

Schema

Schema

processDefinitionKey int64

The key for this process definition.

name string

Name of this process definition.

resourceName string

Resource name for this process definition.

version int32

Version of this process definition.

versionTag string

Version tag of this process definition.

processDefinitionId string

Process definition id of this process definition.

tenantId string

Tenant id of this process definition.

Example (from schema)

{
  "processDefinitionKey": 0,
  "name": "string",
  "resourceName": "string",
  "version": 0,
  "versionTag": "string",
  "processDefinitionId": "string",
  "tenantId": "string"
}

400

The process definition request 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"
}

404

The process definition with the given key was not found. 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"
}

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