Query flow node instances (alpha)

POST 
/flownode-instances/search

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

flowNodeInstanceKey int64

The key of this flow node instance.

processInstanceKey int64

The process instance key.

processDefinitionKey int64

The process definition key.

state string

The state, one of ACTIVE, COMPLETED, TERMINATED.

type string

The flow node type

flowNodeId string

The flow node id

flowNodeName string

The flow node name

treePath string

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

incident 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 successful response.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
flowNodeInstanceKey int64
processInstanceKey int64
processDefinitionKey int64
startDate string
endDate string
flowNodeId string
flowNodeName string
treePath string
type string
state string
incident boolean
incidentKey int64
tenantId string
]

Example (from schema)

{
  "items": [
    {
      "flowNodeInstanceKey": 0,
      "processInstanceKey": 0,
      "processDefinitionKey": 0,
      "startDate": "string",
      "endDate": "string",
      "flowNodeId": "string",
      "flowNodeName": "string",
      "treePath": "string",
      "type": "string",
      "state": "string",
      "incident": 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...