IBM Business Automation Workflow Operations REST APIs

Edit online

You can use Operations REST APIs to automate administrative actions for IBM Business Automation Workflow instead of using wsadmin commands. To perform administrative actions for applications running in the container environment, you must use these APIs.

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 (also known as OpenAPI) definition for the REST APIs from a URL with the following format:

https://host_name:port_number/ops/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/ops/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 /ops/docs

The call returns a JSON object that contains the Swagger definition.

Important: To prevent cross site request forgery attacks, the Business Automation Workflow Operations REST API operations require that the HTTP header BPMCSRFToken is set with every request. For more information, see Preventing cross site request forgery.