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.
If you simulate submitting HTML forms, use the POST method and add a query to the message body.
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.
PATH parameters are used to parametrize the request path. They add a placeholder populated with values from the specified options.
The Form editor displays the extra data added for the parameter as a drop-down list.
Here, the format is displayed as a drop-down list with the following options: csv, xml, and json.
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.
Here is how the
HEADER parameter looks like on the Raw request tab.
MATRIX parameters are added to the resource path before the query string.
Here is how the
MATRIX parameter looks like on the Raw request tab.
PLAIN parameters are defined in a request and can be accessed in ReadyAPI, but are omitted when the request is sent.
When a request is sent, its
PLAIN parameter is omitted. See the Raw tab below.