Complete Task
Completes a task and updates process variables.
Method
POST /task/{id}/complete
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the task to complete. |
Request Body
A JSON object with the following properties:
Name | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
variables | A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object with the following properties:
| ||||||||
withVariablesInReturn | Indicates whether the response should contain the process variables or not. The default is false with a response code of 204. If set to true the response contains the process variables and has a response code of 200. If the task is not associated with a process instance (e.g. if it's part of a case instance) no variables will be returned. |
Result
This method returns no content.
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. The response contains the process variables. |
204 | Request successful. The response contains no variables. | |
400 | application/json | The variable value or type is invalid, for example if the value could not be parsed to an Integer value or the passed variable type is not supported. See the Introduction for the error response format. |
500 | application/json | If the task does not exist or the corresponding process instance could not be resumed successfully. See the Introduction for the error response format. |
Example
Complete task
Request
POST /task/anId/complete
Request Body:
{"variables":
{"aVariable": {"value": "aStringValue"},
"anotherVariable": {"value": 42},
"aThirdVariable": {"value": true}}
}
Response
Status 204. No content.
Complete Task with variables in return
Request
POST /task/anId/complete
Request Body:
{"variables":
{"aVariable": {"value": "aStringValue"},
"anotherVariable": {"value": 42},
"aThirdVariable": {"value": true}},
"withVariablesInReturn": true
}
Response
Status 200.
{
"aVariable": {"value" : "aStringValue", "type": "String",
"valueInfo" : {} },
"anotherVariable": {"value" : 42, "type": "Integer",
"valueInfo" : {} },
"aThirdVariable": {"value" : true, "type": "Boolean",
"valueInfo" : {} }
}