REST test step: Send REST Request - Inbound

Create a test step to send a REST request to the current instance. Specify the HTTP method, path, query parameters, request headers, and body of a REST request.

No HTTP response validation is performed as part of this step. The step fails if the response payload size is too big, the request parameters are invalid, or the request could not be sent. Use the assert steps to validate the response.

You cannot use this step to send a request to another instance or third party/remote address.

For more information on using REST APIs, see the REST API.

Table 1. Inputs
Field Description
Execution Order An integer specifying the order in which this step executes.

As you create steps, the system automatically assigns each step an incremental value. This causes the test to execute steps in the order in which you created them. You can change this default order by editing the Execution Order values.

Active If this step is active true. Otherwise, false.
Application The application scope in which the system will run this step.
Test (Read only.) The test to which this step belongs.
Step config (Read only.) The test step for this form.
Basic authentication

If you are using a public API, you don't need to provide authentication credentials.

If you are using a non-public API, you must provide the basic authentication information when doing the test. If you leave this field blank, you may receive unexpected results, for example, the response-status code might be 401 Unauthorized instead of 200 OK.

You must create or select a basic authentication profile to assign to test steps to avoid authentication issues when running the test.

Users must have the web_service_admin role to fully leverage the REST test steps. Without this role, users can not view or set basic authentication profiles needed for endpoints that require authentication. Without this role, users may still leverage the REST test steps for public APIs and unauthenticated access to non-public APIs. For full REST test step access, the atf_ws_designer role is available and contains the web_service_admin role along with the atf_test_designer role.

Method Select the HTTP method to use.
Path Enter the path. This field only accepts the portion of the URI after the instance. If you use https://dummy.com, you get an error.
Query Parameters Enter the parameter name and value. Do not encode the parameters.
Headers Enter the header name and value. Do not encode the name or value.