Cancel Active SugarBPM Workflows in Bulk with CURL and JavaScript

Author: Yuri Gee

2 minute read time

In this article, I'll show you how to cancel in-progress SugarBPM workflows in bulk. Each of the following methods can be employed to achieve the desired outcome, whether using CURL or JavaScript. These techniques are handy since the standard Process Management List only lets you cancel processes one by one. Normally, you'd have to navigate to each individual process record to access the cancel command. Let's try to simplify this process and make it more efficient! 

Example of CURL Command

Modern browsers like Chrome let you save network requests as CURL commands, which can then be replicated via the command line to repeat that network request. Cancelling a workflow is easily identifiable on the Network tab as a PUT request to https://<Your_SugarCRM_URL>/rest/v11_25/pmse_Inbox/cancelCases, which contains the process number(s) to cancel in its payload.

curl 'https:// <Your_SugarCRM_URL>//rest/v11_25/pmse_Inbox/cancelCases' \
  -X 'PUT' \
  -H 'accept: application/json, text/javascript, */*; q=0.01' \
  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
  -H 'content-type: application/json' \
…
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \
  -H 'x-requested-with: XMLHttpRequest' \
  -H 'x-userpref-hash: 09dcc5871dab42da1418fe20d818638e' \
  --data-raw '{"deleted":false,"cas_status":"IN PROGRESS","cas_pin":"0000","cas_assigned_status":"UNASSIGNED","sync_key":null,"cas_id":[2516, 2519, 2521]}'

Example of JavaScript Code

The following code can be executed from the Browser Console (e.g., Chrome Developer Tools Console) while the page is open at https://<Your_SugarCRM_URL>/#pmse_Inbox/layout/casesList. In this example, process numbers 2516 , 2519 and 2521 will be cancelled.

if (App.controller.context.attributes.model.attributes["cas_status"]=="IN PROGRESS" &&
App.controller.context.attributes.model.attributes["cas_pin"] == "0000" ) 
{ 
    let val = App.controller.context.attributes.model.attributes;
    val.cas_id = [2516, 2519, 2521];
    App.api.call('update', "rest/v11_25/pmse_Inbox/cancelCases", val ,{ success: function(data){}});
}

Additional notes

Using JavaScript and CURL commands can be risky, as these operations can make updates to your system. Therefore, it is crucial to exercise caution when executing these commands and ensure that the correct process numbers are provided. Commands may vary from version to version and should be tested thoroughly to ensure they meet your requirements before being used in a production environment.

Enhance your CRM functionality with these features and feel free to share your feedback on your experience!