Task

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.

get/task/{id}/form

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/task/{id}/form
  • Auth: HTTP basic

Path parameters

idstring required

The id of the task to retrieve the form for.

Response

Request successful.

keystring nullable

The form key.

contextPathstring nullable

The context path of the process application. If the task (or the process definition) does not belong to a process application deployment or a process definition at all, this property is not set.

Changes

No recorded changes to this operation across all 1 revision of this API.