Skip to main content
Version: 8.2

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,
    "sort": [TaskOrderBy],
    "searchAfter": [string],
    "searchAfterOrEqual": [string],
    "searchBefore": [string],
    "searchBeforeOrEqual": [string]
}

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

Array of values copied from sortValues of one of the tasks, query will return page of tasks going directly after this values plus same sort values.

TaskSearchRequest.searchAfterOrEqual ● string list​

Array of values copied from sortValues of one of the tasks, query will return page of tasks going directly after this values.

TaskSearchRequest.searchBefore ● string list​

Array of values copied from sortValues of one of the tasks, query will return page of tasks going directly before this values plus same sort values.

TaskSearchRequest.searchBeforeOrEqual ● string list​

Array of values copied from sortValues of one of the tasks, query will return page of tasks going directly before this values.

Consumed by​

Search tasks POST