Complete a task
PATCH/v1/tasks/:taskId/complete
Complete a task with taskId
and optional variables
. Returns the task.
Request
Path Parameters
The ID of the task.
- application/json
Body
- Array [
- ]
variables object[]
Variables to update or add to task during the task completion
The name of the variable.
The value of the variable. When specifying the variable value, it's crucial to maintain consistency with JSON values (serialization for the complex objects such as list) and ensure that strings remain appropriately formatted.
Responses
- 200
- 400
- 403
- 404
On success returned.
- application/json
- Schema
- Example (from schema)
Schema
The unique identifier of the task.
The name of the task.
User Task ID from the BPMN definition.
The name of the process.
When was the task created (renamed equivalent of Task.creationTime
field).
When was the task completed (renamed equivalent of Task.completionTime
field).
The username/id of who is assigned to the task.
Possible values: [CREATED
, COMPLETED
, CANCELED
, FAILED
]
The state of the task.
Reference to the task form.
Reference to the ID of a deployed form. If the form is not deployed, this property is null.
Reference to the version of a deployed form. If the form is not deployed, this property is null.
Is the form embedded for this task? If there is no form, this property is null.
Reference to process definition (renamed equivalent of Task.processDefinitionId
field).
Reference to process instance id (renamed equivalent of Task.processInstanceId
field).
The tenant ID associated with the task.
The due date for the task.
The follow-up date for the task.
The candidate groups for the task.
The candidate users for the task.
Possible values: [JOB_WORKER
, ZEEBE_USER_TASK
]
{
"id": "string",
"name": "string",
"taskDefinitionId": "string",
"processName": "string",
"creationDate": "string",
"completionDate": "string",
"assignee": "string",
"taskState": "CREATED",
"formKey": "string",
"formId": "string",
"formVersion": 0,
"isFormEmbedded": true,
"processDefinitionKey": "string",
"processInstanceKey": "string",
"tenantId": "string",
"dueDate": "2024-04-03T03:24:08.868Z",
"followUpDate": "2024-04-03T03:24:08.868Z",
"candidateGroups": [
"string"
],
"candidateUsers": [
"string"
],
"implementation": "JOB_WORKER"
}
An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before.
An error is returned if the task is not assigned to the current user.
- application/problem+json
- Schema
- Example (from schema)
Schema
An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.
A string that provides a brief description of the error that occurred.
Error instance UUID for lookup (e.g., in log messages).
{
"status": 0,
"message": "string",
"instance": "string"
}
User has no permission to access the task (Self-managed only).
- application/problem+json
- Schema
- Example (from schema)
Schema
An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.
A string that provides a brief description of the error that occurred.
Error instance UUID for lookup (e.g., in log messages).
{
"status": 0,
"message": "string",
"instance": "string"
}
An error is returned when the task with the taskId
is not found.
- application/problem+json
- Schema
- Example (from schema)
Schema
An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.
A string that provides a brief description of the error that occurred.
Error instance UUID for lookup (e.g., in log messages).
{
"status": 0,
"message": "string",
"instance": "string"
}