Query flow node instances

POST 
/flownode-instances/search

Search for flow node instances based on given criteria.

Request

application/json

Body

sort object[]
Sort field criteria.
Array [
field stringrequired
The field to sort by.
order SortOrderEnum
Possible values: [ASC, DESC]
Default value: ASC
The order in which to sort the related field.
]
page object

Pagination criteria.

from int32

The index of items to start searching from.

limit int32

The maximum number of items to return in one request.

searchAfter object[]

Items to search after. Correlates to the lastSortValues property of a previous search response.

searchBefore object[]

Items to search before. Correlates to the firstSortValues property of a previous search response.

filter object

Flow node instance filter.

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.

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

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching flow node instances.
Array [
flowNodeInstanceKey string
The assigned key, which acts as a unique identifier for this flow node instance.
processInstanceKey string
The process instance key associated to this flow node instance.
processDefinitionKey string
The process definition key associated to this flow node instance.
incidentKey string
Incident key associated with this flow node instance.
]

Example (from schema)

{
  "items": [
    {
      "flowNodeInstanceKey": "string",
      "processInstanceKey": "string",
      "processDefinitionKey": "string",
      "incidentKey": "string",
      "processDefinitionId": "string",
      "startDate": "2024-12-19T15:07:40.133Z",
      "endDate": "2024-12-19T15:07:40.133Z",
      "flowNodeId": "string",
      "flowNodeName": "string",
      "type": "UNSPECIFIED",
      "state": "ACTIVE",
      "hasIncident": true,
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

page object

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching flow node instances.
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.
incidentKey int64
Incident key associated with this flow node instance.
]

Example (from schema)

{
  "items": [
    {
      "flowNodeInstanceKey": 0,
      "processInstanceKey": 0,
      "processDefinitionKey": 0,
      "incidentKey": 0,
      "processDefinitionId": "string",
      "startDate": "2024-12-19T15:07:40.134Z",
      "endDate": "2024-12-19T15:07:40.134Z",
      "flowNodeId": "string",
      "flowNodeName": "string",
      "type": "UNSPECIFIED",
      "state": "ACTIVE",
      "hasIncident": true,
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

page object

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching flow node instances.
Array [
flowNodeInstanceKey string
The assigned key, which acts as a unique identifier for this flow node instance.
processInstanceKey string
The process instance key associated to this flow node instance.
processDefinitionKey string
The process definition key associated to this flow node instance.
incidentKey string
Incident key associated with this flow node instance.
]

Example (from schema)

{
  "items": [
    {
      "flowNodeInstanceKey": "string",
      "processInstanceKey": "string",
      "processDefinitionKey": "string",
      "incidentKey": "string",
      "processDefinitionId": "string",
      "startDate": "2024-12-19T15:07:40.135Z",
      "endDate": "2024-12-19T15:07:40.135Z",
      "flowNodeId": "string",
      "flowNodeName": "string",
      "type": "UNSPECIFIED",
      "state": "ACTIVE",
      "hasIncident": true,
      "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"
}

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

403

Forbidden. The request is not allowed.

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