Process API can perform functions to interact or exchange data about the specified process.

The options here is based on the current app context.


NameDescription
1Process

Select any process present in the current app, for interaction with API.

2Short Description

Any description here.

3

Abort activity instance

Abort an activity instance in a running process instance.

NameDescription
URL/process/*yourProcessId*/abortActivity/{processId}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
{
  "date": "Thu Aug 29 18:33:39 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
4

Abort process instance

Abort a process instance.

NameDescription
URL/process/*yourProcessId*/abortProcess/{processId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
{
  "date": "Thu Aug 29 18:35:31 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
5

Complete activity instance

Complete an activity instance to continue the flow of a process instance.

NameDescription
URL/process/*yourProcessId*/completeActivity/{processId}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
{
  "date": "Thu Aug 29 18:41:53 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
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.

NameDescription
URL/process/*yourProcessId*/
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
{
  "processId": "152_expenseclaim_process1",
  "activities": [
    "393_152_expenseclaim_process1_new_claim"
  ]
}
7

Get activity instance detail

Get details of an activity instance in a process instance.

NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
8
Get activity instance workflow variables
Get the workflow variables and its values from an activity instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
9
Get process instance detail
Get details of a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
10
Get process instance workflow variables
Get the workflow variables and its values from an process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
11
List activity instances
List all activity instances of a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
12
List completed process instances
List all completed process instance(s) of the specified process.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
13
List running process instances
List all running process instance(s) of the specified process.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
14
Reassign activity instance
Explicitly set a user to replace an existing assignee of an activity instance, via username.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET 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.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
16
Set activity instance workflow variables
Set the values of the workflow variable(s) of an activity instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
17
Set process instance workflow variables
Set the values of the workflow variable(s) of a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET 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.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET 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.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET 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.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response