Setting REST Request Options

Using the REST Adapter, you can overwrite the settings coming from the component diagram dynamically.

Figure: REST Adapter Components

You can do this by

• creating an object of type RequestOptions, ...

• setting the attributes and ...

• providing this to the adapter call.

The figure below shows an example adapter call with request options.

Figure: Setting the Request Options Dynamically

Overview of Request Options Attributes and Elements

AttributeTypeDescriptionValues/ExampleadditionalHeadersArray of HeaderFieldAll REST request header fields as an array of HeaderField classes containing name/value pairs.optionsArray of OptionSpecify native cURL options as listed in (25.3) Setting cURL Options on the URL Adapter .Use one of the following syntax rules:values separated by ',' in one linevalues separated by ' ' in one linelist of tagged valuessslSSLUse this parameter to supply SSL information.proxyProxyUse this parameter to supply necessary proxy information.additionalQueryParametersArray of Parameter Use this parameter to provide additional query parameters to the REST service call.followRedirectsIntegerSpecify here the maximum number of redirects to follow.any integerbasicAuthAuthenticationThis parameter provides an object of type Authentication containing the user and the password.basePathStringOverwrite here the base path of the REST service.a valid path, e.g. /supporthostStringOverwrite here the host running the REST service that has been defined in the component diagram.portIntegerOverwrite here the port through which the REST service is accessible.protocolStringOverwrite here the protocol through which the REST service is accessible.http, httpsignoreHttpErrorsBooleanIf true, HTTP error codes >= 400 will not cause an exception in the model. This implies, that the response body is accessible even if HTTP errors occur. Default value is true.true / falsejsonComposerOptionsComposerOptionsUse this parameter to specify JSON composer options on the REST call. You can use these options to e.g. overwrite jsonKeepNulls from the REST alias.