Skip to main content
Version: 8.4

TaskResponse

TaskResponse - represents a user task.

{
"id": string,
"name": string,
"taskDefinitionId": string,
"processName": string,
"creationDate": string,
"completionDate": string,
"assignee": string,
"taskState": TaskState,
"formKey": string,
"formId": string,
"formVersion": long,
"isFormEmbedded": boolean,
"processDefinitionKey": string,
"processInstanceKey": string,
"tenantId": string,
"dueDate": string,
"followUpDate": string,
"candidateGroups": [string],
"candidateUsers": [string]
}

Fields

TaskResponse.id ● string non-null

The unique identifier of the task

TaskResponse.name ● string non-null

Name of the task

TaskResponse.taskDefinitionId ● string non-null

User Task ID from the BPMN definition

TaskResponse.processName ● string non-null

Name of the process

TaskResponse.creationDate ● string non-null

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

TaskResponse.completionDate ● string

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

TaskResponse.assignee ● string

Username/id of who is assigned to the task

TaskResponse.taskState ● TaskState non-null enum

State of the task

TaskResponse.formKey ● string

Reference to the task form

TaskResponse.formId ● string

Reference to the ID of a deployed form. If the form is not deployed, this property is null.

TaskResponse.formVersion ● long

Reference to the version of a deployed form. If the form is not deployed, this property is null.

TaskResponse.isFormEmbedded ● boolean

Reference to the form is embedded or deployed. If there is no form, this property is null.

TaskResponse.processDefinitionKey ● string

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

TaskResponse.processInstanceKey ● string

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

TaskResponse.tenantId ● string

Indicates the Tenant ID associated with the returned task

TaskResponse.candidateGroups ● string list

Candidate groups

TaskResponse.candidateUsers ● string list

Candidate users

TaskResponse.followUpDate ● string list

Follow-up date for the task

TaskResponse.dueDate ● string list

Due date for the task

Returned by

Get task GET  ●  Assign task PATCH  ●  Unassign task PATCH  ●  Complete task PATCH