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

200

The incident is successfully returned.

application/json

Schema

Schema

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.

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.

Example (from schema)

{
  "incidentKey": 0,
  "processDefinitionKey": 0,
  "processDefinitionId": "string",
  "processInstanceKey": 0,
  "errorType": "UNSPECIFIED",
  "errorMessage": "string",
  "flowNodeId": "string",
  "flowNodeInstanceKey": 0,
  "creationTime": "2024-10-10T15:06:34.511Z",
  "state": "ACTIVE",
  "jobKey": 0,
  "treePath": "string",
  "tenantId": "string"
}

400

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

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"
}

404

The incident with the given key was not found. More details are provided in the response body.

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