REST API Tester

Use the REST API Tester to learn about workflow-related REST APIs, and to test APIs you are planning to use in your client application.

Important: The tools and the functions that are available in your cloud subscription are based on the functionality in the equivalent on premise product. The topics that are linked to here are in the documentation for the on-premise product.

Which REST APIs can I work with?

Depending on how your subscription is set up, you can work with one or more of the following sets of workflow process APIs in the test tool:

Business Automation Workflow REST APIs
Federated BPM resources
BPEL-related process resources
BPEL-related task resources

For reference information for these APIs, see the REST APIs section in the Business Automation Workflow documentation.

How can I work with other workflow REST APIs?

The following sets of workflow APIs are based on the OpenAPI specification. Depending on how your cloud subscription is set up, you might be able to access them directly from tools in your cloud portal. Alternatively, if your environment includes a web server that hosts the OpenAPI Explorer, you can view the specifications for the APIs.

Workflow Process REST APIs
To access the API specification, use a URL with the following format:
```
https://host_name:port_number/cloud_offering/dev/bpm/explorer
```
For more information, see Process REST APIs reference.
Workflow Operations REST APIs
To access the API specification, use a URL with the following format:
```
https://host_name:port_number/cloud_offering/dev/ops/explorer
```
For more information, see Operations REST APIs reference.
where cloud_offering can take one of the following values:
- baw for Business Automation Workflow on Cloud
- dbaoc for cloud subscriptions with multiple IBM® Cloud Pak for Business Automation as a Service capabilities, including Business Automation Workflow on Cloud

You can also view the reference information directly from the Business Automation Workflow documentation.