| Table of Contents |
|---|
web/json/console/app/(:appId)/(:version)/package/deploy
...
appId - app ID
version - app version
packageXpdl - XPDL file
Sample Result
| Code Block |
|---|
{"status":"complete"}
|
...
web/json/workflow/package/list
...
- callback - a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{
"data":
[
{
"packageId":"crm",
"packageName":"CRM"
},
{
"packageId":"helpdesk",
"packageName":"Helpdesk"
}
]
}
|
...
- 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
| Code Block |
|---|
{
"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"}
]
}
|
...
- 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
| Code Block |
|---|
{
"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"}
]
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processDefId - Process Definition Id (Replace '#' with ':' in the id)
Sample Result
| Code Block |
|---|
{
"id":"mdec#9#mdec_preseed_rejection",
"encodedId":"mdec:9:mdec_preseed_rejection"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processDefId - Process Definition Id (Replace '#' with ':' in the id)
Sample Result
| Code Block |
|---|
{
"id":"mdec%239%23mdec_preseed_rejection",
"packageId":"mdec",
"packageName":"MDEC Workflow",
"name":"MDEC PreSeed Applicant Rejected",
"version":"9"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processDefId - Process Definition Id (Replace '#' with ':' in the id)
- processInstanceId - (Optional) start process with an instanceId
- var_(workflow variable id) - (Optional) set workflow variable value
Sample Result
| Code Block |
|---|
{
"activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1",
"processId":"2117_CRM_newpkg1_wp1"
}
|
| Info |
|---|
The return of "activityId" is based on the value of "Show The Next Assignment When Completed" under "Run Process" in the activity mapping page. It also depends on whether an assignment exists for the current logged in user or not. |
...
web/json/workflow/process/abort/(:processId)
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process id
Sample Result
| Code Block |
|---|
{
"id":"2117_CRM_newpkg1_wp1",
"status":"aborted"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process id
- variable - variable id
Sample Result
| Code Block |
|---|
{
"variableValue":"approve"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{"total":"3"}
|
...
web/json/workflow/assignment/list/accepted/count
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{"total":"3"}
|
...
web/json/workflow/assignment/list/count
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{"total":"1"}
|
...
web/json/workflow/assignment/list/pending
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - (Optional) process definition (Replace '#' with ":" in 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
Sample Result
| Code Block |
|---|
{
"total":2,
"desc":true,
"sort":"dateCreated",
"start":0,
"data":
[
{"id":"3893_3727_mdec_v1002_mdec_wp1_mdec_wp1_work",
"activityId":"3893_3727_mdec_v1002_mdec_wp1_mdec_wp1_work",
"processVersion":"2",
"serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
"processId":"3727_mdec_v1002_mdec_wp1",
"description":"",
"processName":"mdec_wp1",
"due":"Fri Mar 20 13:57:37 SGT 2009",
"dateCreated":"Fri Mar 20 13:55:37 SGT 2009",
"label":"Work",
"activityName":"Work"},
{"id":"4001_3731_mdec_v1002_mdec_wp1_mdec_wp1_work",
"activityId":"4001_3731_mdec_v1002_mdec_wp1_mdec_wp1_work",
"processVersion":"2",
"serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
"processId":"3731_mdec_v1002_mdec_wp1",
"description":"",
"processName":"mdec_wp1",
"due":"Fri Mar 20 14:06:22 SGT 2009",
"dateCreated":"Fri Mar 20 14:04:22 SGT 2009",
"label":"Work",
"activityName":"Work"}
]
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - (Optional) process definition id (Replace '#' with ":" in 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
Sample Result
| Code Block |
|---|
{
"total":1,
"desc":true,
"sort":"dateCreated",
"start":0,
"data":
[
{"id":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
"activityId":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
"processVersion":"12",
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
"processId":"8001_mdec_v1002_mdec_wp1",
"description":"",
"processName":"mdec_wp1",
"due":"-",
"dateCreated":"Wed Apr 08 09:14:39 SGT 2009",
"label":"Review",
"activityName":"Review"}
]
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- packageId- (Optional) Package id /App Id
- processDefId- (Optional) Process Definition Id with version
- 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
Sample Result
| Code Block |
|---|
{
"total":1,
"desc":true,
"sort":"dateCreated",
"start":0,
"data":
[
{"processId":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
"activityId":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
"processName":"mdec_wp1",
"activityName":"Review",
"processVersion":"12",
"dateCreated":"Wed Apr 08 09:14:39 SGT 2009",
"acceptedStatus":"true",
"due":"-",
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
"id":"8001_mdec_v1002_mdec_wp1",
"label":"Review",
"description":""}
]
}
|
...
- 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
| Code Block |
|---|
{
"data":
[
{ "count":6,
"processVersion":"2",
"processName":"mdec_wp1",
"processDefId":"mdec_v1002#2#mdec_wp1",
"label":"mdec_wp1 ver 2 (6)",
"url":"/json/workflow/assignment/list/pending?processId=mdec_v1002%232%23mdec_wp1"},
{ "count":3,
"processVersion":"3",
"processName":"mdec_wp1",
"processDefId":"mdec_v1002#3#mdec_wp1",
"label":"mdec_wp1 ver 3 (3)",
"url":"/json/workflow/assignment/list/pending?processId=mdec_v1002%233%23mdec_wp1"}
]
}
|
...
- 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
| Code Block |
|---|
{
"data":
[
{ "count":1,
"processVersion":"12",
"processName":"mdec_wp1",
"processDefId":"mdec_v1002#12#mdec_wp1",
"label":"mdec_wp1 ver 12 (1)",
"url":"/json/workflow/assignment/list/accepted?processId=mdec_v1002%2312%23mdec_wp1"}
]
}
|
...
- callback - a function (in JavaScript) to call back after invoking this method
- activityId - activity id
Sample Result
| Code Block |
|---|
{
"activityId":"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2",
"processVersion":"4",
"activityDefId":"newpkg1_wp1_act2",
"processId":"9801_service_center_newpkg1_wp1",
"assigneeId":"admin",
"description":"",
"processName":"Service Center Escalation Process",
"dateCreated":"10-09-2009 10:45",
"participant":"Level 2",
"processDefId":"service_center#4#newpkg1_wp1",
"variable":[
{"relatedTo":""},
{"ticketId":""},
{"status":""},
{"complexity":""},
{"priority":""}],
"activityName":"Update Ticket Level 2"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - Process Instance ID
Sample Result
| Code Block |
|---|
{
"activityId":"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2",
"processVersion":"4",
"activityDefId":"newpkg1_wp1_act2",
"processId":"9801_service_center_newpkg1_wp1",
"assigneeId":"admin",
"description":"",
"processName":"Service Center Escalation Process",
"dateCreated":"10-09-2009 10:45",
"participant":"Level 2",
"processDefId":"service_center#4#newpkg1_wp1",
"variable":[
{"relatedTo":""},
{"ticketId":""},
{"status":""},
{"complexity":""},
{"priority":""}],
"activityName":"Update Ticket Level 2"
}
|
...
- callback - a function (in JavaScript) to call back after invoking this method
- activityId - activity id
Sample Result
| Code Block |
|---|
{
"assignment": "1079_563_crm_process1_approve_proposal",
"status": "accepted"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- activityId - activity id
Sample Result
| Code Block |
|---|
{
"activityId":"11002_8702_aa_aa_wp1_org_wp1_act1",
"status":"withdrawn"
}
|
...
- callback - a function (in JavaScript) to call back after invoking this method
- activityId - activity id
- variable - variable
- value - value
Sample Result
| Code Block |
|---|
{"status":"variableSet"}
|
...
web/json/workflow/assignment/completeWithVariable/(:activityId)
...
Description
Set activity variable while completing an assignment activity
Variables can be passed as parameters with the var_ prefix
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- activityId - activity id
- var_(workflow variable id) - (Optional) set workflow variable value
Sample Code
| Code Block |
|---|
/web/json/workflow/assignment/completeWithVariable/1079_563_crm_process1_approve_proposal?var_id=123&var_status=approved
|
Sample Result
| Code Block |
|---|
{
"activityId": "1079_563_crm_process1_approve_proposal",
"assignment": "admin",
"nextActivityId": "1093_563_crm_process1_send_proposal",
"processId": "563_crm_process1",
"status": "completed"
}
|
...
Method
HTTP POST
Description
Complete assignment activity
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- activityId - Activity id
Sample Result
| Code Block |
|---|
{
"activityId": "1079_563_crm_process1_approve_proposal",
"assignment": "admin",
"nextActivityId": "1093_563_crm_process1_send_proposal",
"processId": "563_crm_process1",
"status": "completed"
}
|
...
Description
Retrieve process SLA list; works .
Prerequisites: Works only with Process Data Collector Plugin enabled.
Parameters
- appId - app id
- appVersion - app version
Sample Result
| Code Block |
|---|
{
"data":
[
{"processDefId":"process1",
"processName":"Proposal Approval Process"
"minDelay":100,
"maxDelay":2220,
"ratioWithDelay":10,
"ratioOnTime":90,
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"}
]
"total" : 1
}
|
...
Description
Retrieve activity SLA list; works .
Prerequisites: Works only with Process Data Collector Plugin enabled.
Parameters
- appId - app id
- appVersion - app version
- processDefId - (Optional) process definition id without version
Sample Result
| Code Block |
|---|
{
"data":
[
{"activityDefId":"approve_proposal",
"activityName":"Approve Proposal"
"minDelay":100,
"maxDelay":2220,
"ratioWithDelay":10,
"ratioOnTime":90,
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"},
{"activityDefId":"activity1",
"activityName":"Resubmit Proposal"
"minDelay":100,
"maxDelay":2220,
"ratioWithDelay":10,
"ratioOnTime":90,
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"}
]
"total" : 2
}
|
...
- packageId - (Optional) package id
- processId - (Optional) process definition id without version
- processName - (Optional) process name
- version - (Optional) process version
- 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
Sample Result
| Code Block |
|---|
{
"total":2,
"desc":false,
"sort":"name",
"start":0,
"data":
[
{"id":"3724_mdec_v1002_mdec_wp1",
"serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
"name":"mdec_wp1","state":"open.running",
"due":"Fri Mar 20 14:01:27 SGT 2009",
"startedTime":"Fri Mar 20 13:51:27 SGT 2009","version":"2"},
{"id":"3725_mdec_v1002_mdec_wp1",
"serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
"name":"mdec_wp1",
"state":"open.running",
"due":"Fri Mar 20 14:03:16 SGT 2009",
"startedTime":"Fri Mar 20 13:53:16 SGT 2009",
"version":"2"}
]
}
|
...
- packageId - (Optional) package id
- processId - (Optional) process definition id without version
- processName - (Optional) process name
- version - (Optional) process version
- 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
Sample Result
| Code Block |
|---|
{
"total":2,
"desc":false,
"sort":"name",
"start":0,
"data":
[
{"id":"7401_mora_mora_new_application",
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
"name":"MORA New Application",
"state":"closed.completed",
"due":"-",
"startedTime":"Fri Apr 03 11:00:42 SGT 2009",
"version":"1"},
{"id":"7607_mora_mora_new_application",
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
"name":"MORA New Application",
"state":"closed.completed",
"due":"-",
"startedTime":"Fri Apr 03 12:36:09 SGT 2009",
"version":"2"}
]
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process id
- processDefId - process definition id
- abortCurrent - (Optional) Boolean value to indicate whether to abort the running process instance or not
Sample Result
| Code Block |
|---|
{
"processDefId":"service_center#4#newpkg1_wp1",
"processId":"9801_service_center_newpkg1_wp1",
"activities":[
"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2"
]
}
|
...
- processId - (Optional) process 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
Sample Result
| Code Block |
|---|
{
"total":2,
"desc":false,
"sort":"name",
"start":0,
"data":
[
{"id":"7836_7607_mora_mora_new_application_mora_new_application_act3",
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
"name":"Verify Application",
"state":"closed.completed",
"dateCreated":"Fri Apr 03 12:36:32 SGT 2009"},
{"id":"7840_7607_mora_mora_new_application_mora_oral_writing_test",
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
"name":"Update Oral & Writing Test Result",
"state":"closed.completed",
"dateCreated":"Fri Apr 03 12:37:57 SGT 2009"}
]
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- activityId - Activity id
- variable - Variable
- value - Value
Sample Result
| Code Block |
|---|
{"status":"variableSet"}
|
...
web/json/monitoring/activity/view/(:activityId)
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- activityId - Activity id
Sample Result
| Code Block |
|---|
{
"activityId":"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2",
"processVersion":"4",
"activityDefId":"newpkg1_wp1_act2",
"processId":"9801_service_center_newpkg1_wp1",
"acceptedUser":"admin",
"processName":"Service Center Escalation Process",
"assignee":"admin",
"participant":"level2",
"processDefId":"service_center#4#newpkg1_wp1",
"variable":
[
{"relatedTo":""},
{"ticketId":""},
{"status":""},
{"complexity":""},
{"priority":""}
],
"activityName":"Update Ticket Level 2"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process id
- activityDefId - activity definition id
Sample Result
| Code Block |
|---|
{
"processId":"mdec%239%23mdec_preseed_rejection",
"activityDefId":"newpkg1_wp1_act2",
"status":"aborted"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process id
- activityDefId - activity definition id
- abortCurrent - (Optional) Boolean value to indicate whether to abort current running activity or not
Sample Result
| Code Block |
|---|
{
"processId":"mdec%239%23mdec_preseed_rejection",
"activityDefId":"newpkg1_wp1_act2",
"result":true
}
|
...
- activityId- activity Instance ID
- username- new assignee (username)
- replaceUser- assignee to be replaced (username)
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{
"activityId": "533_277_crm_process1_approve_proposal",
"username": "cat",
"replaceUser": "clark"
}
|
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{
"username":"admin"
}
|
...
web/json/apps/published/userviews
...
- appId - (Optional) App ID
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{
"apps": [{
"id": "crm",
"name": "CRM",
"userviews": [{
"id": "crm_userview_sales",
"name": "CRM: Sales Force Automation",
"url": "/jw/web/userview/crm/crm_userview_sales",
"version": 1
}],
"version": 1
}]
}
|
...
- appId - (Optional) app ID
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
Sample Result
| Code Block |
|---|
{ "apps": [{ "id": "crm", "name": "CRM", "version": 1, "processes": [{ "id": "crm#1#process1", "processVersion": "1", "appVersion": 1, "name": "Proposal Approval Process", "idWithoutVersion": "process1", "url": "/jw/web/client/app/crm/1/process/process1?start=true" }] }] } |
/web/json/monitoring/activity/start/(:processId)/(:activityDefId)
URL
/web/json/monitoring/activity/start/(:processId)/(:activityDefId)
Method
HTTP POST
Description
Start a specific activity for a running process instance.
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - running process instance id
- activityDefId - activity definition id of the activity to start
- abortCurrent - optional parameter, set to true to abort other current running activities
Sample Result
| Code Block |
|---|
{"result":true,"activityDefId":"wp1_act3","processId":"11501_Human_Resource_WF_01_Human_Resource_WF_01_wp1"}
|
/web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
URL
/web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
Method
HTTP POST
DESCRIPTION
Abort a running activity in a process instance
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - running process instance id
- activityDefId - activity definition id of the activity to abort
Sample Result
| Code Block |
|---|
{"activityDefId":"wp1_act1","status":"aborted","processId":"11501_Human_Resource_WF_01_Human_Resource_WF_01_wp1"}
|
/web/json/monitoring/process/copy/(:currentProcessId)/(:newProcessDefId)
URL
/web/json/monitoring/process/copy/(:currentProcessId)/(:newProcessDefId)
Method
HTTP POST
DESCRIPTION
Start a new process while copying variables, form data and running activities from a previous running process instance.
Parameters
- callback - a function (in javascript) to call back after invoke this method
- currentProcessId - current running process instance id to copy from
- newProcessDefId - process definition id of the new process to start
- abortCurrent - optional parameter, set to true to abort the current running process
*Sample Result*1
| Code Block |
|---|
{"processId":"11502_Human_Resource_WF_01_Human_Resource_WF_01_wp1","processDefId":"Human_Resource_WF_01#1#Human_Resource_WF_01_wp1","activities":["10308_9802_Human_Resource_WF_01_Human_Resource_WF_01_wp1_wp1_act1","10309_9802_Human_Resource_WF_01_Human_Resource_WF_01_wp1_wp1_act2"]}
|