You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Definition

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*/copyProcess/{processId}
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*/getActivityDetail/{processId}/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
{
  "finishTime": "",
  "variables": {
    "SelectApprover": "admin",
    "status": ""
  },
  "serviceLevelMonitor": "-",
  "dueDate": "",
  "activityName": "HOD Approve",
  "activityDefId": "approve_claim",
  "processVersion": "7",
  "participant": "approver",
  "activityId": "384_149_expenseclaim_process1_approve_claim",
  "processId": "149_expenseclaim_process1",
  "processName": "Expense Approval Process",
  "createdTime": "Wed Aug 28 15:03:15 SGT 2019",
  "assignee": [
    "admin"
  ],
  "processDefId": "expenseclaim#7#process1"
}
8

Get activity instance workflow variables

Get the workflow variables and its values from an activity instance.

NameDescription
URL/process/*yourProcessId*/getActivityVariables/{processId}/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
{
  "SelectApprover": "admin",
  "status": "",
	.....
}
9

Get process instance detail

Get details of a process instance.

NameDescription
URL/process/*yourProcessId*/getProcessDetail/{processId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
{
  "requester": "admin",
  "startedTime": "",
  "finishTime": "",
  "variables": {
    "SelectApprover": "admin",
    "status": ""
  },
  "serviceLevelMonitor": "-",
  "processId": "149_expenseclaim_process1",
  "dueDate": "",
  "packageId": "expenseclaim",
  "name": "Expense Approval Process",
  "processDefId": "expenseclaim#7#process1",
  "version": "7",
  "states": "open.running"
}
10

Get process instance workflow variables

Get the workflow variables and its values from an process instance.

NameDescription
URL/process/*yourProcessId*/getVariables/{processId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
{
  "SelectApprover": "admin",
  "status": "",
	.....
}
11

List activity instances

List all activity instances of a process instance.

NameDescription
URL/process/*yourProcessId*/listActivities/{processId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Query String Parameters
ParameterDescription
sort

Activity list data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
[
  {
    "dateCreated": "28-08-2019 03:03 PM",
    "serviceLevelMonitor": "-",
    "name": "HOD Approve",
    "id": "384_149_expenseclaim_process1_approve_claim",
    "state": "open.not_running.not_started"
  },
	.....
]
12

List completed process instances

List all completed process instance(s) of the specified process.

NameDescription
URL/process/*yourProcessId*/listCompleted
HTTP MethodGET
Query String Parameters
ParameterDescription
sort

Completed processes list data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
[
  {
    "startedTime": "25-04-2019 08:14 PM",
    "requesterId": "admin",
    "serviceLevelMonitor": "-",
    "due": "-",
    "name": "Expense Approval Process",
    "id": "44_expenseclaim_process1",
    "state": "closed.aborted",
    "version": "1"
  },
	.....
]
13

List running process instances

List all running process instance(s) of the specified process.

NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET
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 MethodPOST
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









                
        
    
        


                        
    





    

	

		
    
    
            
  • 
            No labels
        
    •