Applies to ReadyAPI 2.8, last modified on August 16, 2019

This section describes REST parameter types.

Note: For information on how to configure REST parameters, see the parameter editor description.
To learn how to modify the REST request body, see the content editor description.

QUERY is the most common parameter type. It is specified at the end of the URL after the question mark (?). You can see it in the path preview at the top of the REST request editor.

QUERY parameters

Click the image to enlarge it.

If you simulate submitting HTML forms, use the POST method and add a query to the message body.

Using the POST method

Click the image to enlarge it.

If this option is selected, ReadyAPI removes the parameter from the path. After you submit a request, you can see the query in the raw request body.

The Raw tab

TEMPLATE or PATH parameters are used to parametrize the request path. They add a placeholder populated with values from the specified options.

TEMPLATE parameters

Click the image to enlarge it.

Note: TEMPLATE parameters work only on the resource level. It is possible to specify them on the method level as well, but we do not recommend that you do this. If you define a TEMPLATE parameter on the method level, it will not be automatically appended to the resource path, and you will have to manage it manually.

The Form editor displays the extra data added for the parameter as a drop-down list.

The Form editor

Click the image to enlarge it.

Here, the format is displayed as a drop-down list with the following options: csv, xml, and json.

Known issues

If several resources use the same path with different PATH parameters, ReadyAPI cannot distinguish between them. As a result, you can use only the first resource in the list and cannot switch to another one. This does not affect requests, it affects only the way they are represented in the UI.

HEADER parameters are added as part of the HTTP header of a request.

Header parameters

Click the image to enlarge it.

Here is how the HEADER parameter looks like on the Raw request tab.

The Raw tab

Click the image to enlarge it.

MATRIX parameters are added to the resource path before the query string.

MATRIX parameters

Click the image to enlarge it.

Here is how the MATRIX parameter looks like on the Raw request tab.

The Raw tab

Click the image to enlarge it.

PLAIN parameters are defined in a request and can be accessed in ReadyAPI, but are omitted when the request is sent.

PLAIN parameters

Click the image to enlarge it.

When a request is sent, its PLAIN parameter is omitted. See the Raw tab below.

The Raw tab

Click the image to enlarge it.

See Also

Working With REST Parameters
Parameter Settings

Highlight search results