Automated REST test steps

You can create automated tests for Inbound REST APIs that you create. Creating tests for your custom REST APIs simplifies upgrade testing, and makes it possible to verify modifications to a REST API are backward compatible.

REST requests can only be sent to the current instance. You cannot send a request to another instance or third party/remote address.

The REST test configuration supports only XML and JSON response formats. Binary formats are not supported.

You can create tests that include steps from each of the test step configuration categories. The REST test configuration category contains the Send REST Request - Inbound and assert test configurations. Assert steps must immediately follow a Send REST Request - Inbound step. You can have multiple REST assert steps following a Send REST Request - Inbound step, but the assert steps cannot be separated from the Send REST Request - Inbound step by steps from other test categories.

Authentication

As part of the Automated Test Framework, there are two situations when you send REST requests. The first is when you use the REST API Explorer to create and test a request. The second is when you run a test that contains a Send Request - Inbound step.

When you use the REST API Explorer to create and test a request, and the request requires authentication, the REST API Explorer uses your credentials. When the ATF runs the test, the credentials of the user who scheduled the test are used. This means that a test might fail unintentionally because of the difference in privileges between the user who created the test and the user that runs the test.

To address the issue of user credentials, you can create a basic-authentication profile for a test user and then on the Send Request - Inbound form, specify that the profile be used when the test is run.