Skip to main content
Version: Next

Query incidents (alpha)

POST 
/incidents/search

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

Body

    sort object[]
  • Array [
    • field stringrequired
    order string

    Default value: asc

  • ]
    • page object
    from int32
    limit int32
    searchAfter object[]
    searchBefore object[]
    filter object
    key int64
    processDefinitionKey int64
    processInstanceKey int64
    type string
    message string
    flowNodeId string
    flowNodeInstanceId string
    state string
    jobKey int64
    tenantId string
    hasActiveOperation boolean

Responses​

The incident search successful response.

Schema
    page object
    totalItems int64
    firstSortValues object[]
    lastSortValues object[]
    items object[]
  • Array [
    • key int64
    processDefinitionKey int64
    processInstanceKey int64
    type string
    message string
    flowNodeId string
    flowNodeInstanceId string
    creationTime string
    state string
    jobKey int64
    tenantId string
    hasActiveOperation boolean
    lastOperation object

    Operation

    id string
    batchOperationId string
    type string

    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]

    state string

    Possible values: [SCHEDULED, LOCKED, SENT, FAILED, COMPLETED]

    errorMessage string
    completedDate date-time
    rootCauseInstance object

    Process instance reference description

    instanceId string
    processDefinitionId string
    processDefinitionName string
    rootCauseDecision object

    Decision instance reference description

    instanceId string
    decisionName string
  • ]
Loading...