Query user tasks (alpha)

POST 
/user-tasks/search

Search for user tasks based on given criteria.

note

This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. See the Camunda 8 REST API overview for further details.

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.
key int64
state string
assignee string
elementId string
candidateGroup string
candidateUser string
processDefinitionKey int64
processInstanceKey int64
tenantIds string
bpmnDefinitionId string

Responses

200

The user task search successful response.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
key int64
state string
assignee string
elementId string
elementInstanceKey int64
candidateGroup string[]
candidateUser string[]
bpmnProcessId string
processDefinitionKey int64
processInstanceKey int64
formKey int64
creationDate date-time
completionDate date-time
followUpDate date-time
dueDate date-time
tenantIds string
externalFormReference string
processDefinitionVersion int32
customHeaders object
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": [
    {
      "key": 0,
      "state": "string",
      "assignee": "string",
      "elementId": "string",
      "elementInstanceKey": 0,
      "candidateGroup": [
        "string"
      ],
      "candidateUser": [
        "string"
      ],
      "bpmnProcessId": "string",
      "processDefinitionKey": 0,
      "processInstanceKey": 0,
      "formKey": 0,
      "creationDate": "2024-09-16T07:02:41.459Z",
      "completionDate": "2024-09-16T07:02:41.459Z",
      "followUpDate": "2024-09-16T07:02:41.459Z",
      "dueDate": "2024-09-16T07:02:41.459Z",
      "tenantIds": "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...