Search variables for process instances

POST 
/v1/variables/search

Search variables for process instances

Request

application/json

Body

required

Search variables

filter object
key int64
processInstanceKey int64
scopeKey int64
name string
value string
truncated boolean
tenantId string
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
processInstanceKey int64
scopeKey int64
name string
value string
truncated boolean
tenantId string
]
sortValues object[]
total int64

Example (from schema)

{
  "items": [
    {
      "key": 0,
      "processInstanceKey": 0,
      "scopeKey": 0,
      "name": "string",
      "value": "string",
      "truncated": true,
      "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...