Get Form Key
Retrieves the form key for a task. The form key corresponds to the FormData#formKey property in the engine.
This key can be used to do task-specific form rendering in client applications. Additionally, the context path of the containing process application is returned.
Method
GET /task/{id}/form
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the task to retrieve the form for. |
Result
A JSON object containing the form key.
| Name | Value | Description |
|---|---|---|
| key | String | The form key for the task. |
| contextPath | String | The process application's context path the task belongs to. If the task does not belong to a process application deployment or a process definition at all, this property is not set. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 400 | application/json | Task with given id does not exist. See the Introduction for the error response format. |
Example
Request
GET /task/anId/form
Response
{"key":"aFormKey",
"contextPath":"http://localhost:8080/my-process-application/"}