Query flow node instances (alpha)

POST 
/flownode-instances/search

Search for flow node 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

flowNodeInstanceKey int64

The assigned key, which acts as a unique identifier for this flow node instance.

processInstanceKey int64

The process instance key associated to this flow node instance.

processDefinitionKey int64

The process definition key associated to this flow node instance.

processDefinitionId string

The process definition ID associated to this flow node instance.

state string

Possible values: [ACTIVE, COMPLETED, TERMINATED]

State of flow node instance as defined set of values.

type string

Possible values: [UNSPECIFIED, PROCESS, SUB_PROCESS, EVENT_SUB_PROCESS, START_EVENT, INTERMEDIATE_CATCH_EVENT, INTERMEDIATE_THROW_EVENT, BOUNDARY_EVENT, END_EVENT, SERVICE_TASK, RECEIVE_TASK, USER_TASK, MANUAL_TASK, TASK, EXCLUSIVE_GATEWAY, INCLUSIVE_GATEWAY, PARALLEL_GATEWAY, EVENT_BASED_GATEWAY, SEQUENCE_FLOW, MULTI_INSTANCE_BODY, CALL_ACTIVITY, BUSINESS_RULE_TASK, SCRIPT_TASK, SEND_TASK, UNKNOWN]

Type of flow node as defined set of values.

flowNodeId string

The flow node ID for this flow node instance.

flowNodeName string

The flow node name.

treePath string

The path of keys from process instance to this flow node instance separated by '/'.

hasIncident boolean

Shows whether this flow node instance has an incident related to.

incidentKey int64

The key of incident if field incident is true.

tenantId string

The tenant ID.

Responses

200

The flow node instance search result.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
flowNodeInstanceKey int64
The assigned key, which acts as a unique identifier for this flow node instance.
processInstanceKey int64
The process instance key associated to this flow node instance.
processDefinitionKey int64
The process definition key associated to this flow node instance.
processDefinitionId string
The process definition ID associated to this flow node instance.
startDate date-time
Date when flow node instance started.
endDate date-time
Date when flow node instance finished.
flowNodeId string
The flow node ID for this flow node instance.
treePath string
The path from process instance leading to this flow node instance.
type string
Possible values: [UNSPECIFIED, PROCESS, SUB_PROCESS, EVENT_SUB_PROCESS, START_EVENT, INTERMEDIATE_CATCH_EVENT, INTERMEDIATE_THROW_EVENT, BOUNDARY_EVENT, END_EVENT, SERVICE_TASK, RECEIVE_TASK, USER_TASK, MANUAL_TASK, TASK, EXCLUSIVE_GATEWAY, INCLUSIVE_GATEWAY, PARALLEL_GATEWAY, EVENT_BASED_GATEWAY, SEQUENCE_FLOW, MULTI_INSTANCE_BODY, CALL_ACTIVITY, BUSINESS_RULE_TASK, SCRIPT_TASK, SEND_TASK, UNKNOWN]
Type of flow node as defined set of values.
state string
Possible values: [ACTIVE, COMPLETED, TERMINATED]
State of flow node instance as defined set of values.
hasIncident boolean
Shows whether this flow node instance has an incident. If true also an incidentKey is provided.
incidentKey int64
Incident key associated with this flow node instance.
tenantId string
The tenant ID of the incident.
]

Example (from schema)

{
  "items": [
    {
      "flowNodeInstanceKey": 0,
      "processInstanceKey": 0,
      "processDefinitionKey": 0,
      "processDefinitionId": "string",
      "startDate": "2024-11-07T21:11:50.838Z",
      "endDate": "2024-11-07T21:11:50.838Z",
      "flowNodeId": "string",
      "treePath": "string",
      "type": "UNSPECIFIED",
      "state": "ACTIVE",
      "hasIncident": true,
      "incidentKey": 0,
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The Flow node 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...