Edit on Github

Get Rendered Start Form

Retrieves the rendered form for a process definition. This method can be used for getting the HTML rendering of a Generated Task Form.

Method

GET /process-definition/{id}/rendered-form

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

GET /process-definition/key/{key}/tenant-id/{tenant-id}/rendered-form (returns the rendered 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 rendered 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

An HTML response body providing the rendered (generated) form content.

Response Codes

Code	Media type	Description
200	application/xhtml+xml	Request successful.
400	application/json	Process definition has no form field metadata 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/rendered-form

GET /process-definition/key/aKey/rendered-form

Response

<form class="form-horizontal">
  <div class="control-group">
    <label class="control-label">Customer ID</label>
    <div class="controls">
      <input form-field type="string" name="customerId"></input>
    </div>
  </div>
  <div class="control-group">
    <label class="control-label">Amount</label>
    <div class="controls">
      <input form-field type="number" name="amount"></input>
    </div>
  </div>
</form>

Options