Programming for process management

A set of workflow APIs is available for programming components, applications, and services.

Learn about the common activities you need to do when programming for process management.
Resource URLs
To access the workflow REST APIs from your cloud environments, use the URL structure 
https://tenant_name.subscription_hostname/cloud_offering/environment/bpm/system/login
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® Cloud Pak for Business Automation as a Service offerings, including 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. A token for one environment is not valid for another environment.
HTTP headers
To prevent cross site request forgery attacks, all calls to the workflow REST APIs require that the BPMCSRFToken token is set in the HTTP header of every request. A token is valid only for the cloud environment in which the client application is currently running; you can't reuse this token in another cloud environment. For information about how to obtain a token, see Preventing cross site request forgery in the IBM Business Automation Workflow documentation.
Authentication
Your client application must implement one of the supported authentication mechanisms to authenticate with Business Automation Workflow. For more information, see Authenticating client applications.
Authorization
The workflow REST APIs use authorization roles to determine the actions that a user can take on objects, such as processes, tasks, and user data. For information about these roles and the actions each role can take, see Authorization control for runtime REST API calls in the IBM Business Automation Workflow documentation.

For more information about the workflow APIs, see REST APIs in the IBM Business Automation Workflow documentation.