Sign in
Process Definition

Get Start Form Key

Retrieves the key of the start form for the latest version of the process definition for a tenant. The form key corresponds to the FormData#formKey property in the engine.

get/process-definition/key/{key}/tenant-id/{tenant-id}/startForm

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-definition/key/{key}/tenant-id/{tenant-id}/startForm
  • Auth: HTTP basic

Path parameters

keystring required

The key of the process definition (the latest version thereof) for which the form key is to be retrieved.

tenant-idstring required

The id of the tenant the process definition belongs to.

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.