In this case:
- CRM is package id
- 1 is version of process you want to refer to
- newpkg1_wp1 is process id
If you not sure which package and process you have, you can use api to check what is your latest package, version, process you have in hand by http://localhost:8080/jw/web/json/workflow/process/list
Your api response could be as below:
{"packageId":"CRM","name":"new package 1 work process 1","id":"CRM#1#newpkg1_wp1","packageName":"CRM","label":"newpkg1 wp1 ver 1","version":"1"}
Start a Process
By using JSON API /json/workflow/process/start/(*:processDefId)Method Call
Please note that one must use POST to make such particular JSON API call.
Sample Call:
/web/json/workflow/process/start/CRM:1:newpkg1_wp1?j_username=admin&j_password=admin
Sample Result:
{"activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1","processId":"2117_CRM_newpkg1_wp1"}
NOTE: workflow variables can be set when starting a process by passing additional parameters into the URL, e.g., var_ticketId=123456&var_relatedTo=network.
Complete the Assignment with Variables
By using JSON API /json/workflow/assignment/completeWithVariable/(*:activityId)Method Call
Please note that one must use POST to make such particular JSON API call.
Sample Call:
/web/json/workflow/assignment/completeWithVariable/2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1?var_ticketId=123456&var_relatedTo=network&j_username=admin&j_password=admin
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"}
Abort a Process
By using JSON API /json/workflow/process/abort/(*:processId)Method Call
Please note that one must use POST to make such particular JSON API call.
Sample Call:
/web/json/workflow/process/abort/2117_CRM_newpkg1_wp1?j_username=admin&j_password=admin
Sample Result:
{"id":"2117_CRM_newpkg1_wp1","status":"aborted"}
Frequency problems:
- When first calling API or experiment in developer environment (localhost), you should check settings that already config appropriate API Domain Whitelist and API IP Whitelist. If you want to experiment by accept calling from any domain, ip address then you can input it as *
- Please be careful on security concern if you are setting API Domain Whitelist and API IP Whitelist as * in production environment