| Name | Description |
---|
1 | Process | Select the process for interaction with API. |
|
2 | Short Description | |
3 | Abort activity instance
| Abort an activity instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
4 | Abort process instance
| Abort a process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
5 | Complete activity instance
| Complete an activity instance to continue the flow of a process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
6 | Copy the state and workflow variables of a running process instance to start a new process instance
| Essentially cloning a running process instance to start a new process instance with the same state and workflow variable(s) data. Option available to simultaneously abort the original running process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
7 | Get activity instance detail
| Get details of an activity instance in a process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
8 | Get activity instance workflow variables
| Get the workflow variables and its values from an activity instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
9 | Get process instance detail
| Get details of a process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
10 | Get process instance workflow variables
| Get the workflow variables and its values from an process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
11 | List activity instances
| List all activity instances of a process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
12 | List completed process instances
| List all completed process instance(s) of the specified process. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
13 | List running process instances
| List all running process instance(s) of the specified process. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
14 | Reassign activity instance
| Explicitly set a user to replace an existing assignee of an activity instance, via username. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
15 | Reevaluate activity instance
| Update/Replace the assignee(s) of an activity instance according to the current participant mapping of the specified process. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
16 | Set activity instance workflow variables
| Set the values of the workflow variable(s) of an activity instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
17 | Set process instance workflow variables
| Set the values of the workflow variable(s) of a process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
18 | Start activity of a process instance
| Start an activity instance in a process instance. Option available to simultaneously abort the currently running activity instance in the specified process instance. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
19 | Start process by current user
| Start a new process instance of the specified process as the currently logged in user. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|
20 | Start process by username
| Start a new process instance of the specified process on behalf of a user via username. |
Name | Description |
---|
URL | /process/*yourProcessId*/ | HTTP Method | GET POST | Parameters |
| Sample Response | |
|