Returns the details of a specific task.
assignedUserId or candidateUserId can be specified as an additional filter to ensure that the task is completeable/claimable by the specified user. If this is not the case an error response will be returned.
Parameters
| Name | Type | Description |
|---|---|---|
| taskId | String | The ID of the task to return results for |
| assignedUserId | String | Only return the task if it is assigned to the specified user |
| candidateUserId | String | Only return the task if it may be claimed by the specified user |
| includeCanUnclaim | Boolean | If true, include unclaimability of task in response |
| includeEvents | Boolean | If true include all events related to the task in the result |
| includeHistoric | Boolean | If true include all historical data related to the task in the result |
| includeIdentityLinks | Boolean | Include all users and groups associated with the returned tasks in the result |
| includeBusinessKey | Boolean | If true include the business key of the process instance that contains the task |
| includeProcessDescription | Boolean | Include expanded process description |
| includeProcessVariables | Boolean | If true include all process variables of the instance that contains this task |
| includeRawFormData | Boolean | Includes "rawFormData" in the response which is suitable for passing to the forms service - this is intended for the use of template code only |
| includeTaskComments | Boolean | If true include all comments related to the task in the result |
| includeTaskDescription | Boolean | If true include expanded task description (documentation field) |
| includeTaskFormData | Boolean | If true include all form data related to the task in the result |
| includeTaskLocalVariables | Boolean | If true include all task local variables related to the task in the result |
| processDefinitionKeyIn | List<String> | Only return the task if it has a process definition key included in the supplied list |
| The taskId is required, other parameters are optional | ||
Last modified on March 10, 2020
Share this page
