Versions Compared

Old Version 37

changes.mady.by.user Hugo

Saved on

compared with

New Version Current

changes.mady.by.user Aadrian Zarin

Saved on

Key

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

...


NameDescription
1Process
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Select any process present in the current app, 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 MethodPOST
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 MethodPOST
Path 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*/completeActivity/{processId}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
Code Block
languagejs
{
  "date": "Thu Aug 29 18:41:53 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
6

Anchor
Clone running process instance
Clone running process instance
Clone running process instance

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Essentially cloning a running process instance along with its state and workflow variable(s) to a new process instance.

Option available to simultaneously abort the original running process instance.

NameDescription
URL/process/*yourProcessId*/copyProcess/{processId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Query String Parameters
ParameterDescription
abortCurrent

Abort the original running process instance.

Expects a boolean.

Sample Response
Code Block
languagejs
{
  "processId": "152_expenseclaim_process1",
  "recordId": "747ada41-a7e8-4537-a060-ae7daface7b5",
  "activities": [
    "393_152_expenseclaim_process1_new_claim"
  ]
}
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*/getActivityDetail/{processId}/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
Code Block
languagejs
{
  "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

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*/getActivityVariables/{processId}/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
Code Block
languagejs
{
  "SelectApprover": "admin",
  "status": "",
	.....
}
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*/getProcessDetail/{processId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
Code Block
languagejs
{
  "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

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*/getVariables/{processId}
HTTP MethodGET
Path Parameters
ParameterDescription
processIdProcess Instance ID.
Sample Response
Code Block
languagejs
{
  "SelectApprover": "admin",
  "status": "",
	.....
}
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*/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
Code Block
languagejs
[
  {
    "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

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*/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
Code Block
languagejs
[
  {
    "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

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*/listRunning
HTTP MethodGET
Query String Parameters
ParameterDescription
sort

Running 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
Code Block
languagejs
[
  {
    "startedTime": "26-08-2019 07:29 PM",
    "requesterId": "admin",
    "serviceLevelMonitor": "-",
    "due": "-",
    "name": "Expense Approval Process",
    "id": "149_expenseclaim_process1",
    "state": "open.running",
    "version": "7"
  },
	.....
]
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*/reassignActivity/{processId}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Query String Parameters
ParameterDescription
assigneeUsername of the original user assigned to the task.
replacementUsername of the user to replace the assignee.
Sample Response
Code Block
languagejs
{
  "date": "Thu Aug 29 19:27:03 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
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*/reevaluateActivity/{processId}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Sample Response
Code Block
languagejs
{
  "date": "Thu Aug 29 19:32:19 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
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*/setActivityVariables/{processId}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processIdProcess Instance ID.
activityIdActivity Instance ID.
Query String Parameters

The parameters required here is highly dependent on the app/process design.

ParameterDescription
variables

Workflow variables and its values.

Note
Do ensure that the workflow variable spelling and letter case is correct, as no error is outputted for non-existing workflow variables.
Sample Response
Code Block
languagejs
{
  "date": "Thu Aug 29 21:32:19 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
17

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 current running activity instance in the specified process instance.

NameDescription
URL/process/*yourProcessId*/startActivity/{processId}/{activityDefId}
HTTP MethodPOST
Path Parameters
ParameterDescription
processId

Process Instance ID.

Expects the ID of an existing process instance.

activityDefIdActivity Definition ID.
Query String Parameters
ParameterDescription
abortCurrent

Abort the current running activity instance in the process instance.

Expects a boolean.

Sample Response
Code Block
languagejs
{
  "processId": "152_expenseclaim_process1",
  "recordId": "747ada41-a7e8-4537-a060-ae7daface7b5",
  "activities": [
    "394_152_expenseclaim_process1_approve_claim"
  ]
}
18

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.

Warning

This API method only works for Basic Access Authentication.

See here on how to configure this setting in Manage API Key userview menu.

Info
titleTips

Remember to check Process Start White List to make sure the user is allowed to start the process instance.


NameDescription
URL/process/*yourProcessId*/startProcess
HTTP MethodPOST
Query String Parameters
ParameterDescription
processInstanceIdProcess Instance ID of a process that has been created, but not started.
recordIdPopulate the process instance's starting activity form with an existing record.
Body Parameters

The workflow variable(s) parameter required here is highly dependent on the app/process design. Example:

Code Block
languagejs
{
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}
Info
titleNote

If there is a Form mapped to the start process node, the Body Parameters apply to Form Data
If there is no Form mapped to the start process node, the Body Parameters apply to Workflow Variables

Sample Response
Code Block
languagejs
{
  "processId": "153_expenseclaim_process1",
  "recordId": "747ada41-a7e8-4537-a060-ae7daface7b5",
  "activities": [
    "395_153_expenseclaim_process1_new_claim"
  ]
}
19

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.

Info
titleTips

Remember to check Process Start White List to make sure the user is allowed to start the process instance.

NameDescription
URL/process/*yourProcessId*/startProcessByUser/{username}
HTTP MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Query String Parameters
ParameterDescription
processInstanceIdProcess Instance ID of a process that has been created, but not started.
recordIdPopulate the process instance's starting activity form with an existing record.
Body Parameters

The workflow variable(s) parameter required here is highly dependent on the app/process design. Example:

Code Block
languagejs
{
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}
Info
titleNote

If there is a Form mapped to the start process node, the Body Parameters apply to Form Data
If there is no Form mapped to the start process node, the Body Parameters apply to Workflow Variables

Sample Response
Code Block
languagejs
{
  "processId": "154_expenseclaim_process1",
  "recordId": "747ada41-a7e8-4537-a060-ae7daface7b5",
  "activities": [
    "396_154_expenseclaim_process1_new_claim"
  ]
}

...