Search process instances
POST/v1/process-instances/search
Search process instances
Request
- application/json
Body
required
Search process instances
- Array [
- ]
filter object
key int64
processVersion int32
bpmnProcessId string
parentKey int64
parentFlowNodeInstanceKey int64
startDate string
endDate string
state string
Possible values: [ACTIVE
, COMPLETED
, CANCELED
]
processDefinitionKey int64
tenantId string
parentProcessInstanceKey
size int32
searchAfter object[]
sort object[]
field string
order string
Possible values: [ASC
, DESC
]
Responses
- 200
- 400
- 401
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
items object[]
key int64
processVersion int32
bpmnProcessId string
parentKey int64
parentFlowNodeInstanceKey int64
startDate string
endDate string
state string
Possible values: [ACTIVE
, COMPLETED
, CANCELED
]
processDefinitionKey int64
tenantId string
parentProcessInstanceKey
sortValues object[]
total int64
{
"items": [
{
"key": 0,
"processVersion": 0,
"bpmnProcessId": "string",
"parentKey": 0,
"parentFlowNodeInstanceKey": 0,
"startDate": "string",
"endDate": "string",
"state": "ACTIVE",
"processDefinitionKey": 0,
"tenantId": "string"
}
],
"sortValues": [
{}
],
"total": 0
}
Data invalid
- application/problem+json
- Schema
- Example (from schema)
Schema
status int32
message string
instance string
type string
{
"status": 0,
"message": "string",
"instance": "string",
"type": "string"
}
Unauthorized
- */*
- Schema
- Example (from schema)
Schema
status int32
message string
instance string
type string
{
"status": 0,
"message": "string",
"instance": "string",
"type": "string"
}
Not Found
- */*
- 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...