Execution

Create Incident

Creates a custom incident with given properties.

post/execution/{id}/create-incident

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/execution/{id}/create-incident
  • Auth: HTTP basic

Path parameters

idstring required

The id of the execution to create a new incident for.

Request body

incidentTypestring nullable

A type of the new incident.

configurationstring nullable

A configuration for the new incident.

messagestring nullable

A message for the new incident.

Response

Request successful.

idstring nullable

The id of the incident.

processDefinitionIdstring nullable

The id of the process definition this incident is associated with.

processInstanceIdstring nullable

The id of the process instance this incident is associated with.

executionIdstring nullable

The id of the execution this incident is associated with.

incidentTimestampstring date-time nullable

The time this incident happened. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

incidentTypestring nullable

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.

activityIdstring nullable

The id of the activity this incident is associated with.

failedActivityIdstring nullable

The id of the activity on which the last exception occurred.

causeIncidentIdstring nullable

The id of the associated cause incident which has been triggered.

rootCauseIncidentIdstring nullable

The id of the associated root cause incident which has been triggered.

configurationstring nullable

The payload of this incident.

tenantIdstring nullable

The id of the tenant this incident is associated with.

incidentMessagestring nullable

The message of this incident.

jobDefinitionIdstring nullable

The job definition id the incident is associated with.

annotationstring nullable

The annotation set to the incident.

Changes

No recorded changes to this operation across all 1 revision of this API.