获取列表

Get List

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

[
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anExecutionId",
    "incidentTimestamp": "2014-03-01T08:00:00.000+0200",
    "incidentType": "failedJob",
    "activityId": "serviceTask",
    "failedActivityId": "serviceTask",
    "causeIncidentId": "aCauseIncidentId",
    "rootCauseIncidentId": "aRootCauseIncidentId",
    "configuration": "aConfiguration",
    "tenantId": null,
    "incidentMessage": "anIncidentMessage",
    "jobDefinitionId": "aJobDefinitionId",
    "annotation": "an annotation"
  },
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anotherExecutionId",
    "incidentTimestamp": "2014-03-01T09:00:00.000+0200",
    "incidentType": "customIncidentType",
    "activityId": "userTask",
    "failedActivityId": "userTask",
    "causeIncidentId": "anotherCauseIncidentId",
    "rootCauseIncidentId": "anotherRootCauseIncidentId",
    "configuration": "anotherConfiguration",
    "tenantId": null,
    "incidentMessage": "anotherIncidentMessage",
    "jobDefinitionId": null,
    "annotation": "another annotation"
  }
]

GET

incident

Get List

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

[
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anExecutionId",
    "incidentTimestamp": "2014-03-01T08:00:00.000+0200",
    "incidentType": "failedJob",
    "activityId": "serviceTask",
    "failedActivityId": "serviceTask",
    "causeIncidentId": "aCauseIncidentId",
    "rootCauseIncidentId": "aRootCauseIncidentId",
    "configuration": "aConfiguration",
    "tenantId": null,
    "incidentMessage": "anIncidentMessage",
    "jobDefinitionId": "aJobDefinitionId",
    "annotation": "an annotation"
  },
  {
    "id": "anIncidentId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "executionId": "anotherExecutionId",
    "incidentTimestamp": "2014-03-01T09:00:00.000+0200",
    "incidentType": "customIncidentType",
    "activityId": "userTask",
    "failedActivityId": "userTask",
    "causeIncidentId": "anotherCauseIncidentId",
    "rootCauseIncidentId": "anotherRootCauseIncidentId",
    "configuration": "anotherConfiguration",
    "tenantId": null,
    "incidentMessage": "anotherIncidentMessage",
    "jobDefinitionId": null,
    "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.

processDefinitionKeyIn

string

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

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.

incidentTimestampBefore

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

incidentTimestampAfter

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

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.

tenantIdIn

string

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

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,

incidentTimestamp,

incidentType,

executionId,

activityId,

processInstanceId,

processDefinitionId,

causeIncidentId,

rootCauseIncidentId,

configuration,

tenantId

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.

processDefinitionId

string | null

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

processInstanceId

string | null

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

executionId

string | null

The id of the execution this incident is associated with.

incidentTimestamp

string<date-time> | null

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.

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

tenantId

string | null

The id of the tenant this incident is associated with.

incidentMessage

string | null

The message of this incident.

jobDefinitionId

string | null

The job definition id the incident is associated with.

annotation

string | null

The annotation set to the incident.

验证用户获取计数

⌘I

REST API

Javadoc

Authorizations

Query Parameters

Response