Process API can perform functions to interact or exchange data about the specified process.
The options here is based on the current app context.
- Abort activity instance
- Abort process instance
- Complete activity instance
- Copy the state and workflow variables of a running process instance to start a new process instance
- Get activity instance detail
- Get activity instance workflow variables
- Get process instance detail
- Get process instance workflow variables
- List activity instances
- List completed process instances
- List running process instances
- Reassign activity instance
- Reevaluate activity instance
- Set activity instance workflow variables
- Set process instance workflow variables
- Start activity of a process instance
- Start process by current user
- Start process by username
| Name | Description | |
|---|---|---|
| 1 | Process | Select the process for interaction with API. |
| 2 | Short Description | Any description here. |
| 3 | Abort activity instance | Abort an activity instance. |
| 4 | Abort process instance | Abort a process instance. |
| 5 | Complete activity instance | Complete an activity instance to continue the flow of a process instance. |
| 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. |
| 7 | Get activity instance detail | Get details of an activity instance in a process instance. |
| 8 | Get activity instance workflow variables | Get the workflow variables and its values from an activity instance. |
| 9 | Get process instance detail | Get details of a process instance. |
| 10 | Get process instance workflow variables | Get the workflow variables and its values from an process instance. |
| 11 | List activity instances | List all activity instances of a process instance. |
| 12 | List completed process instances | List all completed process instance(s) of the specified process. |
| 13 | List running process instances | List all running process instance(s) of the specified process. |
| 14 | Reassign activity instance | Explicitly set a user to replace an existing assignee of an activity instance, via username. |
| 15 | Reevaluate activity instance | Update/Replace the assignee(s) of an activity instance according to the current participant mapping of the specified process. |
| 16 | Set activity instance workflow variables | Set the values of the workflow variable(s) of an activity instance. |
| 17 | Set process instance workflow variables | Set the values of the workflow variable(s) of a process instance. |
| 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. |
| 19 | Start process by current user | Start a new process instance of the specified process as the currently logged in user. |
| 20 | Start process by username | Start a new process instance of the specified process on behalf of a user via username. |