Assume that the process definition id is CRM#1#newpkg1_wp1, the username & password is admin, and the base URL of http://localhost:8080/jw/.
In this case
CRM is application id
1 is version of process you want to refer to
newpkg1_wp1 is process id
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 issues if you use setting * for this case in production environment