Skip to main content
POST
/
external-task
/
{id}
/
complete
Complete
curl --request POST \
  --url http://{host}:{port}/{contextPath}/external-task/{id}/complete \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workerId": "aWorker",
  "variables": {
    "aVariable": {
      "value": "aStringValue"
    },
    "anotherVariable": {
      "value": 42
    },
    "aThirdVariable": {
      "value": true
    }
  },
  "localVariables": {
    "aLocalVariable": {
      "value": "aStringValue"
    }
  }
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

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 complete.

Body

application/json
​
variables
object

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:

​
localVariables
object

A JSON object containing local variable key-value pairs. Local variables are set only in the scope of external task. Each key is a variable name and each value a JSON variable value object with the following properties:

​
workerId
string

Mandatory. The ID of the worker who is performing the operation on the external task. If the task is already locked, must match the id of the worker who has most recently locked the task.

Response

Request successful.