Get Task

Retrieves a task by id.

Method

GET /task/{id}

Parameters

Path Parameters

Name	Description
id	The id of the task to be retrieved.

Result

A JSON object corresponding to the Task interface in the engine. Its properties are as follows:

Name Value Description

id String The id of the task.

name String The tasks name.

assignee String The user assigned to this task.

created String The time the task was created. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.

due String The due date for the task. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.

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

delegationState String The delegation state of the task. Corresponds to the DelegationState enum in the engine. Possible values are RESOLVED and PENDING.

description String The task description.

executionId String The id of the execution the task belongs to.

owner String The owner of the task.

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

priority Number The priority of the task.

processDefinitionId String The id of the process definition this task belongs to.

processInstanceId String The id of the process instance this task belongs to.

caseExecutionId String The id of the case execution the task belongs to.

caseDefinitionId String The id of the case definition the task belongs to.

caseInstanceId String The id of the case instance the task belongs to.

taskDefinitionKey String The task definition key.

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

formKey String If not null, the form key for the task.

camundaFormRef

String

If not null, the form binding for the Camunda Form with the following properties.

Name	Value	Description
key	String	The key of the linked Camunda Form.
binding	String	The binding type. Can be one of `latest`, `deployment` or `version`.
version	Integer	The concrete version of the linked Camunda Form. Only non-null when `binding` is `version`.

tenantId String If not null, the tenantId for the task.

* For further information, please see the documentation.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
200	application/hal+json	Request successful. In case of an expected HAL response.
404	application/json	Task with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /task/anId

Response

{"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": "aCamundaForm",
  "binding": "version",
  "version": 3
},
"tenantId":"aTenantId"}

Options