Joget DX 8 Stable Released
The stable release for Joget DX 8 is now available, with a focus on UX and Governance.
Table of Contents |
---|
URL
/web/json/workflow/package/deploy
...
Description
Workflow package deploy
Parameters
appId - App Idapp ID
version - App Versionapp version
packageXpdl - XPDL file
Sample Result
Code Block |
---|
{"status":"complete"}
|
...
...
Description
Retrieve package (Appapp) list
Parameters
Sample Result
Code Block |
---|
{
"data":
[
{
"packageId":"crm",
"packageName":"CRM"
},
{
"packageId":"helpdesk",
"packageName":"Helpdesk"
}
]
}
|
...
Parameters
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"}
]
}
|
...
Parameters
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"}
]
}
|
...
Parameters
Sample Result
Code Block |
---|
{
"id":"mdec#9#mdec_preseed_rejection",
"encodedId":"mdec:9:mdec_preseed_rejection"
}
|
...
Parameters
Sample Result
Code Block |
---|
{
"id":"mdec%239%23mdec_preseed_rejection",
"packageId":"mdec",
"packageName":"MDEC Workflow",
"name":"MDEC PreSeed Applicant Rejected",
"version":"9"
}
|
...
URL
/web/json/workflow/process/start/(:processDefId)
Method
HTTP GETPOST
Description
Start process instance
Parameters
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. |
...
URL
/web/json/workflow/process/abort/(:processId)
Method
HTTP POST
Description
Abort process instance
Parameters
Sample Result
Code Block |
---|
{
"id":"2117_CRM_newpkg1_wp1",
"status":"aborted"
}
|
...
Parameters
Sample Result
Code Block |
---|
{
"variableValue":"approve"
}
|
...
Parameters
Sample Result
Code Block |
---|
{"total":"3"}
|
...
...
Parameters
Sample Result
Code Block |
---|
{"total":"3"}
|
...
...
Parameters
Sample Result
Code Block |
---|
{"total":"1"}
|
...
...
Parameters
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"}
]
}
|
...
Parameters
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"}
]
}
|
...
Parameters
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":""}
]
}
|
...
Parameters
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"}
]
}
|
...
Parameters
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"}
]
}
|
...
Description
Retrieve workflow assignment view
Parameters
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"
}
|
...
Method
HTTP GET
Description
Retrieve the first workflow assignment process viewview of the currently logged in user.
Parameters
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"
}
|
...
URL
/web/json/workflow/assignment/accept/(:activityId)
Method
HTTP GETPOST
Description
Retrieve workflow assignment accept
Parameters
Sample Result
Code Block |
---|
{
"assignment": "1079_563_crm_process1_approve_proposal",
"status": "accepted"
}
|
...
URL
/web/json/workflow/assignment/withdraw/(:activityId)
Method
HTTP GETPOST
Description
Withdraw activity
Parameters
Sample Result
Code Block |
---|
{
"activityId":"11002_8702_aa_aa_wp1_org_wp1_act1",
"status":"withdrawn"
}
|
...
URL
/web/json/workflow/assignment/variable/(:activityId)/(:variable)
Method
HTTP GETPOST
Description
Set activity variable
Parameters
Sample Result
Code Block |
---|
{"status":"variableSet"}
|
...
URL
/web/json/workflow/assignment/completeWithVariable/(:activityId)
Method
HTTP GETPOST
Description
Set activity variable while completing an assignment activity
Variables can be passed as parameters with the var_ prefix
Parameters
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"
}
|
...
URL
/web/json/workflow/assignment/complete/(:activityId)
Method
HTTP GETPOST
Description
Complete assignment activity
Parameters
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"
}
|
...
URL
/web/json/workflow/variable/list/(*:processId)
Method
HTTP POSTGET
Description
Retrieve workflow variable of a process.
Parameters
...
Description
Retrieve process sla SLA list. Work
Prerequisites: Works only with Process Data Collector Plugin enabled.
Parameters
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 SLA list. Work
Prerequisites: Works only with Process Data Collector Plugin enabled.
Parameters
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
}
|
...
Parameters
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"}
]
}
|
...
Parameters
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"}
]
}
|
...
URL
/web/json/monitoring/process/copy/(:processId)/(:processDefId)
Method
HTTP GETPOST
Description
Start a process instance with a copy over workflow variable from a running process, and start matching running activity in the new process instance
Parameters
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"
]
}
|
...
Parameters
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"}
]
}
|
...
URL
/web/json/monitoring/activity/variable/(:activityId)/(:variable)
Method
HTTP GETPOST
Description
Set value for variable
Parameters
Sample Result
Code Block |
---|
{"status":"variableSet"}
|
...
...
Parameters
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"
}
|
...
URL
/web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
Method
HTTP GETPOST
Description
Abort an activity in a process
Parameters
Sample Result
Code Block |
---|
{
"processId":"mdec%239%23mdec_preseed_rejection",
"activityDefId":"newpkg1_wp1_act2",
"status":"aborted"
}
|
...
URL
/web/json/monitoring/activity/start/(:processId)/(:activityDefId)
Method
HTTP GETPOST
Description
Start an activity in a process
Parameters
...
Sample Result
Code Block |
---|
{
"processId":"mdec%239%23mdec_preseed_rejection",
"activityDefId":"newpkg1_wp1_act2",
"result":true
}
|
...
URL
/web/json/monitoring/activity/reassign
Method
HTTP POST
Description
Reassign assignee in an assignment
Parameters
...
Sample Result
Code Block |
---|
{ "processIdactivityId":"mdec%239%23mdec_preseed_rejection "533_277_crm_process1_approve_proposal", "activityDefIdusername": "newpkg1_wp1_act2cat", "resultreplaceUser":true "clark" } |
...
URL
/web/json/monitoring/user/reevaluate
Method
HTTP GETPOST
Description
Evaluate assignments for an a user
Parameters
...
Parameters
Sample Result
Code Block |
---|
{
"username":"admin"
}
|
...
...
Description
Get a list of published Userviewuser views
Parameters
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
}]
}
|
...
Description
Get a list of published processprocesses
Parameters
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"
}]
}]
}
|