App
web/json/app/(*:appId)/(~:version)/form/(*:formId)/columns
web/json/app/(*:appId)/(~:version)/generator/(*:formId)/generate
web/json/apps/install
web/json/apps/published/processes
web/json/apps/published/userviews
web/json/console/app/list
web/json/console/app/(*:appId)/version/list
web/json/console/app/(*:appId)/(~:version)/builder/actions
web/json/console/app/(*:appId)/(~:version)/builder/binder/columns
web/json/console/app/(*:appId)/(~:version)/envVariable/list
web/json/console/app/(*:appId)/(~:version)/datalist/list
web/json/console/app/(*:appId)/(~:version)/datalist/options
web/json/console/app/(*:appId)/(~:version)/form/tableNameList
web/json/console/app/(*:appId)/(~:version)/forms
web/json/console/app/(*:appId)/(~:version)/forms/options
web/json/console/app/(*:appId)/(~:version)/package/deploy
web/json/console/app/(*:appId)/(~:version)/package/xpdl
web/json/console/app/(*:appId)/(~:version)/pluginDefault/list
web/json/console/app/(*:appId)/(~:version)/message/list
web/json/console/app/(*:appId)/(~:version)/userview/list
web/json/console/app/(*:appId)/(~:version)/userview/options
web/json/workflow/package/list
Description
Retrieves package (app) list
User Role
Admin
URL
/web/json/workflow/package/list
Method
HTTP GET/POST
Parameters
- callback - a function (in JavaScript) to call back after invoking this method
Sample Result
{
"data": [{
"packageId": "crm",
"packageName": "CRM"
}, {
"packageId": "helpdesk",
"packageName": "Helpdesk"
}]
}
Activities
Assignments
web/json/workflow/assignment/accept/(*:activityId)
web/json/workflow/assignment/complete/(*:activityId)
web/json/workflow/assignment/completeWithVariable/(*:activityId)
web/json/workflow/assignment/list
web/json/workflow/assignment/list/count
web/json/workflow/assignment/list/accepted
web/json/workflow/assignment/list/accepted/count
web/json/workflow/assignment/list/accepted/process
web/json/workflow/assignment/list/pending
web/json/workflow/assignment/list/pending/count
web/json/workflow/assignment/list/pending/process
web/json/workflow/assignment/process/view/(*:processId)
web/json/workflow/assignment/withdraw/(*:activityId)
web/json/workflow/assignment/variable/(*:activityId)/(*:variable)
web/json/workflow/assignment/view/(*:activityId)
Processes
web/json/workflow/process/abort/(*:processId)
web/json/workflow/process/latest/(*:processDefId)
Description
Gets latest Process def Id of a process based on a Process def Id
User Role
Admin
URL
/web/json/workflow/process/list
Method
HTTP GET/POST
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processDefId - Process Definition Id (Replace '#' with ':' in the id)
Sample Result
web/json/workflow/process/list
Description
Retrieves process list
User Role
Admin
URL
/web/json/workflow/process/list
Method
HTTP GET/POST
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- allVersion - (Optional) "yes" to load all versions, "no" to load latest version
- packageId - (Optional) package id (App id)
- sort - (Optional) column name to be sorted
- desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
- start - (Optional) where rows start from
- rows - (Optional) number of rows per page
- checkWhiteList - (Optional true/false) to return the list based on process white list
Sample Result
{
"total": 3,
"desc": false,
"sort": "name",
"start": 0,
"data": [{
"id": "hdc_v1001#1#hdc_certification_process",
"packageName": "halal certification",
"name": "HDC Certification Process",
"packageId": "hdc_v1001",
"label": "HDC Certification Process ver 1",
"version": "1"
}, {
"id": "mdec_v1002#12#mdec_wp1",
"packageName": "Mdec Work Progress",
"name": "mdec_wp1",
"packageId": "mdec_v1002",
"label": "mdec_wp1 ver 12",
"version": "12"
}, {
"id": "mora#5#mora_new_application",
"packageName": "MORA Halal Certification",
"name": "MORA New Application",
"packageId": "mora",
"label": "MORA New Application ver 5",
"version": "5"
}]
}
web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
URL
/web/json/workflow/process/list/package
Method
HTTP GET/POST
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- checkWhiteList - (Optional) Boolean value to return the list based on process white list
Sample Result
{
"data": [{
"id": "mora",
"count": 1,
"processVersion": "5",
"packageName": "MORA Halal Certification",
"processId": "mora#5#mora_new_application",
"processName": "MORA New Application",
"packageId": "mora",
"label": "MORA Halal Certification",
"url": "/json/workflow/process/list?packageId=mora"
}, {
"id": "mdec_v1002",
"count": 1,
"processVersion": "12",
"packageName": "Mdec Work Progress",
"processId": "mdec_v1002#12#mdec_wp1",
"processName": "mdec_wp1",
"packageId": "mdec_v1002",
"label": "Mdec Work Progress",
"url": "/json/workflow/process/list?packageId=mdec_v1002"
}, {
"id": "hdc_v1001",
"count": 1,
"processVersion": "1",
"packageName": "halal certification",
"processId": "hdc_v1001#1#hdc_certification_process",
"processName": "HDC Certification Process",
"packageId": "hdc_v1001",
"label": "halal certification",
"url": "/json/workflow/process/list?packageId=hdc_v1001"
}]
}