Query process instances (alpha)

POST 
/process-instances/search

Search for process instances based on given criteria.

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

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
running boolean
active boolean
incidents boolean
finished boolean
completed boolean
canceled boolean
retriesLeft boolean
errorMessage string
activityId string
startDate date-time
endDate date-time
bpmnProcessId string
The bpmn process ID.
processDefinitionVersion int32
variable object
name string
values string[]
batchOperationId string
parentProcessInstanceKey int64
tenantId string

Responses

200

The Process Instance Search successful response.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
key int64
processDefinitionName string
The process name.
processDefinitionVersion int32
bpmnProcessId string
parentKey int64
parentFlowNodeInstanceKey int64
startDate date-time
endDate date-time
state string
Possible values: [ACTIVE, INCIDENT, COMPLETED, CANCELED, UNKNOWN, UNSPECIFIED]
incident boolean
hasActiveOperation boolean
processDefinitionKey int64
tenantId string
rootInstanceId string
operations object[]
Array [
id string
batchOperationId string
type string
Possible values: [RESOLVE_INCIDENT, CANCEL_PROCESS_INSTANCE, DELETE_PROCESS_INSTANCE, ADD_VARIABLE, UPDATE_VARIABLE, MODIFY_PROCESS_INSTANCE, DELETE_DECISION_DEFINITION, DELETE_PROCESS_DEFINITION, MIGRATE_PROCESS_INSTANCE]
state string
Possible values: [SCHEDULED, LOCKED, SENT, FAILED, COMPLETED]
errorMessage string
completedDate date-time
]
callHierarchy object[]
Array [
instanceId string
processDefinitionId string
processDefinitionName string
]
]

Example (from schema)

{
  "items": [
    {
      "key": 0,
      "processDefinitionName": "string",
      "processDefinitionVersion": 0,
      "bpmnProcessId": "string",
      "parentKey": 0,
      "parentFlowNodeInstanceKey": 0,
      "startDate": "2024-10-02T22:01:21.411Z",
      "endDate": "2024-10-02T22:01:21.411Z",
      "state": "ACTIVE",
      "incident": true,
      "hasActiveOperation": true,
      "processDefinitionKey": 0,
      "tenantId": "string",
      "rootInstanceId": "string",
      "operations": [
        {
          "id": "string",
          "batchOperationId": "string",
          "type": "RESOLVE_INCIDENT",
          "state": "SCHEDULED",
          "errorMessage": "string",
          "completedDate": "2024-10-02T22:01:21.411Z"
        }
      ],
      "callHierarchy": [
        {
          "instanceId": "string",
          "processDefinitionId": "string",
          "processDefinitionName": "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...