Description of the illustration rest_ruleset.png

This image displays the Rules page of the REST Connector API wizard where you have the option to define endpoints for the connector API. The New Rule button appears at the top of the image and below it is a banner describing the rule being defined. Click X in the banner to delete the rule. Below the banner are the Default Parameters, Resource, and HTTP Methods sections.

The Default Parameters section shows two parameters, origin and destination, that have been defined. After the title, Default Parameter, is information text telling you that the parameters will be included when the rule is triggered. After the text is the Add Parameter button. Below the section title is the Delete Parameter (X) button is followed by the Parameter Type selection list. This image shows Query as both parameter types. Next to the selection field is the parameter name text field followed by the parameter value text field. The example value is los angeles.

An identical set of parameters fields appears below that defines the destination parameter with a value of seattle.

The Resource section appears below the parameters. After the section title is information text telling you the rule applies to this resource and any child resource. Below the title is the Remote URL text field. A help icon appears before the field. The sample value for the field is https://maps.googleapis.com/maps/api/directions where the base URL appears shaded and the actual text entry is directions. A checkbox appears below the text field giving you the option of applying the rule only to the resource and not to its child resources.

The HTTP Methods section follows and informational text tells which selected methods will trigger the rule. Below the text is a series of checkboxes that allow you to select one or more of the following methods: GET, PUT, POST, DELETE, PATCH, HEAD, OPTIONS.

The functions of these sections and the fields within them are described in the surrounding text.