Query incidents

POST 
/incidents/search

Search for incidents 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

Incident search filter.

incidentKey int64

The assigned key, which acts as a unique identifier for this incident.

processDefinitionKey int64

The process definition key associated to this incident.

processDefinitionId string

The process definition ID associated to this incident.

processInstanceKey int64

The process instance key associated to this incident.

errorType string

Possible values: [UNSPECIFIED, UNKNOWN, IO_MAPPING_ERROR, JOB_NO_RETRIES, CONDITION_ERROR, EXTRACT_VALUE_ERROR, CALLED_ELEMENT_ERROR, UNHANDLED_ERROR_EVENT, MESSAGE_SIZE_EXCEEDED, CALLED_DECISION_ERROR, DECISION_EVALUATION_ERROR, FORM_NOT_FOUND]

Incident error type with a defined set of values.

errorMessage string

Error message which describes the error in more detail.

flowNodeId string

The flow node ID associated to this incident.

flowNodeInstanceKey int64

The flow node instance key associated to this incident.

creationTime date-time

Date of incident creation.

state string

Possible values: [ACTIVE, MIGRATED, RESOLVED, PENDING]

State of this incident with a defined set of values.

jobKey int64

The job key, if exists, associated with this incident.

tenantId string

The tenant ID of the incident.

Responses

200

The incident 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 incidents.
Array [
incidentKey string
The assigned key, which acts as a unique identifier for this incident.
processDefinitionKey string
The process definition key associated to this incident.
processInstanceKey string
The process instance key associated to this incident.
flowNodeInstanceKey string
The flow node instance key associated to this incident.
jobKey string
The job key, if exists, associated with this incident.
]

Example (from schema)

{
  "items": [
    {
      "incidentKey": "string",
      "processDefinitionKey": "string",
      "processInstanceKey": "string",
      "flowNodeInstanceKey": "string",
      "jobKey": "string",
      "processDefinitionId": "string",
      "errorType": "UNSPECIFIED",
      "errorMessage": "string",
      "flowNodeId": "string",
      "creationTime": "2024-12-19T15:07:40.230Z",
      "state": "ACTIVE",
      "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 incidents.
Array [
incidentKey int64
The assigned key, which acts as a unique identifier for this incident.
processDefinitionKey int64
The process definition key associated to this incident.
processInstanceKey int64
The process instance key associated to this incident.
flowNodeInstanceKey int64
The flow node instance key associated to this incident.
jobKey int64
The job key, if exists, associated with this incident.
]

Example (from schema)

{
  "items": [
    {
      "incidentKey": 0,
      "processDefinitionKey": 0,
      "processInstanceKey": 0,
      "flowNodeInstanceKey": 0,
      "jobKey": 0,
      "processDefinitionId": "string",
      "errorType": "UNSPECIFIED",
      "errorMessage": "string",
      "flowNodeId": "string",
      "creationTime": "2024-12-19T15:07:40.231Z",
      "state": "ACTIVE",
      "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 incidents.
Array [
incidentKey string
The assigned key, which acts as a unique identifier for this incident.
processDefinitionKey string
The process definition key associated to this incident.
processInstanceKey string
The process instance key associated to this incident.
flowNodeInstanceKey string
The flow node instance key associated to this incident.
jobKey string
The job key, if exists, associated with this incident.
]

Example (from schema)

{
  "items": [
    {
      "incidentKey": "string",
      "processDefinitionKey": "string",
      "processInstanceKey": "string",
      "flowNodeInstanceKey": "string",
      "jobKey": "string",
      "processDefinitionId": "string",
      "errorType": "UNSPECIFIED",
      "errorMessage": "string",
      "flowNodeId": "string",
      "creationTime": "2024-12-19T15:07:40.232Z",
      "state": "ACTIVE",
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The incident search query failed. More details are provided in the response body.

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