Versions Compared

Old Version 16

changes.mady.by.user Justin

Saved on

compared with

New Version 17

changes.mady.by.user Justin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


NameDescription
1Process
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Select the process for interaction with API.

2Short Description
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Any description here.

3

Anchor
Abort activity instance
Abort activity instance
Abort activity instance

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Abort an activity instance in a running process instance.

NameDescription
URL/process/*yourProcessId*/abortActivity/{processId}/{activityId}
HTTP MethodGET POST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
Code Block
languagejs
{
  "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
borderColorblack
bgColor#fbfff5
borderStylesolid

Abort a process instance.

NameDescription
URL/process/*yourProcessId*/abortProcess/{processId}
HTTP MethodGET POST
Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
Code Block
languagejs
{
  "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
borderColorblack
bgColor#fbfff5
borderStylesolid

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

NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
Code Block
languagejs
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
borderColorblack
bgColor#fbfff5
borderStylesolid
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 MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
7
 Anchor
Get activity instance detail
Get activity instance detail
Get activity instance detail
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get details of an activity instance in a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
8
 Anchor
Get activity instance workflow variables
Get activity instance workflow variables
Get activity instance workflow variables
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get the workflow variables and its values from an activity instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
9
 Anchor
Get process instance detail
Get process instance detail
Get process instance detail
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get details of a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
10
 Anchor
Get process instance workflow variables
Get process instance workflow variables
Get process instance workflow variables
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Get the workflow variables and its values from an process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
11
 Anchor
List activity instances
List activity instances
List activity instances
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
List all activity instances of a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
12
 Anchor
List completed process instances
List completed process instances
List completed process instances
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
List all completed process instance(s) of the specified process.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
13
 Anchor
List running process instances
List running process instances
List running process instances
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
List all running process instance(s) of the specified process.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
14
 Anchor
Reassign activity instance
Reassign activity instance
Reassign activity instance
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
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
 Code Block
languagejs
15
 Anchor
Reevaluate activity instance
Reevaluate activity instance
Reevaluate activity instance
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
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
 Code Block
languagejs
16
 Anchor
Set activity instance workflow variables
Set activity instance workflow variables
Set activity instance workflow variables
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Set the values of the workflow variable(s) of an activity instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
17
 Anchor
Set process instance workflow variables
Set process instance workflow variables
Set process instance workflow variables
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Set the values of the workflow variable(s) of a process instance.
NameDescription
URL/process/*yourProcessId*/
HTTP MethodGET POST
Parameters
Sample Response
 Code Block
languagejs
18
 Anchor
Start activity of a process instance
Start activity of a process instance
Start activity of a process instance
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
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
 Code Block
languagejs
19
 Anchor
Start process by current user
Start process by current user
Start process by current user
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
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
 Code Block
languagejs
20
 Anchor
Start process by username
Start process by username
Start process by username
 Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
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
 Code Block
languagejs
...