Get process instance (alpha)

GET 
/process-instances/:processInstanceKey

Get the process instance by the process instance key.

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.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

Path Parameters

processInstanceKey int64required

The process instance key.

Responses

200

The process instance is successfully returned.

application/json

Schema

Schema

processInstanceKey int64

The key of this process instance.

processDefinitionId string

The process definition ID.

processDefinitionName string

The process definition name.

processDefinitionVersion int32

The process definition version.

processDefinitionVersionTag string

The process definition version tag.

processDefinitionKey int64

The process definition key.

parentProcessInstanceKey int64

The parent process instance key.

parentFlowNodeInstanceKey int64

The parent flow node instance key.

treePath string

The path of keys to this process instance, separated by '/'.

startDate date-time

The start date.

endDate date-time

The end date.

state ProcessInstanceStateEnum

Possible values: [ACTIVE, COMPLETED, CANCELED]

The state, one of ACTIVE, COMPLETED, CANCELED.

hasIncident boolean

Whether this process instance has a related incident or not.

tenantId string

The tenant ID.

Example (from schema)

{
  "processInstanceKey": 0,
  "processDefinitionId": "string",
  "processDefinitionName": "string",
  "processDefinitionVersion": 0,
  "processDefinitionVersionTag": "string",
  "processDefinitionKey": 0,
  "parentProcessInstanceKey": 0,
  "parentFlowNodeInstanceKey": 0,
  "treePath": "string",
  "startDate": "2024-11-14T15:06:47.109Z",
  "endDate": "2024-11-14T15:06:47.109Z",
  "hasIncident": true,
  "tenantId": "string"
}

400

The provided data is not valid.

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

401

The request lacks valid authentication credentials.

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 instance with the given key 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...