Question

15.9.1. Get form data

GET form/form-data

Table 211. Get form data - URL parameters

Parameter	Required	Value	Description
taskId	Yes (if no processDefinitionId)	String	The task id corresponding to the form data that needs to be retrieved.
processDefinitionId	Yes (if no taskId)	String	The process definition id corresponding to the start event form data that needs to be retrieved.

Table 212. Get form data - Response codes

Response code	Description
200	Indicates that form data could be queried.
404	Indicates that form data could not be found.

Success response body:

{
  "data": [
  {
    "formKey" : null,
    "deploymentId" : "2",
    "processDefinitionId" : "3",
    "processDefinitionUrl" : "http://localhost:8182/repository/process-definition/3",
    "taskId" : "6",
    "taskUrl" : "http://localhost:8182/runtime/task/6",
    "formProperties" : [
    {
      "id" : "room",
      "name" : "Room",
      "type" : "string",
      "value" : null,
      "readable" : true,
      "writable" : true,
      "required" : true,
      "datePattern" : null,
      "enumValues" : [
      {
        "id" : "normal",
        "name" : "Normal bed"
      },
      {
        "id" : "kingsize",
        "name" : "Kingsize bed"
      },
      ]
    }
    ]
  }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

15.9.2. Submit task form data

POST form/form-data

Request body for task form:

{
  "taskId" : "5",
  "properties" : [
  {
    "id" : "room",
    "value" : "normal"
  }
  ]
}

Request body for start event form:

{
  "processDefinitionId" : "5",
  "businessKey" : "myKey",
  "properties" : [
  {
    "id" : "room",
    "value" : "normal"
  }
  ]
}

Table 213. Submit task form data - Response codes

Response code	Description
200	Indicates request was successful and the form data was submitted
400	Indicates an parameter was passed in the wrong format. The status-message contains additional information.

Success response body for start event form data (no response for task form data):

{
  "id" : "5",
  "url" : "http://localhost:8182/history/historic-process-instances/5",
  "businessKey" : "myKey",
  "suspended": false,
  "processDefinitionId" : "3",
  "processDefinitionUrl" : "http://localhost:8182/repository/process-definition/3",
  "activityId" : "myTask"
}