Joget DX 8 Stable Released
The stable release for Joget DX 8 is now available, with a focus on UX and Governance.
Warning |
---|
Introduced in v5, the API Domain Whitelist setting in General Settings needs to be configured to allow JSON API requests. If a request is from a non-whitelisted domain, the response will be a HTTP 400 Bad Request. |
Table of Contents
...
http://localhost:8080/jw/web/json/workflow/assignment/completecompleteWithVariable/879_223_crm_process1_approve_proposal?var_status=Sent
...
Description
Aborts a running process instance
User Role
Admin
Method
HTTP POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/process/abort/208_crm_process1
Sample Result
Code Block | ||
---|---|---|
| ||
{"status":"aborted","processId":"208_crm_process1"} |
Description
Gets latest Process def Id of a process based on a Process def Id
User Role
AdminURL/web/json/workflow/process/list
Method
HTTP GET/POST
Parameters
Sample ResultURL
...
http://localhost:8080/jw/web/json/workflow/process
...
Description
Retrieves process list
User Role
Admin
...
/latest/crm:1:process1
Sample Result
Code Block | ||
---|---|---|
| ||
{"id":"crm#3#process1","encodedId":"crm:3:process1"} |
Description
Retrieves process list
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/process/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" }] } |
...
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost:8080/jw/web/json/workflow/process/list/package
Sample Result
Code Block |
---|
{ "data": [{ "id": "morahr_expense", "count": 12, "processVersion": "53", "packageName": "MORAHR Expenses HalalClaim CertificationApp", "processId": "mora#5#morahr_new_applicationexpense#3#process1", "processName": "MORAExpense NewApproval ApplicationProcess", "packageId": "morahr_expense", "label": "MORAHR Expenses HalalClaim CertificationApp", "url": "/json/workflow/process/list?packageId=morahr_expense" }, { "id": "mdec_v1002isr", "count": 1, "processVersion": "122", "packageName": "Mdec Work ProgressISR", "processId": "mdec_v1002#12#mdec_wp1isr#2#isr", "processName": "mdec_wp1ISR Process", "packageId": "mdec_v1002isr", "label": "Mdec Work ProgressISR", "url": "/json/workflow/process/list?packageId=mdec_v1002isr" }, { "id": "hdc_v1001"hrleave", "count": 12, "processVersion": "1", "packageName": "halalJINC Leave certificationSolution", "processId": "hdc_v1001#1#hdc_certification_processhrleave#1#la", "processName": "HDCLeave CertificationApplication ProcessSystem", "packageId": "hdc_v1001hrleave", "label": "halalJINC Leave certificationSolution", "url": "/json/workflow/process/list?packageId=hdc_v1001hrleave" }] } |
Description
Retrieve first process with details of every packagesStarts a process based on process start whitelist
User RoleAdmin
Anyone (Including anonymous)
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/process/list/packagestart/crm:3:process1
Sample Result
Code Block | ||
---|---|---|
| ||
{"activityId":"885_224_crm_process1_approve_proposal","processId":"224_crm_process1"} |
Description
Retrieve first process with details of every packagesSets workflow variable of a process instance
User Role
Admin
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/process/list/packagevariable/208_crm_process1/status?value=test
Sample Result
Code Block | ||
---|---|---|
| ||
{"status" : "variableSet"} |
Description
Retrieve first process with details of every packagesRetrieves information of a process definition
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/process/list/packageview/crm:3:process1
Sample Result
Code Block | ||
---|---|---|
| ||
{
"packageName": "CRM",
"processId": "crm#3#process1",
"name": "Proposal Approval Process",
"packageId": "crm",
"version": "3"
} |
Description
Retrieve first process with details of every packagesRetrieves all variables of a process instance
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/processvariable/list/package208_crm_process1
Sample Result
Code Block | |
---|---|
|
Description
Retrieve first process with details of every packages
| |
{
"processId": "208_crm_process1",
"variable": {
"status": "approved"
}
} |
Description
Aborts an activity of a process instance
User Role
Admin
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflowmonitoring/activity/process/list/packageSample Resultabort/208_crm_process1/send_proposal
Sample Result
Code Block | ||
---|---|---|
| ||
{"activityDefId":"send_proposal","status":"aborted","processId":"208_crm_process1"} |
Description
Retrieve first process with details of every packagesRetrieves a list of all activities
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
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 URL
http://localhost:8080/jw/web/json/workflowmonitoring/processactivity/list/package?processId=116_hr_expense_process1
Sample Result
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Code Block | ||
---|---|---|
| ||
{
"total": 3,
"data": [{
"id": "474_116_hr_expense_process1_approve_claim",
"serviceLevelMonitor": "-",
"name": "Approve Claim",
"state": "open.not_running.not_started",
"dateCreated": "15-07-2015 02:54 AM"
}, {
"id": "472_116_hr_expense_process1_new_claim",
"serviceLevelMonitor": "-",
"name": "Edit Claim",
"state": "closed.completed",
"dateCreated": "15-07-2015 02:53 AM"
}, {
"id": "473_116_hr_expense_process1_tool4",
"serviceLevelMonitor": "-",
"name": "Update Record Status to Submitted",
"state": "closed.completed",
"dateCreated": "15-07-2015 02:54 AM"
}]
} |
Description
Reassigns a user to replace another user assigned to an assignmentDescription
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflowmonitoring/process/list/packageSample Resultactivity/reassign?activityId=841_206_crm_process1_send_proposal&username=admin&replaceUser=cat
Sample Result
Code Block | ||
---|---|---|
| ||
{"activityId":"841_206_crm_process1_send_proposal","username":"admin","replaceUser":"cat"} |
...
...
Description
Retrieve first process with details of every packagesReevaluates an activity
User Role
Admin
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflowmonitoring/process/list/packageactivity/reevaluate?activityId=841_206_crm_process1_send_proposal
...
...
...
Description
Retrieve first process with details of every packagesStarts an activity in a running process instance
User Role
Admin
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflowmonitoring/activity/process/list/packagestart/116_hr_expense_process1/verify_claim
Sample Result
Code Block | ||
---|---|---|
| ||
{"result":true,"activityDefId":"verify_claim","processId":"116_hr_expense_process1"} |
...
...
Description
Retrieve first process with details of every packagesSets value to a workflow variable to a running activity instance
User Role
Admin
Method
HTTP GET/ POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/workflowactivity/process/list/packagevariable/474_116_hr_expense_process1_approve_claim/status?value=test
Sample Result
Code Block | ||
---|---|---|
| ||
{"status":"variableSet"} |
...
Description
Retrieve first process with details of every packagesRetrieves information of an activity instance
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflowmonitoring/processactivity/list/packageview/474_116_hr_expense_process1_approve_claim
Sample Result
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Code Block | ||
---|---|---|
| ||
{
"processId": "116_hr_expense_process1",
"serviceLevelMonitor": "-",
"createdTime": "Wed Jul 15 10:54:10 MYT 2015",
"processName": "Expense Approval Process",
"assignee": "admin",
"activityId": "474_116_hr_expense_process1_approve_claim",
"activityDefId": "approve_claim",
"processVersion": "1",
"processDefId": "hr_expense#1#process1",
"participant": "approver",
"finishTime": "",
"variable": {
"status": "test"
},
"activityName": "Approve Claim",
"dueDate": ""
} |
Description
Retrieves a list of all completed process instances
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http:/localhost/jw/web/json/workflow/process/list/package
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 URL
http://localhost:8080/jw/web/json/monitoring/completed/process/list?rows=3
Sample Result
Code Block | ||
---|---|---|
| ||
{
"total": 74,
"data": [{
"id": "133_hr_expense_process1",
"serviceLevelMonitor": "-",
"requesterId": "admin",
"name": "Expense Approval Process",
"state": "closed.aborted",
"due": "-",
"startedTime": "29-07-2015 01:46 AM",
"version": "2"
}, {
"id": "135_crm_process1",
"serviceLevelMonitor": "-",
"requesterId": "admin",
"name": "Proposal Approval Process",
"state": "closed.aborted",
"due": "-",
"startedTime": "04-08-2015 09:28 AM",
"version": "2"
}, {
"id": "136_crm_process1",
"serviceLevelMonitor": "-",
"requesterId": "admin",
"name": "Proposal Approval Process",
"state": "closed.aborted",
"due": "-",
"startedTime": "04-08-2015 09:31 AM",
"version": "2"
}]
} |
Description
Copies the state and workflow variables of a running process instance to start a new process instance
User Role
Admin
Method
HTTP POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/process/copy/116_hr_expense_process1/hr_expense:1:process1
Sample Result
Code Block | ||
---|---|---|
| ||
{
"processId": "228_hr_expense_process1",
"processDefId": "hr_expense#1#process1",
"activities": [ "896_228_hr_expense_process1_approve_claim" ]
} |
Description
Sets a value to workflow variable of a process instance
User Role
Admin
Method
HTTP POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/process/variable/224_crm_process1/status?value=test
Sample Result
Code Block | ||
---|---|---|
| ||
{"status":"variableSet"} |
Description
Retrieves information of a process instance
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/process/view/224_crm_process1
Sample Result
Code Block | ||
---|---|---|
| ||
{
"requester": "admin",
"serviceLevelMonitor": "-",
"processId": "224_crm_process1",
"name": "Proposal Approval Process",
"finishTime": "",
"states": ["open.running", "open.running"],
"packageId": "crm",
"processDefId": "crm#3#process1",
"dueDate": "",
"startedTime": "",
"version": "3"
} |
Description
Completes a running activity
User Role
Admin
Method
HTTP POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/running/activity/complete?processDefId=crm:3:process1&processId=224_crm_process1&activityId=885_224_crm_process1_approve_proposal
Description
Reassigns a user to replace another user assigned to an assignment
User Role
Admin
Method
HTTP POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/running/activity/reassign?processDefId=crm:3:process1&processId=227_crm_process1&activityId=890_227_crm_process1_approve_proposal&username=cat&replaceUser=admin
Description
Retrieves a list of all running process instances
User Role
Admin
Method
HTTP GET/POST
Parameters
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 URL
http://localhost:8080/jw/web/json/monitoring/running/process/list?packageId=crm&rows=3
Sample Result
Code Block | ||
---|---|---|
| ||
{
"total": 16,
"data": [{
"id": "118_crm_process1",
"serviceLevelMonitor": "-",
"requesterId": "admin",
"name": "Proposal Approval Process",
"state": "open.running",
"due": "-",
"startedTime": "21-07-2015 03:03 AM",
"version": "1"
}, {
"id": "119_crm_process1",
"serviceLevelMonitor": "-",
"requesterId": "admin",
"name": "Proposal Approval Process",
"state": "open.running",
"due": "-",
"startedTime": "21-07-2015 03:03 AM",
"version": "1"
}, {
"id": "120_crm_process1",
"serviceLevelMonitor": "-",
"requesterId": "admin",
"name": "Proposal Approval Process",
"state": "open.running",
"due": "-",
"startedTime": "21-07-2015 03:03 AM",
"version": "1"
}]
} |
Description
Reevaluates all assignments of an user
User Role
Admin
Method
HTTP POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/monitoring/user/reevaluate?username=cat
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
Sample URL
http://localhost:8080/jw/web/json/workflow/activity/sla/list?appId=crm
Sample Result
Code Block | ||
---|---|---|
| ||
{
"total": 3,
"data": [{
"ratioOnTime": 100,
"activityDefId": "approval",
"serviceLevelMonitor": "<span class=\"dot_green\"> <\/span>",
"minDelay": 0,
"ratioWithDelay": 0,
"maxDelay": 0,
"activityName": "Approval"
}, {
"ratioOnTime": 100,
"activityDefId": "parallel",
"serviceLevelMonitor": "<span class=\"dot_green\"> <\/span>",
"minDelay": 0,
"ratioWithDelay": 0,
"maxDelay": 0,
"activityName": "Parallel"
}, {
"ratioOnTime": 100,
"activityDefId": "route1",
"serviceLevelMonitor": "<span class=\"dot_green\"> <\/span>",
"minDelay": 0,
"ratioWithDelay": 0,
"maxDelay": 0,
"activityName": "Route 1"
}]
} |
...
Code Block | ||
---|---|---|
| ||
{"success":true,"datasource":"default"} |