Query user task variables

POST 
/user-tasks/:userTaskKey/variables/search

Search for user task variables based on given criteria.

Request

Path Parameters

userTaskKey int64required

The key of the user task.

application/json

Body

page object

Pagination criteria.

from int32

The index of items to start searching from.

limit int32

The maximum number of items to return in one request.

searchAfter object[]

Items to search after. Correlates to the lastSortValues property of a previous search response.

searchBefore object[]

Items to search before. Correlates to the firstSortValues property of a previous search response.

sort object[]
Sort field criteria.
Array [
field stringrequired
Possible values: [value, name, tenantId, variableKey, scopeKey, processInstanceKey]
The field to sort by.
order SortOrderEnum
Possible values: [ASC, DESC]
Default value: ASC
The order in which to sort the related field.
]
filter object

The user task variable search filters.

name object

Name of the variable.

oneOf

MOD1

string

AdvancedStringFilter

$eq string

Checks for equality with the provided value.

$neq string

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$in string[]

Checks if the property matches any of the provided values.

$like string

Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client.

Responses

200

The user task variables search response.

application/json

Schema

Schema

page object

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching variables.
Array [
variableKey string
The key for this variable.
scopeKey string
The key of the scope of this variable.
processInstanceKey string
The key of the process instance of this variable.
]

Example (from schema)

{
  "items": [
    {
      "variableKey": "string",
      "scopeKey": "string",
      "processInstanceKey": "string",
      "name": "string",
      "value": "string",
      "fullValue": "string",
      "tenantId": "string",
      "isTruncated": true
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

page object

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching variables.
Array [
variableKey int64
The key for this variable.
scopeKey int64
The key of the scope of this variable.
processInstanceKey int64
The key of the process instance of this variable.
]

Example (from schema)

{
  "items": [
    {
      "variableKey": 0,
      "scopeKey": 0,
      "processInstanceKey": 0,
      "name": "string",
      "value": "string",
      "fullValue": "string",
      "tenantId": "string",
      "isTruncated": true
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

page object

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching variables.
Array [
variableKey string
The key for this variable.
scopeKey string
The key of the scope of this variable.
processInstanceKey string
The key of the process instance of this variable.
]

Example (from schema)

{
  "items": [
    {
      "variableKey": "string",
      "scopeKey": "string",
      "processInstanceKey": "string",
      "name": "string",
      "value": "string",
      "fullValue": "string",
      "tenantId": "string",
      "isTruncated": true
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The user task variables search query failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...