Query user tasks (alpha)

POST 
/user-tasks/search

Search for user tasks based on given criteria.

Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

application/json

Body

sort object[]
Array [
field stringrequired
order string
Default value: asc
]
page object
from int32
limit int32
searchAfter object[]
searchBefore object[]
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 string
The assignee of the user task.
priority int32
The priority of the user task.
elementId string
The element ID of the user task.
candidateGroup string
The candidate group for this user task.
candidateUser string
The candidate user for this user task.
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.
variables object[]
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
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
userTaskKey int64
The key for this user task.
state string
Possible values: [CREATED, COMPLETED, CANCELED, FAILED]
The state of the user task.
assignee string
The assignee of the user task.
elementId string
The element ID of the user task.
elementInstanceKey int64
The key of the element instance.
candidateGroups string[]
The candidate groups for this user task.
candidateUsers string[]
The candidate users for this user task.
processDefinitionId string
The ID of the process definition.
processDefinitionKey int64
The key of the process definition.
processInstanceKey int64
The key of the process instance.
formKey int64
The key of the form.
creationDate date-time
The creation date of a user task.
completionDate date-time
The completion date of a user task.
followUpDate date-time
The follow date of a user task.
dueDate date-time
The due date of a user task.
tenantId string
Tenant ID of this user task.
externalFormReference string
The external form reference.
processDefinitionVersion int32
The version of the process definition.
customHeaders object
Custom headers for the user task.
property name* string
priority integer
Possible values: <= 100
Default value: 50
The priority of a user task. The higher the value the higher the priority.
]

Example (from schema)

{
  "items": [
    {
      "userTaskKey": 0,
      "state": "CREATED",
      "assignee": "string",
      "elementId": "string",
      "elementInstanceKey": 0,
      "candidateGroups": [
        "string"
      ],
      "candidateUsers": [
        "string"
      ],
      "processDefinitionId": "string",
      "processDefinitionKey": 0,
      "processInstanceKey": 0,
      "formKey": 0,
      "creationDate": "2024-11-07T21:11:50.811Z",
      "completionDate": "2024-11-07T21:11:50.811Z",
      "followUpDate": "2024-11-07T21:11:50.811Z",
      "dueDate": "2024-11-07T21:11:50.811Z",
      "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"
}

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