Get Deployed Form

Retrieves the deployed form that is referenced from a given task. For further information please refer to User Guide.

Method

GET /task/{id}/deployed-form

Parameters

Path Parameters

Name Description
id The id of the task to get the deployed form for.

Result

An object with the deployed 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 form cannot be retrieved due to missing permissions on task resource. See the Introduction for the error response format.
404 application/json No deployed form for a given task exists. See the Introduction for the error response format.

Example

Request

GET /task/taskId/deployed-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: