Query incidents (alpha)
POST/incidents/search
Search for incidents 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
- Array [
- ]
sort object[]
Default value: asc
page object
filter object
Responses
- 200
- 400
- 401
- 403
- 404
- 500
The incident search successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
page object
items object[]
lastOperation object
Operation
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
]
Possible values: [SCHEDULED
, LOCKED
, SENT
, FAILED
, COMPLETED
]
rootCauseInstance object
Process instance reference description
rootCauseDecision object
Decision instance reference description
{
"items": [
{
"key": 0,
"processDefinitionKey": 0,
"processInstanceKey": 0,
"type": "string",
"message": "string",
"flowNodeId": "string",
"flowNodeInstanceId": "string",
"creationTime": "string",
"state": "string",
"jobKey": 0,
"tenantId": "string",
"hasActiveOperation": true,
"lastOperation": {
"id": "string",
"batchOperationId": "string",
"type": "RESOLVE_INCIDENT",
"state": "SCHEDULED",
"errorMessage": "string",
"completedDate": "2024-09-17T08:17:07.159Z"
},
"rootCauseInstance": {
"instanceId": "string",
"processDefinitionId": "string",
"processDefinitionName": "string"
},
"rootCauseDecision": {
"instanceId": "string",
"decisionName": "string"
}
}
],
"page": {
"totalItems": 0,
"firstSortValues": [
{}
],
"lastSortValues": [
{}
]
}
}
The incident search query failed. More details are provided in the response body.
Unauthorized
- 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"
}
Forbidden
- 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"
}
Not found
- 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"
}
Internal server error
- 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"
}