Query flow node instances (alpha)
POSThttp://localhost:8080/v2/flownode-instances/search
Search for flow node instances based on given criteria.
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[]
page object
filter object
Responses​
- 200
- 400
- 500
The Flow node instance search successful response.
- application/json
- Schema
- Example (from schema)
Schema
page object
items object[]
{
"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": [
{}
]
}
}
The Flow node instance Search Query failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
- curl
- java
- nodejs
- csharp
- python
- go
- CURL
curl -L -X POST 'http://localhost:8080/v2/flownode-instances/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"filter": {
"flowNodeInstanceKey": 0,
"processInstanceKey": 0,
"processDefinitionKey": 0,
"state": "string",
"type": "string",
"flowNodeId": "string",
"flowNodeName": "string",
"treePath": "string",
"incident": true,
"incidentKey": 0,
"tenantId": "string"
},
"sort": [
{
"field": "string",
"order": "asc"
}
],
"page": {
"from": 0,
"limit": 0,
"searchAfter": [
{}
],
"searchBefore": [
{}
]
}
}'