Skip to main content
POST
/
task
/
{id}
/
submit-form
curl --request POST \
  --url http://{host}:{port}/{contextPath}/task/{id}/submit-form \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "variables": {
    "aVariable": {
      "value": "aStringValue"
    },
    "anotherVariable": {
      "value": 42
    },
    "aThirdVariable": {
      "value": true
    },
    "aFileVariable": {
      "value": "TG9yZW0gaXBzdW0=",
      "type": "File",
      "valueInfo": {
        "filename": "myFile.txt"
      }
    }
  }
}'
{
  "aVariable": {
    "value": "aStringValue",
    "type": "String",
    "valueInfo": {}
  },
  "anotherVariable": {
    "value": 42,
    "type": "Integer",
    "valueInfo": {}
  },
  "aThirdVariable": {
    "value": true,
    "type": "Boolean",
    "valueInfo": {}
  }
}

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 submit the form for.

Body

application/json
​
variables
object | null

A JSON object containing variable key-value pairs.

​
withVariablesInReturn
boolean | null
default:false

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.

Response

Request successful. The response contains the process variables.

​
{key}
object