Get incident by key

GET 
/v1/incidents/:key

Get incident by key

Request

Path Parameters

key int64required

Key of incident

Responses

200

Success

application/json

Schema

Schema

key int64
processDefinitionKey int64
processInstanceKey int64
type string

Possible values: [UNSPECIFIED, UNKNOWN, IO_MAPPING_ERROR, JOB_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]

message string
creationTime string
state string

Possible values: [ACTIVE, MIGRATED, RESOLVED, PENDING]

jobKey int64
tenantId string

Example (from schema)

{
  "key": 0,
  "processDefinitionKey": 0,
  "processInstanceKey": 0,
  "type": "UNSPECIFIED",
  "message": "string",
  "creationTime": "string",
  "state": "ACTIVE",
  "jobKey": 0,
  "tenantId": "string"
}

400

Invalid request

application/problem+json

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

403

Forbidden

*/*

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

404

Requested resource not found

application/problem+json

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

500

API application error

application/problem+json

Schema

Schema

status int32
message string
instance string
type string

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string",
  "type": "string"
}

Loading...