Query process instances (alpha)

POST 
/process-instances/search

Search for process instances based on given criteria.

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

application/json

Body

sort object[]
Array [
field stringrequired
order string
Default value: asc
]
page object
from int32
limit int32
searchAfter object[]
searchBefore object[]
filter object

Process instance search filter.

processInstanceKey object

The key of this process instance.

oneOf

MOD1

integer

AdvancedLongFilter

$eq int64

Checks for equality with the provided value.

$neq int64

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$in int64[]

Checks if the property matches any of the provided values.

$gt int64

Greater than comparison with the provided value.

$gte int64

Greater than or equal comparison with the provided value.

$lt int64

Lower than comparison with the provided value.

$lte int64

Lower than or equal comparison with the provided value.

processDefinitionId string

The process definition ID.

processDefinitionName string

The process definition name.

processDefinitionVersion object

The process definition version.

oneOf

MOD1

integer

AdvancedIntegerFilter

$eq int32

Checks for equality with the provided value.

$neq int32

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$gt int32

Greater than comparison with the provided value.

$gte int32

Greater than or equal comparison with the provided value.

$lt int32

Lower than comparison with the provided value.

$lte int32

Lower than or equal comparison with the provided value.

$in int32[]

Checks if the property matches any of the provided values.

processDefinitionVersionTag string

The process definition version tag.

processDefinitionKey object

The process definition key.

oneOf

MOD1

integer

AdvancedLongFilter

$eq int64

Checks for equality with the provided value.

$neq int64

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$in int64[]

Checks if the property matches any of the provided values.

$gt int64

Greater than comparison with the provided value.

$gte int64

Greater than or equal comparison with the provided value.

$lt int64

Lower than comparison with the provided value.

$lte int64

Lower than or equal comparison with the provided value.

parentProcessInstanceKey object

The parent process instance key.

oneOf

MOD1

integer

AdvancedLongFilter

$eq int64

Checks for equality with the provided value.

$neq int64

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$in int64[]

Checks if the property matches any of the provided values.

$gt int64

Greater than comparison with the provided value.

$gte int64

Greater than or equal comparison with the provided value.

$lt int64

Lower than comparison with the provided value.

$lte int64

Lower than or equal comparison with the provided value.

parentFlowNodeInstanceKey object

The parent flow node instance key.

oneOf

MOD1

integer

AdvancedLongFilter

$eq int64

Checks for equality with the provided value.

$neq int64

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$in int64[]

Checks if the property matches any of the provided values.

$gt int64

Greater than comparison with the provided value.

$gte int64

Greater than or equal comparison with the provided value.

$lt int64

Lower than comparison with the provided value.

$lte int64

Lower than or equal comparison with the provided value.

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.

Responses

200

The process instance search result.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
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)

{
  "items": [
    {
      "processInstanceKey": 0,
      "processDefinitionId": "string",
      "processDefinitionName": "string",
      "processDefinitionVersion": 0,
      "processDefinitionVersionTag": "string",
      "processDefinitionKey": 0,
      "parentProcessInstanceKey": 0,
      "parentFlowNodeInstanceKey": 0,
      "treePath": "string",
      "startDate": "2024-11-14T15:06:47.115Z",
      "endDate": "2024-11-14T15:06:47.115Z",
      "hasIncident": true,
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The process instance search query 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"
}

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