Skip to main content
Version: 8.5

TaskSearchRequest

TaskSearchRequest - query object to search tasks by provided params.

{
    "state": TaskState,
    "assigned": boolean,
    "assignee": string,
    "taskDefinitionId": string,
    "candidateGroup": string,
    "candidateUser": string,
    "processDefinitionKey": string,
    "processInstanceKey": string,
    "pageSize": int,
    "followUpDate": DateFilter,
    "dueDate": DateFilter,
    "taskVariables": [TaskVariables],
    "tenantIds": [string],
    "sort": [TaskOrderBy],
    "searchAfter": [string],
    "searchAfterOrEqual": [string],
    "searchBefore": [string],
    "searchBeforeOrEqual": [string],
    "includeVariables": [IncludeVariable]
}

Fields​

TaskSearchRequest.state ● TaskState enum​

State of the tasks

TaskSearchRequest.assigned ● boolean​

Are the tasks assigned?

TaskSearchRequest.assignee ● string​

Who is assigned to the tasks?

TaskSearchRequest.taskDefinitionId ● string​

Task definition ID - what's the BPMN flow node?

TaskSearchRequest.candidateGroup ● string​

Given group is in candidate groups list.

TaskSearchRequest.candidateUser ● string​

Given group is in candidate user list.

TaskSearchRequest.processDefinitionKey ● string​

Reference to process definition (renamed equivalent of TaskQuery.processDefinitionId field).

TaskSearchRequest.processInstanceKey ● string​

Reference to process instance (renamed equivalent of TaskQuery.processInstanceId field).

TaskSearchRequest.followUpDateDate ● DateFilter​

Specifying a range of follow-up dates for the tasks to search for.

TaskSearchRequest.dueDate ● DateFilter​

Specifying a range of due dates for the tasks to search for.

TaskSearchRequest.taskVariables ● TaskVariables list​

An array of filter clauses specifying the variables to filter for. If defined, the query returns only tasks to which all clauses apply. However, it's important to note that this filtering mechanism is designed to work exclusively with truncated variables. This means variables of a larger size are not compatible with this filter, and attempts to use them may result in inaccurate or incomplete query results.

TaskSearchRequest.tenantIds ● string list​

An array of Tenant IDs to filter tasks. When multi-tenancy is enabled, tasks associated with the specified tenant IDs are returned; if disabled, this parameter is ignored.

TaskSearchRequest.sort ● TaskOrderBy list​

An array of objects specifying the fields to sort the results by.

TaskSearchRequest.pageSize ● int​

Size of tasks page (default: 50).

TaskSearchRequest.searchAfter ● string list​

Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.

TaskSearchRequest.searchAfterOrEqual ● string list​

Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.

TaskSearchRequest.searchBefore ● string list​

Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.

TaskSearchRequest.searchBeforeOrEqual ● string list​

Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.

TaskSearchRequest.includeVariables ● IncludeVariable list​

An array used to specify a list of the variables that should be included in the response when querying tasks. This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

Consumed by​

Search tasks POST