Get incident
GET/incidents/:incidentKey
Returns incident as JSON.
Request
Path Parameters
The assigned key of the incident, which acts as a unique identifier for this incident.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
The incident is successfully returned.
- application/json
- Schema
- Example (from schema)
Schema
The assigned key, which acts as a unique identifier for this incident.
The process definition key associated to this incident.
The process definition ID associated to this incident.
The process instance key associated to this incident.
Possible values: [UNSPECIFIED, UNKNOWN, IO_MAPPING_ERROR, JOB_NO_RETRIES, EXECUTION_LISTENER_NO_RETRIES, CONDITION_ERROR, EXTRACT_VALUE_ERROR, CALLED_ELEMENT_ERROR, UNHANDLED_ERROR_EVENT, MESSAGE_SIZE_EXCEEDED, CALLED_DECISION_ERROR, DECISION_EVALUATION_ERROR, FORM_NOT_FOUND]
Incident error type with a defined set of values.
Error message which describes the error in more detail.
The flow node ID associated to this incident.
The flow node instance key associated to this incident.
Date of incident creation.
Possible values: [ACTIVE, MIGRATED, RESOLVED, PENDING]
State of this incident with a defined set of values.
The job key, if exists, associated with this incident.
The tenant ID of the incident.
{
"incidentKey": 0,
"processDefinitionKey": 0,
"processDefinitionId": "string",
"processInstanceKey": 0,
"errorType": "UNSPECIFIED",
"errorMessage": "string",
"flowNodeId": "string",
"flowNodeInstanceKey": 0,
"creationTime": "2024-12-13T13:19:42.611Z",
"state": "ACTIVE",
"jobKey": 0,
"tenantId": "string"
}
The incident request failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The request lacks valid authentication credentials.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Forbidden. The request is not allowed.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The incident with the given key was not found. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}