Skip to main content
Version: Next

Task

Describes the User task.

type Task {
id: ID!
name: String!
taskDefinitionId: String!
processName: String!
creationTime: String!
completionTime: String
assignee: String
variables: [Variable!]
taskState: TaskState!
sortValues: [String!]
isFirst: Boolean
formKey: String
processDefinitionId: String
processInstanceId: String
candidateGroups: [String!]
candidateUsers: [String!]
followUpDate: DateTime
#Due date for Task
dueDate: DateTime
}

Fields

Task.id ● ID! non-null scalar

The unique identifier of the task

Task.name ● String! non-null scalar

Name of the task

Task.taskDefinitionId ● String! non-null scalar

Task Definition ID (node BPMN id) of the process

Task.processName ● String! non-null scalar

Name of the process

Task.creationTime ● String! non-null scalar

When was the task created

Task.completionTime ● String scalar

When was the task completed

Task.assignee ● String scalar

Username/id of who is assigned to the task

Task.variables ● [Variable!] list object

Variables associated to the task

Task.taskState ● TaskState! non-null enum

State of the task

Task.sortValues ● [String!] list scalar

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

Task.isFirst ● Boolean scalar

Flag to show that the task is first in current filter

Task.formKey ● String scalar

Reference to the task form

Task.processDefinitionId ● String scalar

Reference to process definition

Task.processInstanceId ● String scalar

Reference to process instance id

Task.candidateGroups ● [String!] list scalar

Candidate groups

Task.candidateUsers ● [String!] list scalar

Candidate users

Task.followUpDate ● [String!] list scalar

Follow-up date for the task

Task.dueDate ● [String!] list scalar

Due date for the task

Returned by

claimTask mutation ● completeTask mutation ● task query ● tasks query ● unclaimTask mutation