Sign in
Historic Incident

Get Incidents

Queries for historic incidents that fulfill given parameters. The size of the result set can be retrieved by using the Get Incident Count method.

get/history/incident

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/incident
  • Auth: HTTP basic

Query parameters

incidentIdstring

Restricts to incidents that have the given id.

incidentTypestring

Restricts to incidents that belong to the given incident type. See the User Guide for a list of incident types.

incidentMessagestring

Restricts to incidents that have the given incident message.

incidentMessageLikestring

Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

processDefinitionIdstring

Restricts to incidents that belong to a process definition with the given id.

processDefinitionKeystring

Restricts to incidents that have the given processDefinitionKey.

processDefinitionKeyInstring

Restricts to incidents that have one of the given process definition keys.

processInstanceIdstring

Restricts to incidents that belong to a process instance with the given id.

executionIdstring

Restricts to incidents that belong to an execution with the given id.

createTimeBeforestring date-time

Restricts to incidents that have a createTime date before the given date. 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.

createTimeAfterstring date-time

Restricts to incidents that have a createTime date after the given date. 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.

endTimeBeforestring date-time

Restricts to incidents that have an endTimeBefore date before the given date. 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.

endTimeAfterstring date-time

Restricts to incidents that have an endTimeAfter date after the given date. 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.

activityIdstring

Restricts to incidents that belong to an activity with the given id.

failedActivityIdstring

Restricts to incidents that were created due to the failure of an activity with the given id.

causeIncidentIdstring

Restricts to incidents that have the given incident id as cause incident.

rootCauseIncidentIdstring

Restricts to incidents that have the given incident id as root cause incident.

configurationstring

Restricts to incidents that have the given parameter set as configuration.

historyConfigurationstring

Restricts to incidents that have the given parameter set as history configuration.

openboolean

Restricts to incidents that are open.

resolvedboolean

Restricts to incidents that are resolved.

deletedboolean

Restricts to incidents that are deleted.

tenantIdInstring

Restricts to incidents that have one of the given comma-separated tenant ids.

withoutTenantIdboolean

Only include historic incidents that belong to no tenant. Value may only be true, as false is the default behavior.

jobDefinitionIdInstring

Restricts to incidents that have one of the given comma-separated job definition ids.

sortBy'incidentId' | 'incidentMessage' | 'createTime' | 'endTime' | 'incidentType' | 'executionId' | 'activityId' | 'processInstanceId' | 'processDefinitionId' | 'processDefinitionKey' | 'causeIncidentId' | 'rootCauseIncidentId' | 'configuration' | 'historyConfiguration' | 'tenantId' | 'incidentState'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

idstring nullable

The id of the incident.

processDefinitionKeystring nullable

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

processDefinitionIdstring nullable

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

processInstanceIdstring nullable

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

executionIdstring nullable

The id of the execution this incident is associated with.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the process containing this incident.

createTimestring date-time nullable

The time this incident happened. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

endTimestring date-time nullable

The time this incident has been deleted or resolved. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

removalTimestring date-time nullable

The time after which the incident should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

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](/manual/develop/user- guide/process-engine/incidents/#incident-types) 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.

historyConfigurationstring nullable

The payload of this incident at the time when it occurred.

incidentMessagestring nullable

The message of this incident.

tenantIdstring nullable

The id of the tenant this incident is associated with.

jobDefinitionIdstring nullable

The job definition id the incident is associated with.

openboolean nullable

If true, this incident is open.

deletedboolean nullable

If true, this incident has been deleted.

resolvedboolean nullable

If true, this incident has been resolved.

annotationstring nullable

The annotation set to the incident.

Changes

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