获取列表

Get Incidents

curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/incident \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anExecutionId",
    "createTime": "2014-03-01T08:00:00.000+0200",
    "endTime": null,
    "incidentType": "failedJob",
    "activityId": "serviceTask",
    "failedActivityId": "serviceTask",
    "causeIncidentId": "aCauseIncidentId",
    "rootCauseIncidentId": "aRootCauseIncidentId",
    "configuration": "aConfiguration",
    "incidentMessage": "anIncidentMessage",
    "tenantId": null,
    "jobDefinitionId": "aJobDefinitionId",
    "open": true,
    "deleted": false,
    "resolved": false,
    "removalTime": null,
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "annotation": "an annotation"
  },
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anotherExecutionId",
    "createTime": "2014-03-01T08:00:00.000+0200",
    "endTime": "2014-03-10T12:00:00.000+0200",
    "incidentType": "customIncidentType",
    "activityId": "userTask",
    "failedActivityId": "userTask",
    "causeIncidentId": "anotherCauseIncidentId",
    "rootCauseIncidentId": "anotherRootCauseIncidentId",
    "configuration": "anotherConfiguration",
    "incidentMessage": "anotherIncidentMessage",
    "tenantId": null,
    "jobDefinitionId": null,
    "open": false,
    "deleted": false,
    "resolved": true,
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "annotation": "another annotation"
  }
]

GET

history

incident

Get Incidents

curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/incident \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anExecutionId",
    "createTime": "2014-03-01T08:00:00.000+0200",
    "endTime": null,
    "incidentType": "failedJob",
    "activityId": "serviceTask",
    "failedActivityId": "serviceTask",
    "causeIncidentId": "aCauseIncidentId",
    "rootCauseIncidentId": "aRootCauseIncidentId",
    "configuration": "aConfiguration",
    "incidentMessage": "anIncidentMessage",
    "tenantId": null,
    "jobDefinitionId": "aJobDefinitionId",
    "open": true,
    "deleted": false,
    "resolved": false,
    "removalTime": null,
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "annotation": "an annotation"
  },
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anotherExecutionId",
    "createTime": "2014-03-01T08:00:00.000+0200",
    "endTime": "2014-03-10T12:00:00.000+0200",
    "incidentType": "customIncidentType",
    "activityId": "userTask",
    "failedActivityId": "userTask",
    "causeIncidentId": "anotherCauseIncidentId",
    "rootCauseIncidentId": "anotherRootCauseIncidentId",
    "configuration": "anotherConfiguration",
    "incidentMessage": "anotherIncidentMessage",
    "tenantId": null,
    "jobDefinitionId": null,
    "open": false,
    "deleted": false,
    "resolved": true,
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "annotation": "another annotation"
  }
]

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.

sortBy

enum<string>

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

Available options:

incidentId,

incidentMessage,

createTime,

endTime,

incidentType,

executionId,

activityId,

processInstanceId,

processDefinitionId,

processDefinitionKey,

causeIncidentId,

rootCauseIncidentId,

configuration,

historyConfiguration,

tenantId,

incidentState

sortOrder

enum<string>

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.

Available options:

asc,

desc

firstResult

integer

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

maxResults

integer

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.

string | null

The id of the incident.

processDefinitionKey

string | null

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

processDefinitionId

string | null

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

processInstanceId

string | null

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

executionId

string | null

The id of the execution this incident is associated with.

rootProcessInstanceId

string | null

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

createTime

string<date-time> | null

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

endTime

string<date-time> | null

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

removalTime

string<date-time> | null

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

incidentType

string | null

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.

activityId

string | null

The id of the activity this incident is associated with.

failedActivityId

string | null

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

causeIncidentId

string | null

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

rootCauseIncidentId

string | null

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

configuration

string | null

The payload of this incident.

historyConfiguration

string | null

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

incidentMessage

string | null

The message of this incident.

tenantId

string | null

The id of the tenant this incident is associated with.

jobDefinitionId

string | null

The job definition id the incident is associated with.

open

boolean | null

If true, this incident is open.

deleted

boolean | null

If true, this incident has been deleted.

resolved

boolean | null

If true, this incident has been resolved.

annotation

string | null

The annotation set to the incident.

获取计数获取计数

⌘I

REST API

Javadoc

Authorizations

Query Parameters

Response