Skip to main content
GET
/
task
/
{id}
Get
curl --request GET \
  --url http://{host}:{port}/{contextPath}/task/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "anId",
  "name": "aName",
  "assignee": "anAssignee",
  "created": "2013-01-23T13:42:42.000+0200",
  "due": "2013-01-23T13:49:42.576+0200",
  "followUp": "2013-01-23T13:44:42.437+0200",
  "delegationState": "RESOLVED",
  "description": "aDescription",
  "executionId": "anExecution",
  "owner": "anOwner",
  "parentTaskId": "aParentId",
  "priority": 42,
  "processDefinitionId": "aProcDefId",
  "processInstanceId": "aProcInstId",
  "caseDefinitionId": "aCaseDefId",
  "caseInstanceId": "aCaseInstId",
  "caseExecutionId": "aCaseExecution",
  "taskDefinitionKey": "aTaskDefinitionKey",
  "suspended": false,
  "formKey": "aFormKey",
  "camundaFormRef": {
    "key": "aCamundaFormKey",
    "binding": "version",
    "version": 2
  },
  "tenantId": "aTenantId",
  "taskState": "aTaskState"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the task to be retrieved.

Response

Request successful.

​
attachment
boolean | null

Specifies if an attachment exists for the task.

​
comment
boolean | null

Specifies if an comment exists for the task.

​
id
string | null

The task id.

​
name
string | null

The task name.

​
assignee
string | null

The assignee's id.

​
owner
string | null

The owner's id.

​
created
string<date-time> | null

The date the task was created on. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
lastUpdated
string<date-time> | null

The date the task was last updated. Every action that fires a task update event will update this property. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
due
string<date-time> | null

The task's due date. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
followUp
string<date-time> | null

The follow-up date for the task. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
delegationState
enum<string> | null

The task's delegation state. Possible values are PENDING and RESOLVED.

Available options:
PENDING,
RESOLVED
​
description
string | null

The task's description.

​
executionId
string | null

The id of the execution the task belongs to.

​
parentTaskId
string | null

The id the parent task, if this task is a subtask.

​
priority
integer | null

The task's priority.

​
processDefinitionId
string | null

The id of the process definition the task belongs to.

​
processInstanceId
string | null

The id of the process instance the task belongs to.

​
caseExecutionId
string | null

The id of the case execution the task belongs to.

​
caseDefinitionId
string | null

The id of the case definition the task belongs to.

​
caseInstanceId
string | null

The id of the case instance the task belongs to.

​
taskDefinitionKey
string | null

The task's key.

​
suspended
boolean | null

Whether the task belongs to a process instance that is suspended.

​
formKey
string | null

If not null, the form key for the task.

​
camundaFormRef
object
​
tenantId
string | null

If not null, the tenant id of the task.

​
taskState
string | null

The task's state.