Adding and Editing Query Parameters

Query parameters are appended to the operation URL with a question mark. For example, in /items?id=###, the Query parameter is id and parameter value is ###.

Adding Query Parameters

To add Query parameters, complete these steps:

  1. In the right URL Parameters section, click Query parameter.
  2. In the Name field, enter a parameter name. Ensure that the parameter name is unique.
  3. From the data type list, select a data type for the parameter. By default, the data type is string.
  4. (Optional) Select the array check box if the parameter is array.
  5. (Optional) In the Description field, enter a description for the added parameter.
  6. (Optional) In the Default value field, enter a default value.
  7. Select the Required check box if the parameter is required. The required parameter is displayed in bold.
  8. Click Create.

Editing Query Parameters

To edit an added Query parameter, complete these steps:

  1. In the right URL Parameters section, move the mouse pointer over the Query parameter.
  2. Click Edit to edit the Query parameter or click to delete the Query parameter.