Get Start Form Variables
Retrieves the start form variables for the latest process definition for a tenant (only if they are defined via the Generated Task Form approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
Request
- Base URL: http://localhost:8080/engine-rest
- URL: http://localhost:8080/engine-rest/process-definition/key/{key}/tenant-id/{tenant-id}/form-variables
- Auth: HTTP basic
Path parameters
The key of the process definition (the latest version thereof) to be retrieved.
The id of the tenant the process definition belongs to.
Query parameters
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.
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.
Response
Request successful. A JSON object containing a property for each variable returned.
Changes
No recorded changes to this operation across all 1 revision of this API.