Resource Parameters Page

Applies to ReadyAPI 3.9, last modified on July 30, 2021

On the Parameters page, you can modify and configure parameters for a REST Resource.

To open the Parameters page, select a resource in the Navigator and switch to the Parameters page.

REST Resource Parameters

Click the image to enlarge it.

Toolbar

The toolbar of the page includes the following commands:

  • – Adds a new resource parameter.

  • – Deletes a resource parameter.

  • – Updates resource parameters from a URL.

  • – Moves the selected parameter in the parameter table one row down.

  • – Moves the selected parameter in the parameter table one row up.

Parameter Table

The Parameters page table lists the following parameters:

Parameter Description

Name

The parameter name. You can use property expansions in this field.

Value

The parameter value. You can use property expansions in this field.

Style

The parameter style.

Possible values: QUERY, TEMPLATE, HEADER, MATRIX, PLAIN.

Adding Parameters

To add a parameter to a resource:

  1. Click on the toolbar.

  2. In the table, enter a parameter name and value, and then select a style.

Deleting Parameters

To delete a resource parameter:

  1. Select a parameter in the table.

  2. Click on the toolbar.

  3. In the follow-up dialog, click Yes.

Updating Parameters

To update resource parameters from a URL:

  1. Click on the toolbar.

  2. In the follow-up dialog, enter the URL to extract parameters from.

  3. Click OK.

Submitting Form Data

If you want to simulate submission of an HTML form using the content-type multipart/form-data, you can specify individual parameter values to be read from a file by setting their value to file: which will insert the file into the outgoing request.

Parameter Options

When you select a parameter in the table, the area of parameter options becomes active.

Parameter Options

Click the image to enlarge it.

Option Description

Required

Makes the parameter required.

Type

Sets the XMLSchema parameter type.

Options

The option list to use in the request form view.

Description

A short description.

Disable encoding

Disables the URL-encoding of a value.

See Also

REST Resource Editors

Highlight search results