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

Method

GET /process-definition/{id}/startForm

GET /process-definition/key/{key}/startForm (returns the key of the start form for the latest version of the process definition which belongs to no tenant)

GET /process-definition/key/{key}/tenant-id/{tenant-id}/startForm (returns the key of the start form for the latest version of the process definition for tenant)

Parameters

Path Parameters

Name	Description
id	The id of the process definition to get the start form for.
key	The key of the process definition (the latest version thereof) to be retrieved.
tenant-id	The id of the tenant the process definition belongs to.

Result

A JSON object containing the form key.

Name	Type	Description
key	String	The form key for the process definition.
contextPath	String	The context path of the process application.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Process definition has no start form defined. See the Introduction for the error response format.
404	application/json	Process definition with given key does not exist. See the Introduction for the error response format.

Example

Request

GET /process-definition/anId/startForm

GET /process-definition/key/aKey/startForm

Response

{"key":"aFormKey","contextPath":"/aContextPath"}