Defining Headers and Query Parameters for REST RA Web Service Agent Job Requests

Select the Request > Headers and Query Parameters menu item and define HTTP headers and/or query parameters for REST RA Web Service Agent Jobs. Headers and query parameters can be defined both as defaults for the Connection object, or in individual Jobs. You can edit the values of default Connection object headers in the Job definition, or delete them.

REST RA Web Service Agent Job definitions include all HTTP headers and/or query parameters. Headers and query parameters can be defined both as defaults for the Connection object, or in individual Jobs. You can edit the values of default Connection object headers and/or query parameters in the Job definition, or delete them.

 

Viewing, Editing or Deleting Default Headers/Query Parameters From a Job's Connection Object

Default headers/query parameters that are defined in a Job's Connection object are included in the Headers and/or Query Parameters tables in italics with blue backgrounds. They are read-only, unless the Use Job Headers Only or Use Job Query Parameters Only checkboxes are checked. If one of these checkboxes is checked, all headers or query parameters defined in the Connection object will remain in the table and their backgrounds switch to white like the headers defined for the Job and they will become editable or deletable.

Adding Headers and/or Query Parameters

To add headers or query parameters:

  1. Click the appropriate the add icon.
  2. The RA Web Service Agent opens an Add dialog.
  3. Enter a name in either the Header or Parameter field and a value in the Value field and click OK.

    4. The RA Web Service Agent adds the header to the appropriate box.