IBM Business Automation Workflow Process REST APIs

Edit online

IBM Business Automation Workflow provides a set of REST APIs for working with processes and tasks.

The Swagger definition for the REST APIs is included with Business Automation Workflow. If your Business Automation Workflow installation includes a web server that hosts the Swagger UI, you can access the Swagger definition for the REST APIs from a URL with the following format:
https://host_name:port_number/bpm/explorer
Where host_name is the name of your web server and port_number is the port number used by the web server. For example, localhost:9080/bpm/explorer. For information about configuring a web server, see Customizing Business Automation Workflow to work with a web server.
You can also get the Swagger definition by using the following REST API call:
GET /bpm/docs
The call returns a JSON object that contains the Swagger definition.
Important: To prevent cross site request forgery attacks, the Business Automation Workflow REST API operations require that the HTTP header BPMCSRFToken is set with every request. For more information, see Preventing cross site request forgery.
Cloud environments: For Business Automation Workflow on Cloud and IBM BPM on Cloud, the Business Automation Workflow REST APIs have the following URL structure: 
https://subscription_hostname/cloud_offering/environment
where
  • subscription_hostname can be one of the following values: bpm.ibmcloud.com or automationcloud.ibm.com
  • cloud_offering can take one of the following values:
    • baw for Business Automation Workflow on Cloud
    • dba for cloud subscriptions with multiple IBM Digital Business Automation on Cloud offerings, including Business Automation Workflow on Cloud
    • bpm for IBM BPM on Cloud
  • environment has the value dev for the development environment, test for the test environment, or run for the production (runtime) environment.