Get Deployed Start Form

Retrieves the deployed form that can be referenced from a start event. For further information please refer to User Guide.

Method

  1. GET /process-definition/{id}/deployed-start-form

  2. GET /process-definition/key/{key}/deployed-start-form

  3. GET /process-definition/key/{key}/tenant-id/{tenant-id}/deployed-start-form

Parameters

Path Parameters

Name Description
id The id of the process definition to get the deployed 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 definitions belong to.

Result

An object with the deployed start form content.

Response Codes

Code Media type Description
200 application/xhtml+xml Request successful.
200 application/json Request successful.
400 application/json The form key has wrong format. See the Introduction for the error response format.
403 application/json The deployed start form cannot be retrieved due to missing permissions on process definition resource. See the Introduction for the error response format.
404 application/json No deployed start form for a given process definition exists. See the Introduction for the error response format.

Example

Request

GET /process-definition/processDefinitionId/deployed-start-form
GET /process-definition/key/processDefinitionKey/deployed-start-form
GET /process-definition/key/processDefinitionKey/tenant-id/tenantId/deployed-start-form

Response

<form role="form" name="invoiceForm"
      class="form-horizontal">

  <div class="form-group">
    <label class="control-label col-md-4"
           for="creditor">Creditor</label>
    <div class="col-md-8">
      <input cam-variable-name="creditor"
             cam-variable-type="String"
             id="creditor"
             class="form-control"
             type="text"
             required />
      <div class="help">
        (e.g. &quot;Great Pizza for Everyone Inc.&quot;)
      </div>
    </div>
  </div>

</form>

On this Page: