REST test step: Send REST Request - Inbound - REST API Explorer

This test step begins with the REST API Explorer. Use the REST API Explorer to create and specify the HTTP method, path, query parameters, request headers, and body of a REST request, and then send the REST request to the current instance.

When you have tested the request, the Create Automated Test Step button is shown. Click Create Automated Test Step button to create the test step. This button does not appear until after the request has been sent. You cannot create a test step when the request payload is larger than the maximum request payload size property.

This test step creates the same test record as the Send REST Request - Inbound test step. After the test step is created, you cannot go back and use the REST API Explorer to update the test. All changes must be made on the Send REST Request - Inbound test step form.

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.

These inputs are for the REST API Explorer. The fields you see depend upon the API selected. For more information on using REST APIs on your instance, see the REST API.

Table 1. Inputs
Field Description
Namespace Lists the available namespaces for the request.
API Name Lists the APIs available in the selected namespace.
API Version Lists the versions of the API that are available. You can select the version available on your instance.
Path parameters The part of the path that is after the API name. Path parameters are generally name value pairs where the allowable values are in a list.
Query parameters

Query parameters are added to the URI after the path. Query parameters are name value pairs.

The REST API Explorer encodes the URI, so it is not necessary to encode query parameters and values.

Request headers

A list of name value pairs contained in the request header. The authentication header is set to Send as me to use the current user's credentials. To use the test step in production, you may need to change the Basic Authentication field in the Send REST - Inbound test step.

Do not encode the name or value.

Request Body The request content. Some requests do not have a body.