Get process instance by key
GET/v1/process-instances/:key
Get process instance by key
Request
Path Parameters
key int64required
Key of process instance
Responses
- 200
- 400
- 403
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
key int64
processVersion int32
processVersionTag string
bpmnProcessId string
parentKey int64
parentFlowNodeInstanceKey int64
startDate string
endDate string
state string
Possible values: [ACTIVE, COMPLETED, CANCELED]
incident boolean
processDefinitionKey int64
tenantId string
parentProcessInstanceKey
{
"key": 0,
"processVersion": 0,
"processVersionTag": "string",
"bpmnProcessId": "string",
"parentKey": 0,
"parentFlowNodeInstanceKey": 0,
"startDate": "string",
"endDate": "string",
"state": "ACTIVE",
"incident": true,
"processDefinitionKey": 0,
"tenantId": "string"
}
Invalid request
- application/problem+json
- Schema
- Example (from schema)
Schema
status int32
message string
instance string
type string
{
"status": 0,
"message": "string",
"instance": "string",
"type": "string"
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
status int32
message string
instance string
type string
{
"status": 0,
"message": "string",
"instance": "string",
"type": "string"
}
Requested resource not found
- application/problem+json
- Schema
- Example (from schema)
Schema
status int32
message string
instance string
type string
{
"status": 0,
"message": "string",
"instance": "string",
"type": "string"
}
API application error
- application/problem+json
- Schema
- Example (from schema)
Schema
status int32
message string
instance string
type string
{
"status": 0,
"message": "string",
"instance": "string",
"type": "string"
}
Loading...