| Name | Description |
|---|
| 1 | Process | | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Select the process any process present in the current app, for interaction with API. |
|
| 2 | Short Description | | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Any description here. |
|
| 3 | | Anchor |
|---|
| Abort activity instance |
|---|
| Abort activity instance |
|---|
|
Abort activity instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Abort an activity instance in a running process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/abortActivity/{processId}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| processId | Process Instance ID. | | activityId | Activity Instance ID. |
| | Sample Response | | Code Block |
|---|
| {
"date": "Thu Aug 29 18:33:39 SGT 2019",
"code": "200",
"message": "Successful operation"
} |
|
|
| 4 | | Anchor |
|---|
| Abort process instance |
|---|
| Abort process instance |
|---|
|
Abort process instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Abort a process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/abortProcess/{processId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| processId | Process Instance ID. |
| | Sample Response | | Code Block |
|---|
| {
"date": "Thu Aug 29 18:35:31 SGT 2019",
"code": "200",
"message": "Successful operation"
} |
|
|
| 5 | | Anchor |
|---|
| Complete activity instance |
|---|
| Complete activity instance |
|---|
|
Complete activity instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Complete an activity instance to continue the flow of a process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/completeActivity/{processId}/{activityId} | | HTTP Method | GET POST | | Path Parameters | | Parameter | Description |
|---|
| processId | Process Instance ID. | | activityId | Activity Instance ID. |
| | Sample Response | | Code Block |
|---|
| {
"date": "Thu Aug 29 18:41:53 SGT 2019",
"code": "200",
"message": "Successful operation"
} |
|
|
| 6 | | Anchor |
|---|
| Copy the state and workflow variables of a running process instance to start a new process instance |
|---|
| Copy the state and workflow variables of a running process instance to start a new process instance |
|---|
|
Copy the state and workflow variables of a running process instance to start a new process instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Path Parameters | | Parameter | Description |
|---|
| processId | Process Instance ID. |
| | Sample Response | | Code Block |
|---|
| {
"processId": "152_expenseclaim_process1",
"activities": [
"393_152_expenseclaim_process1_new_claim"
]
} |
|
|
| 7 | | Anchor |
|---|
| Get activity instance detail |
|---|
| Get activity instance detail |
|---|
|
Get activity instance detail
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Get details of an activity instance in a process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 8 | | Anchor |
|---|
| Get activity instance workflow variables |
|---|
| Get activity instance workflow variables |
|---|
|
Get activity instance workflow variables
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Get the workflow variables and its values from an activity instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 9 | | Anchor |
|---|
| Get process instance detail |
|---|
| Get process instance detail |
|---|
|
Get process instance detail
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Get details of a process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 10 | | Anchor |
|---|
| Get process instance workflow variables |
|---|
| Get process instance workflow variables |
|---|
|
Get process instance workflow variables
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| Get the workflow variables and its values from an process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 11 | | Anchor |
|---|
| List activity instances |
|---|
| List activity instances |
|---|
|
List activity instances
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| List all activity instances of a process instance. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 12 | | Anchor |
|---|
| List completed process instances |
|---|
| List completed process instances |
|---|
|
List completed process instances
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| List all completed process instance(s) of the specified process. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 13 | | Anchor |
|---|
| List running process instances |
|---|
| List running process instances |
|---|
|
List running process instances
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| List all running process instance(s) of the specified process. |
| Name | Description |
|---|
| URL | /process/*yourProcessId*/ | | HTTP Method | GET POST | | Parameters |
| | Sample Response | |
|
| 14 | | Anchor |
|---|
| Reassign activity instance |
|---|
| Reassign activity instance |
|---|
|
Reassign activity instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Anchor |
|---|
| Reevaluate activity instance |
|---|
| Reevaluate activity instance |
|---|
|
Reevaluate activity instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Anchor |
|---|
| Set activity instance workflow variables |
|---|
| Set activity instance workflow variables |
|---|
|
Set activity instance workflow variables
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Anchor |
|---|
| Set process instance workflow variables |
|---|
| Set process instance workflow variables |
|---|
|
Set process instance workflow variables
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Anchor |
|---|
| Start activity of a process instance |
|---|
| Start activity of a process instance |
|---|
|
Start activity of a process instance
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Anchor |
|---|
| Start process by current user |
|---|
| Start process by current user |
|---|
|
Start process by current user
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | | Anchor |
|---|
| Start process by username |
|---|
| Start process by username |
|---|
|
Start process by username
| | Panel |
|---|
| borderColor | black |
|---|
| bgColor | #fbfff5 |
|---|
| borderStyle | solid |
|---|
| 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 | |
|