Sign in
Incident

Get List Count

Queries for the number of incidents that fulfill given parameters. Takes the same parameters as the Get Incidents method.

get/incident/count

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/incident/count
  • 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.

processDefinitionKeyInstring

Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list.

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.

incidentTimestampBeforestring date-time

Restricts to incidents that have an incidentTimestamp 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.

incidentTimestampAfterstring date-time

Restricts to incidents that have an incidentTimestamp 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.

tenantIdInstring

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

jobDefinitionIdInstring

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

Response

Request successful.

countinteger

The number of matching instances.

Changes

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