Parameters

Parameters can be defined for Resources and Request Templates. They can also added to Requests in the Request Editor, before being sent out.

Parameters are defined by

• Location — One of the following
  • Header — Defines headers, can be attached to all — Resources, Request Templates and Requests.
  • Cookie — Defines cookie headers, can be attached to all.
  • Path — Defines parameters that appear in the Request path, can only be attached to Resources
  • Query — Defines parameters that appear in the query string, can be attached to all.
• Name — The name of the parameter
  • For header parameters, this is the name of the header that will be created
  • For cookie parameters, this is the name of the cookie that will be created
  • For path parameters, this is the same as the {name} that shows up in the corresponding resource name.
  • For query parameters, this is the name of the parameter that will be added to the query string, in the form ?name=value
  • For payload parameters, this is the same as the {name} that shows up in the corresponding text payload.
• Value — This represents a default value for Websites, Resources and Request Templates, and an actual value for Requests.
• If Value Is Empty — The action to take if the value of the parameter is empty
  • Leave the parameter in the request.
  • Drop parameter from the request
  • Generate an Error that prevents the request from being sent.
• Local scope — Flag that indicates that the parameter has local scope
  • It will only be used with Requests created directly from this Resource or Request Templates attached to it.
  • It will not be inherited by subresources.

Last updated on 2023-12-05