Open case APIs

Edit online
 23.0.2 
 A set of REST APIs for working with cases and activities is provided with the product.
The Swagger definition for the REST APIs is included with the product. If your 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 that is used by the web server. For example, localhost:9080/bpm/explorer.

In Swagger, to go to the Case APIs, use the following URL: https://host_name:port_number/case/docs

Important: To prevent the cross-site request forgery attacks, 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 IBM® Business Automation Workflow on Cloud, the 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 IBM Business Automation Workflow on Cloud
    • dba for cloud subscriptions with multiple IBM Cloud Pak for Business Automation as a Service offerings, including IBM Business Automation Workflow on Cloud
  • environment has the value dev for the development environment, test for the test environment, or run for the production (runtime) environment.