IBM BPM on Cloud REST UI

Use the REST UI test tool to learn about IBM® BPM REST APIs, and to test APIs you are planning to use in your application.

Important: IBM BPM on Cloud components and the functions that they provide are based on the IBM BPM on premises product. The topics that are linked to here are in the IBM BPM documentation for IBM BPM V8.6. To see the topic that applies to your IBM BPM version, use the Change version list above the content pane. Be aware that not everything that is described in the IBM BPM documentation applies to IBM BPM on Cloud or your version of IBM BPM.

Is REST UI available in both editions of IBM BPM on Cloud?

Yes, it's available in both IBM BPM on Cloud and IBM BPM on Cloud Express.

Which REST APIs can I work with?

The following sets of APIs are available in the test tool:

BPD-related resources
Federated BPM resources
BPEL-related process resources
BPEL-related task resources

For more information about testing REST APIs, see Testing REST APIs. For reference information for these APIs, see REST API reference.

How can I work with the other IBM BPM REST APIs?

The following set of APIs is based on Swagger definitions:

IBM Business Process Manager REST APIs
If your environment includes a web server that hosts the Swagger UI, you can access the Swagger definition for the REST APIs by using a URL with the following format:
```
https://host_name:port_number/bpm/explorer
```
For more information, see IBM BPM REST APIs.