Retrieves an incident by ID

Method

GET /incident/{id}

Parameters

Path Parameters

Name Description
id The id of the incident to be retrieved.

Result

A JSON object that represents an incident object with the following properties:

Name Value Description
id String The id of the incident.
processDefinitionId String The id of the process definition this incident is associated with.
processInstanceId String The id of the process instance this incident is associated with.
executionId String The id of the execution this incident is associated with.
incidentTimestamp String The time this incident happened. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
incidentType String The type of incident, for example: failedJobs will be returned in case of an incident which identified a failed job during the execution of a process instance. See the User Guide for a list of incident types.
activityId String The id of the activity this incident is associated with.
failedActivityId String The id of the activity on which the last exception occurred.
causeIncidentId String The id of the associated cause incident which has been triggered.
rootCauseIncidentId String The id of the associated root cause incident which has been triggered.
configuration String The payload of this incident.
tenantId String The id of the tenant this incident is associated with.
incidentMessage String The message of this incident.
jobDefinitionId String The job definition id the incident is associated with.
annotation String The annotation set to the incident.

* For further information, please see the documentation.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json Returned if an incident with given id does not exist.

Example

Request

GET /incident/anIncidentId

Response

  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anExecutionId",
    "incidentTimestamp": "2014-03-01T08:00:00.000+0200",
    "incidentType": "failedJob",
    "activityId": "serviceTask",
    "failedActivityId": "serviceTask",
    "causeIncidentId": "aCauseIncidentId",
    "rootCauseIncidentId": "aRootCauseIncidentId",
    "configuration": "aConfiguration",
    "tenantId": null,
    "incidentMessage": "anIncidentMessage",
    "jobDefinitionId": "aJobDefinitionId",
    "annotation": "an annotation"
  }

On this Page: