Search process instances

POST 
/v1/process-instances/search

Search process instances

Request

application/json

Body

Search process instances

filter object
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
size int32
searchAfter object[]
sort object[]
Array [
field string
order string
Possible values: [ASC, DESC]
]

Responses

200

Success

application/json

Schema

Schema

items object[]
Array [
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
]
sortValues object[]
total int64

Example (from schema)

{
  "items": [
    {
      "key": 0,
      "processVersion": 0,
      "processVersionTag": "string",
      "bpmnProcessId": "string",
      "parentKey": 0,
      "parentFlowNodeInstanceKey": 0,
      "startDate": "string",
      "endDate": "string",
      "state": "ACTIVE",
      "incident": true,
      "processDefinitionKey": 0,
      "tenantId": "string"
    }
  ],
  "sortValues": [
    {}
  ],
  "total": 0
}

400

Data invalid

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

Not Found

*/*

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