Skip to main content
Version: 8.6

Get incident by key (alpha)

GET 
/incidents/:incidentKey

Returns incident as JSON.

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​

Path Parameters

    incidentKey int64required

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

Responses​

The incident is successfully returned.

Schema
    key 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 bpmn process 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.

    treePath string

    The path from process instance via flow node ids and flow node instance keys leading to this incident.

    tenantId string

    The tenant id of the incident.

Loading...