Get Task Form Variables

Retrieves the form variables for a task (only if they are defined via the Generated Task Form approach). The form variables take form data specified on the task into account. If form fields are defined, the variable types and default values of the form fields are taken into account.


GET /task/{id}/form-variables


Path Parameters

Name Description
id The id of the task to retrieve the variables for.

Query Parameters

Name Description
variableNames A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored.
deserializeValues Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.


A JSON object containing a property for each variable returned. The key is the variable name, the value is a JSON object with the following properties:

Name Value Description
value String / Number / Boolean / Object The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.
type String The value type of the variable.
valueInfo Object A JSON object containing additional, value-type-dependent properties.

For variables of type Object, the following properties are returned:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

Response Codes

Code Media type Description
200 application/xhtml+xml Request successful.
404 application/json Task id is null or does not exist. See the Introduction for the error response format.



GET /task/anId/form-variables

GET /task/anId/form-variables?variableNames=a,b,c


  "amount": {
      "type": "integer",
      "value": 5,
      "valueInfo": {}
  "firstName": {
      "type": "String",
      "value": "Jonny",
      "valueInfo": {}


On this Page: