Skip to main content
Version: Next

TaskSearchResponse

TaskSearchResponse - representing the searched task.

{
"id": string,
"name": string,
"taskDefinitionId": string,
"processName": string,
"creationDate": string,
"completionDate": string,
"assignee": string,
"taskState": TaskState,
"sortValues": [string],
"isFirst": boolean,
"formKey": string,
"processDefinitionKey": string,
"processInstanceKey": string,
"tenantId": string,
"dueDate": string,
"followUpDate": string,
"candidateGroups": [string],
"candidateUsers": [string],
"variables": [VariableSearchResponse],
"priority": integer
}

Fields

TaskSearchResponse.id ● string non-null

The unique identifier of the task

TaskSearchResponse.name ● string non-null

Name of the task

TaskSearchResponse.taskDefinitionId ● string non-null

User task ID from the BPMN definition

TaskSearchResponse.processName ● string non-null

Name of the process

TaskSearchResponse.creationDate ● string non-null

When was the task created (renamed equivalent of Task.creationTime field)

TaskSearchResponse.completionDate ● string

When was the task completed (renamed equivalent of Task.completionTime field)

TaskSearchResponse.assignee ● string

Username/id of who is assigned to the task

TaskSearchResponse.taskState ● TaskState non-null enum

State of the task

TaskSearchResponse.sortValues ● string list

Array of values to be copied into TaskSearchRequest to request for next or previous page of tasks.

TaskSearchResponse.isFirst ● boolean

Flag to show that the task is first in current filter

TaskSearchResponse.formKey ● string

Reference to the task form

TaskSearchResponse.processDefinitionKey ● string

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

TaskSearchResponse.processInstanceKey ● string

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

TaskSearchResponse.tenantId ● string

Indicates the Tenant ID associated with the returned task

TaskSearchResponse.candidateGroups ● string list

Candidate groups

TaskSearchResponse.candidateUsers ● string list

Candidate users

TaskSearchResponse.followUpDate ● string list

Follow-up date for the task

TaskSearchResponse.dueDate ● string list

Due date for the task

TaskSearchResponse.variables ● VariableSearchResponse list

An array of task's variables. Only variables specified in TaskSearchReqeuest.includeVariables are returned. Note that variable's draft value is not returned in TaskSearchResponse.

Returned by

Search tasks POST