Request Arguments

This section describes the available request arguments. The following arguments can be used by REST Web service operations.

restUrl

This is the URL of the REST service or resource in the form:
http://server:port/service/resource...

If you are using a custom endpoint, you can select the custom endpoint and map restUrl to the Url parameter in the custom endpoint.

Tip: You can use the custom endpoint for restUrl and the RESTCaller params input to add any required HTTP query string parameters to manipulate or retrieve the resource you want. For an example use case, refer to Using Custom Endpoints with RESTCaller.

options

The options control how the RESTCaller service creates the HTTP request that it sends to the REST service and how it translates the response from the REST service. Not all options apply to all RESTCaller operations as noted for the respective operation. Where the option does not apply, no action is taken.

params

This argument is a list of key-value pairs for query parameters to append to the service or resource URL. The keys and their respective values are appended to the URL after the question mark (?), and are separated by an ampersand (&). For example, given a key (key1) with a value (value1), and another key (key2) with a value (value2), the resulting URL is sent with the request:

http://server:port/service/resource?key1=value1&key2=value2
Tip: You can send empty keys or values if the value should be null or uninitialized. For example:
http://server:port/service/resource?=value1
Or:
http://server:port/service/resource?key1=
However, RESTCaller does not support null key names (values with no preceding key=) like:
http://server:port/service/resource?value1

bodyXML

This argument sets the data for the body of the PUT and POST commands.