A test tool is provided with the IBM® BPM REST
APIs. You can use this tool to help you learn about the REST APIs,
and to test those APIs that you are planning to use in your application.
About this task
The REST API test tool is a web application that you can
use to prototype the following
IBM BPM REST
resources and their associated parameters:
- BPD-related resources
- Federated BPM resources
- BPEL-related process resources (IBM BPM
Advanced only)
- BPEL-related task resources (IBM BPM
Advanced only)
The tool is installed on each
Process Center and
Process Server node
as part of the
IBM BPM installation.
Procedure
- Start the REST API test tool. Direct your web
browser to the URL for the REST API test tool. The value of the URL
depends on how the virtual host and context root were configured for
your installation. The URL takes the following form:
http://host_name:port_number/bpmrest-ui
Where:- host_name
- The network name for the host of the process server.
- port_number
- The port number used by the REST API test tool. The port number
depends on your system configuration. The default port number is 9080.
For example, if you wanted to test the REST APIs
available on port 9080 on myserver1, you would open the http://myserver1:9080/bpmrest-ui URL
in your browser.
- In the REST API test tool, select an API.
- Optional: Enter any associated parameters that
you want to include in your test.
- Click Execute Call to start the
test.
Results
The response data is shown in the results pane.