Skip to main content
GET
/
history
/
incident
/
count
Get Incident Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/incident/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 2
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

incidentId
string

Restricts to incidents that have the given id.

incidentType
string

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

incidentMessage
string

Restricts to incidents that have the given incident message.

incidentMessageLike
string

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

processDefinitionId
string

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

processDefinitionKey
string

Restricts to incidents that have the given processDefinitionKey.

processDefinitionKeyIn
string

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

processInstanceId
string

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

executionId
string

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

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

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

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

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

activityId
string

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

failedActivityId
string

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

causeIncidentId
string

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

rootCauseIncidentId
string

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

configuration
string

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

historyConfiguration
string

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

open
boolean

Restricts to incidents that are open.

resolved
boolean

Restricts to incidents that are resolved.

deleted
boolean

Restricts to incidents that are deleted.

tenantIdIn
string

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

withoutTenantId
boolean

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

jobDefinitionIdIn
string

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

Response

Request successful.

count
integer

The number of matching instances.