Query user tasks

POST 
/user-tasks/search

Search for user tasks based on given criteria.

Request

application/json

Body

sort object[]
Sort field criteria.
Array [
field stringrequired
The field to sort by.
order SortOrderEnum
Possible values: [ASC, DESC]
Default value: ASC
The order in which to sort the related field.
]
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.

filter object
User task filter request.
userTaskKey int64
The key for this user task.
state string
Possible values: [CREATED, COMPLETED, CANCELED, FAILED]
The state of the user task.
assignee object
The assignee of the user task.
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.
priority object
The priority of the user task.
oneOf
MOD1
integer
AdvancedIntegerFilter
$eq int32
Checks for equality with the provided value.
$neq int32
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$gt int32
Greater than comparison with the provided value.
$gte int32
Greater than or equal comparison with the provided value.
$lt int32
Lower than comparison with the provided value.
$lte int32
Lower than or equal comparison with the provided value.
$in int32[]
Checks if the property matches any of the provided values.
elementId string
The element ID of the user task.
candidateGroup object
The candidate group for this user task.
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.
candidateUser object
The candidate user for this user task.
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.
processDefinitionKey int64
The key of the process definition.
processInstanceKey int64
The key of the process instance.
tenantId string
Tenant ID of this user task.
processDefinitionId string
The ID of the process definition.
elementInstanceKey int64
The key of the element instance.
creationDate object
The user task creation date.
oneOf
MOD1
string
AdvancedDateTimeFilter
$eq date-time
Checks for equality with the provided value.
$neq date-time
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$gt date-time
Greater than comparison with the provided value.
$gte date-time
Greater than or equal comparison with the provided value.
$lt date-time
Lower than comparison with the provided value.
$lte date-time
Lower than or equal comparison with the provided value.
$in date-time[]
Checks if the property matches any of the provided values.
completionDate object
The user task completion date.
oneOf
MOD1
string
AdvancedDateTimeFilter
$eq date-time
Checks for equality with the provided value.
$neq date-time
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$gt date-time
Greater than comparison with the provided value.
$gte date-time
Greater than or equal comparison with the provided value.
$lt date-time
Lower than comparison with the provided value.
$lte date-time
Lower than or equal comparison with the provided value.
$in date-time[]
Checks if the property matches any of the provided values.
processInstanceVariables object[]
Process Instance variables associated with the user task.
Array [
name string
Name of the variable.
value string
The value of the variable.
]
localVariables object[]
Local variables associated with the user task.
Array [
name string
Name of the variable.
value string
The value of the variable.
]

Responses

200

The user task search result.

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 user tasks.
Array [
userTaskKey string
The key of the user task.
elementInstanceKey string
The key of the element instance.
processDefinitionKey string
The key of the process definition.
processInstanceKey string
The key of the process instance.
formKey string
The key of the form.
]

Example (from schema)

{
  "items": [
    {
      "userTaskKey": "string",
      "elementInstanceKey": "string",
      "processDefinitionKey": "string",
      "processInstanceKey": "string",
      "formKey": "string",
      "name": "string",
      "state": "CREATED",
      "assignee": "string",
      "elementId": "string",
      "candidateGroups": [
        "string"
      ],
      "candidateUsers": [
        "string"
      ],
      "processDefinitionId": "string",
      "creationDate": "2025-01-09T15:07:17.436Z",
      "completionDate": "2025-01-09T15:07:17.436Z",
      "followUpDate": "2025-01-09T15:07:17.436Z",
      "dueDate": "2025-01-09T15:07:17.436Z",
      "tenantId": "string",
      "externalFormReference": "string",
      "processDefinitionVersion": 0,
      "customHeaders": {},
      "priority": 50
    }
  ],
  "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 user tasks.
Array [
userTaskKey int64
The key of the user task.
elementInstanceKey int64
The key of the element instance.
processDefinitionKey int64
The key of the process definition.
processInstanceKey int64
The key of the process instance.
formKey int64
The key of the form.
]

Example (from schema)

{
  "items": [
    {
      "userTaskKey": 0,
      "elementInstanceKey": 0,
      "processDefinitionKey": 0,
      "processInstanceKey": 0,
      "formKey": 0,
      "name": "string",
      "state": "CREATED",
      "assignee": "string",
      "elementId": "string",
      "candidateGroups": [
        "string"
      ],
      "candidateUsers": [
        "string"
      ],
      "processDefinitionId": "string",
      "creationDate": "2025-01-09T15:07:17.438Z",
      "completionDate": "2025-01-09T15:07:17.438Z",
      "followUpDate": "2025-01-09T15:07:17.438Z",
      "dueDate": "2025-01-09T15:07:17.438Z",
      "tenantId": "string",
      "externalFormReference": "string",
      "processDefinitionVersion": 0,
      "customHeaders": {},
      "priority": 50
    }
  ],
  "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 user tasks.
Array [
userTaskKey string
The key of the user task.
elementInstanceKey string
The key of the element instance.
processDefinitionKey string
The key of the process definition.
processInstanceKey string
The key of the process instance.
formKey string
The key of the form.
]

Example (from schema)

{
  "items": [
    {
      "userTaskKey": "string",
      "elementInstanceKey": "string",
      "processDefinitionKey": "string",
      "processInstanceKey": "string",
      "formKey": "string",
      "name": "string",
      "state": "CREATED",
      "assignee": "string",
      "elementId": "string",
      "candidateGroups": [
        "string"
      ],
      "candidateUsers": [
        "string"
      ],
      "processDefinitionId": "string",
      "creationDate": "2025-01-09T15:07:17.440Z",
      "completionDate": "2025-01-09T15:07:17.440Z",
      "followUpDate": "2025-01-09T15:07:17.440Z",
      "dueDate": "2025-01-09T15:07:17.440Z",
      "tenantId": "string",
      "externalFormReference": "string",
      "processDefinitionVersion": 0,
      "customHeaders": {},
      "priority": 50
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The user task 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"
}

401

The request lacks valid authentication credentials.

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"
}

403

Forbidden. The request is not allowed.

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