Skip to main content
GET
/
process-definition
/
key
/
{key}
/
tenant-id
/
{tenant-id}
/
startForm
Get Start Form Key
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition/key/{key}/tenant-id/{tenant-id}/startForm \
  --header 'Authorization: Basic <encoded-value>'
{
  "key": "aFormKey",
  "contextPath": "http://localhost:8080/my-process-application/"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
key
string
required

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

​
tenant-id
string
required

The id of the tenant the process definition belongs to.

Response

Request successful.

​
key
string | null

The form key.

​
camundaFormRef
object
​
contextPath
string | null

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.