...
| Expand |
|---|
| title | [root_context]/tasks/{processInstanceId}/{taskId}?tenantId=xxx |
|---|
|
DescriptionUse the Execute task endpoint of the REST API to complete the user task (open task) and control the flow of the process. Executing a process via the public REST interface behaves as follows when the process encounters a user task: - The process stops and waits for further input
- The API user must provide the form data as payload of an http request to the exec endpoint
- The process continues its execution regardless of any button that is associated to the form/user task
- In order to influence the execution path of the process (for example at gateways), you can also set the values of the flow variables in the payload
Examples| Code Block |
|---|
| title | Example: Simulate a click on the Next button |
|---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
<field name="Person_FirstName" type="STRING">Bernhard</field>
<field name="Person_LastName" type="STRING">Adam</field>
<field name="action" type="STRING">true</field>
</data> |
| Note |
|---|
The action variable must be true. |
| Code Block |
|---|
| language | xml |
|---|
| title | Example: Simulate a click on the Next button (set as default flow) |
|---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
<field name="Person_FirstName" type="STRING">Bernhard</field>
<field name="Person_LastName" type="STRING">Adam</field>
</data> |
| Note |
|---|
The action variable is not required here. |
| Code Block |
|---|
| language | xml |
|---|
| title | Example: Simulate a click on the Cancel button |
|---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
<field name="Person_FirstName" type="STRING">Bernhard</field>
<field name="Person_LastName" type="STRING">Adam</field>
<field name="action" type="STRING">false</field>
</data> |
| Note |
|---|
The action variable must be false. |
| Note |
|---|
- The first two examples (simulating a click on the NEXT button) are alternatives.
- As soon as a gateway uses a variable in its condition and there is no flow marked as default, then the variable must be set and send to the endpoint. Otherwise you get an error response.
- You can not add variables to the 'Obtain task data and execute task' endpoint even though it is POST request. But you may send variables to the process when starting it.
- The button function CANCEL is not supported. Executing an open user task through the REST API will always continue with the button function NEXT.
|
|
Supported
...
field types
There are three possible values for the type attribute of a field:
| Type | Default | Description |
|---|
| STRING |  | For UTF-8 strings. |
| BYTES |  | For binary values, given as base64. | Note |
|---|
When passing CSRs, certificates and the like, always set the pure base64 value.
PEM is not supported. |
|
| DATE | | For date values, given in the format %Y-%M-%DT%h:%m:%s%z Example:2001-10-25T00:00:00+02:00
|