Applies to ReadyAPI 2.6, last modified on January 15, 2019

You use the Request section of the Request editor to configure REST request parameters.

Parameter Editor

You modify and configure request parameters in the Parameter editor.

The Parameter editor

Click the image to enlarge it.

The editor lists request parameters in a tabular form. The table has the following columns:

Column Description

Name

A parameter name. You can use the Get Data dialog and property expansion to enter a value.

Value

A parameter value. You can use the Get Data dialog and property expansion to enter a value.

Type

Sets a parameter type.
Possible values: QUERY, TEMPLATE, HEADER, MATRIX, PLAIN.

Parameter editor toolbar

The editor has a toolbar with the following commands:

Command Description

Add

Adds a new parameter to the table.

Remove

Removes the selected parameter from the table.

Update

Updates the selected parameter from the specified URL.

Revert

Sets default values to all current parameters.

Up

Moves the selected parameter one row up.

Down

Moves the selected parameter one row down.

Advanced options

Using advanced options you can define values to be displayed in the Form panel, disable encoding of a parameter value, or make sure the correct parameter type is used in generated WADLs.

To show them, open the Advanced options panel below the parameters table:

ReadyAPI: Advanced settings for REST parameters

Click the image to enlarge it.

Option Description

Level

Sets a parameter level.
Possible values: RESOURCE, METHOD.

Required

Sets the selected parameter as a required one.

Type

Sets the XMLSchema parameter type.

Options

Lists options to be used in the request Form panel.

Description

A parameter description.

Disable encoding

Disables the URL-encoding of a parameter value.

Content Editor

The Content editor is shown if a request uses an HTTP method that sends the request body (for example POST or PUT).

The JSON request

Click the image to enlarge it.

The editor has a toolbar with the following commands:

Command Description

Media Type

The media type of the request body. You can select one of the values from the drop-down list or enter your own value.

Recreate

Create a new message by using the specified schema or representation.
ReadyAPI uses the request or an XML Schema definition for the application/xml media type, and the representation for other requests. If neither is available, the button is disabled.

Post Query String

If selected, the request puts data to the query string instead of the message body.

Simulating HTML Forms

A good way to simulate an HTML form submission is to use the Query String option:

  1. Create a REST request with the POST or PUT method.

  2. Select the Post Query String check box.

This will make ReadyAPI send parameters in the message body.

Importing the Message Body From a File

If you want to import the message body from a file:

The Attachments editor

Click the image to enlarge it.

  1. Leave the Content editor empty.

  2. Add a single attachment with the same media-type as the message.

This will insert the file content into the message body instead of attaching it as a MIME attachment.

See Also

Raw Panel
Outline Panel
Form Panel
Request Interface Overview

Highlight search results