Task

Submit Form

Completes a task and updates process variables using a form submit. There are two difference between this method and the complete method:

  • If the task is in state PENDING - i.e., has been delegated before, it is not completed but resolved. Otherwise it will be completed.
  • If the task has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See the Generated Task Forms section of the User Guide for more information.
post/task/{id}/submit-form

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/task/{id}/submit-form
  • Auth: HTTP basic

Path parameters

idstring required

The id of the task to submit the form for.

Request body

variablesobject nullable

A JSON object containing variable key-value pairs.

withVariablesInReturnboolean nullable

Indicates whether the response should contain the process variables or not. The default is false with a response code of 204. If set to true the response contains the process variables and has a response code of 200. If the task is not associated with a process instance (e.g. if it's part of a case instance) no variables will be returned.

Response

Request successful. The response contains the process variables.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.