web/json/workflow/package/deploy
URL
/web/json/workflow/package/deploy
Method
HTTP POST
Description
Workflow package deploy
Parameters
-
Sample Result
{"status":"complete"}
web/json/workflow/package/update
URL
/web/json/workflow/package/update
Method
HTTP POST
Description
Workflow package update
Parameters
- packageId - package id
Sample Result
{"status":"complete"}
web/json/workflow/package/list
URL
/web/json/workflow/package/list
Method
HTTP GET
Description
Retrieve package list
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{
"total":3,
"data":
[
{"packageId":"aa"},
{"packageId":"mdec"},
{"packageId":"org"}
]
}
web/json/workflow/process/list
URL
/web/json/workflow/process/list
Method
HTTP GET
Description
Retrieve process list
Parameters
- callback - a function (in javascript) to call back after invoke this method
- allVersion - "yes" to load all version, "no" to load latest version
- packageId - package id
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
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
URL
/web/json/workflow/process/list/package
Method
HTTP GET
Description
Retrieve process list for process tree
Parameters
- callback - a function (in javascript) to call back after invoke this method
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"}
]
}
web/json/workflow/process/latest/(:processId)
URL
/web/json/workflow/process/latest/(:processId)
Method
HTTP GET
Description
Get latest process id
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
Sample Result
{
"id":"mdec#9#mdec_preseed_rejection",
"encodedId":"mdec:9:mdec_preseed_rejection"
}
web/json/workflow/process/view/(:processId)
URL
/web/json/workflow/process/view/(:processId)
Method
HTTP GET
Description
View selected process
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
Sample Result
{
"id":"mdec%239%23mdec_preseed_rejection",
"packageId":"mdec",
"name"="MDEC PreSeed Applicant Rejected",
"version":"9"
}
web/json/workflow/process/start/(:processDefId)
URL
/web/json/workflow/process/start/(:processId)
Method
HTTP GET
Description
Start process instance
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
Sample Result
{
"activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1",
"processId":"2117_CRM_newpkg1_wp1"
}
web/json/workflow/process/abort/(:processId)
URL
/web/json/workflow/process/abort/(:processId)
Method
HTTP POST
Description
Abort process instance
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
Sample Result
{
"id":"mdec%239%23mdec_preseed_rejection",
"status":"started"
}
web/json/workflow/process/variable/(:processId)/(:variable)
URL
/web/json/workflow/process/variable/(:processId)/(:variable)
Method
HTTP GET
Description
Get process workflow variable
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
- variable - variable id
Sample Result
{
"variableValue":"approve"
}
web/json/workflow/assignment/list/pending/count
URL
/web/json/workflow/assignment/list/pending/count
Method
HTTP GET
Description
Retrieve total size of assignment pending list
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{"total":"3"}
web/json/workflow/assignment/list/accepted/count
URL
/web/json/workflow/assignment/list/accepted/count
Method
HTTP GET
Description
Retrieve total size of assignment accepted list
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{"total":"3"}
web/json/workflow/assignment/list/count
URL
/web/json/workflow/assignment/list/count
Method
HTTP GET
Description
Retrieve total size of assignment pending accepted list
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{"total":"1"}
web/json/workflow/assignment/list/pending
URL
/web/json/workflow/assignment/list/pending
Method
HTTP GET
Description
Retrieve workflow assignment pending list
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
Sample Result
{
"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"}
]
}
web/json/workflow/assignment/list/accepted
URL
/web/json/workflow/assignment/list/accepted
Method
HTTP GET
Description
Retrieve workflow assignment accepted list
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
Sample Result
{
"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"}
]
}
web/json/workflow/assignment/list
URL
/web/json/workflow/assignment/list
Method
HTTP GET
Description
Retrieve workflow assignment pending accepted list
Parameters
- callback - a function (in javascript) to call back after invoke this method
- packageId- package id
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
Sample Result
{
"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":""}
]
}
web/json/workflow/assignment/list/pending/process
URL
/web/json/workflow/assignment/list/pending/process
Method
HTTP GET
Description
Retrieve workflow assignment pending list for tree
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{
"data":
[
{"id":null,
"count":6,
"processVersion":"2",
"processId":null,
"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"},
{"id":null,
"count":3,
"processVersion":"3",
"processId":null,
"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"}
]
}
web/json/workflow/assignment/list/accepted/process
URL
/web/json/workflow/assignment/list/accepted/process
Method
HTTP GET
Description
Retrieve workflow assignment accepted list for tree
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{
"data":
[
{"id":null,
"count":1,
"processVersion":"12",
"processId":null,
"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"}
]
}
web/json/workflow/assignment/view/(:activityId)
URL
/web/json/workflow/assignment/view/(:activityId)
Method
HTTP GET
Description
Retrieve workflow assignment view
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
Sample Result
{
"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"
}
web/json/workflow/assignment/process/view/(:processId)
URL
/web/json/workflow/assignment/process/view/(:processId)
Method
HTTP GET
Description
Retrieve workflow assignment process view
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
Sample Result
{
"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"
}
web/json/workflow/assignment/accept/(:activityId)
URL
/web/json/workflow/assignment/accept/(:activityId)
Method
HTTP GET
Description
Retrieve workflow assignment accept
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
Sample Result
-
web/json/workflow/assignment/withdraw/(:activityId)
URL
/web/json/workflow/assignment/withdraw/(:activityId)
Method
HTTP GET
Description
Withdraw activity
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
Sample Result
{
"activityId":"11002_8702_aa_aa_wp1_org_wp1_act1",
"status":"withdrawn"
}
web/json/workflow/assignment/variable/(:activityId)/(:variable)
URL
/web/json/workflow/assignment/variable/(:activityId)/(:variable)
Method
HTTP GET
Description
Set activity variable
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
- variable - variable
- value - value
Sample Result
-
web/json/workflow/assignment/completeWithVariable/(:activityId)
URL
/web/json/workflow/assignment/completeWithVariable/(:activityId)
Method
HTTP GET
Description
Set activity variable
Variables can be passed as parameters with the var_ prefix
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
Sample Code
/web/json/workflow/assignment/completeWithVariable/1_1_act?var_id=123&var_status=approved
Sample Result
{
"activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1",
"assignment":"org.joget.workflow.model.WorkflowAssignment@1b99f74",
"processId":"2117_CRM_newpkg1_wp1",
"status":"completed"
}
web/json/workflow/assignment/complete/(:activityId)
URL
/web/json/workflow/assignment/complete/(:activityId)
Method
HTTP GET
Description
Complete activity
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
Sample Result
{
"status":"completed",
"processId":"4001_3731_mdec_v1002_mdec_wp1_mdec_wp1_work"
}
web/json/workflow/variable/list/(*:processId)
URL
/web/json/workflow/variable/list/(*:processId)
Method
HTTP POST
Description
Retrieve workflow variable of a process. Only supported in Joget Workflow v2.0.0 and above.
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
Sample Result
{
"processId":"9801_service_center_newpkg1_wp1",
"variable":
[
{"relatedTo":""},
{"ticketId":""},
{"status":""},
{"complexity":""},
{"priority":""}
]
}
web/json/workflow/process/sla/list
URL
/web/json/workflow/process/sla/list
Method
HTTP GET
Description
Retrieve process sla list
Parameters
- appId - app id
- appVersion - app version
Sample Result
{
"data":
[
{"processDefId":"process1",
"processName":"Proposal Approval Process"
"minDelay":100,
"maxDelay":2220,
"ratioWithDelay":10,
"ratioOnTime":90,
"serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"}
]
"total" : 1
}
web/json/workflow/activity/sla/list
URL
/web/json/workflow/activity/sla/list
Method
HTTP GET
Description
Retrieve activity sla list
Parameters
- appId - app id
- appVersion - app version
- processDefId - process definition id without version
Sample Result
{
"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
}
web/json/monitoring/running/process/list
URL
/web/json/monitoring/running/process/list
Method
HTTP GET
Description
Retrieve running process list
Parameters
- packageId - package id
- processId - process id
- processName - process name
- version - process version
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
Sample Result
{
"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"}
]
}
web/json/monitoring/completed/process/list
URL
/web/json/monitoring/completed/process/list
Method
HTTP GET
Description
Retrieve completed process list
Parameters
- packageId - package id
- processId - process id
- processName - process name
- version - process version
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
Sample Result
{
"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"}
]
}
web/json/monitoring/process/copy/(:processId)/(:processDefId)
URL
/web/json/monitoring/process/copy/(:processId)/(:processDefId)
Method
HTTP GET
Description
Start a process instance with copy over workflow variable from a running process and start matching running activity in the new process instance
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
- processDefId - process definition id
- abortCurrent - whether to abort the running process instance
Sample Result
{
"processDefId":"service_center#4#newpkg1_wp1",
"processId":"9801_service_center_newpkg1_wp1",
"activities":[
"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2"
]
}
web/json/monitoring/activity/list
URL
/web/json/monitoring/activity/list
Method
HTTP GET
Description
Retrieve monitoring activity list
Parameters
- processId - process id
- sort - column name to be sort
- desc - boolean value to determine either sort by ascending or descending (true equals to descending)
- start - rows start from
- rows - number of rows per page
Sample Result
{
"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"}
]
}
web/json/monitoring/activity/reevaluate
URL
/web/json/monitoring/activity/reevaluate
Method
HTTP GET
Description
Evaluate assignment for activity
Parameters
- activityId - activity id
Sample Result
-
web/json/monitoring/activity/variable/(:activityId)/(:variable)
URL
/web/json/monitoring/activity/variable/(:activityId)/(:variable)
Method
HTTP GET
Description
Set value for variable
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
- variable - variable
- value - value
Sample Result
{"status":"variableSet"}
web/json/monitoring/activity/view/(:activityId)
URL
/web/json/monitoring/activity/view/(:activityId)
Method
HTTP GET
Description
Retrieve workflow activity view
Parameters
- callback - a function (in javascript) to call back after invoke this method
- activityId - activity id
Sample Result
{
"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"
}
web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
URL
/web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
Method
HTTP GET
Description
Abort an activity in a process
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
- activityDefId - activity definition id
Sample Result
{
"processId":"mdec%239%23mdec_preseed_rejection",
"activityDefId":"newpkg1_wp1_act2",
"status":"aborted"
}
web/json/monitoring/activity/start/(:processId)/(:activityDefId)
URL
/web/json/monitoring/activity/start/(:processId)/(:activityDefId)
Method
HTTP GET
Description
Start an activity in a process
Parameters
- callback - a function (in javascript) to call back after invoke this method
- processId - process id
- activityDefId - activity definition id
- abortCurrent - whether abort current running activity or not
Sample Result
{
"processId":"mdec%239%23mdec_preseed_rejection",
"activityDefId":"newpkg1_wp1_act2",
"result":true
}
web/json/monitoring/user/reevaluate
URL
/web/json/monitoring/user/reevaluate
Method
HTTP GET
Description
Evaluate assignments for an user
Parameters
- username - username
Sample Result
-
web/json/workflow/currentUsername
URL
/web/json/workflow/currentUsername
Method
HTTP GET
Description
Get current logged in user's username
Parameters
- callback - a function (in javascript) to call back after invoke this method
Sample Result
{
"username":"admin"
}