REST resource asset

Select the method of requests made by the REST resource. The methods available are as follows:

This allows you to make a GET request. This method is used to retrieve and list the content of a resource.

This allows you to make a POST request. This method is used to create and modify the content of a resource (for example, adding data to a field on a custom form). Selecting this request method and selecting Save will display the following additional configuration options:

This allows you to make a HEAD request. This method is used to retrieve information from an object, such as its update status, without downloading it.

This allows you to make a PUT request. This method is used to update and replace the content of a resource. Selecting this request method will display the Request body field.

This allows you to make a DELETE request. This method is used to delete the content of a resource. By default, this field is set to GET.

Select whether to use HTTP 1.0 for the HTTP request instead of the default HTTP 1.1. This is useful when dealing with advanced configurations with older proxy servers that do not fully support HTTP 1.1.

Select whether to cache POST requests made by the REST resource. POST requests are usually independent operations that will cause a different outcome with each subsequent use. Be careful when using cache so that POST operations are not unexpectedly repeated. Repeating POST operations may have undesirable results. This field is only available when making a POST request.

Enter the URL(s) of the REST web services with which you want to communicate. Any number of URLs can be entered in these fields.

Enter the amount of time in seconds that the REST resource will attempt to communicate with the selected REST web services before returning an error. This field is set to 10 seconds by default.

Select whether the request will follow any URL redirection set by the selected URL(s). For example, say the site HTTP://www.example.com redirects to http://www.newexample.com. If this field is selected and the REST resource is set to communicate with the example URL, the request will be redirected to the newexample URL. By default, this field is enabled.

Select whether to disable SSL certificate verification on HTTP requests. This can be useful in cases where the requesting host is using self-signed certificate verification. By default, this field is disabled, meaning SSL certificate verification will be used.

Enter the file path of the SSL certificate for SSL verification.

Enter the file path of the private key for SSL verification.

Enter the file path of the certificate authority file for SSL verification.

Select how requests made by the REST resource will be cached. By default, this field is set to use HTTP expiry headers. The options available are as follows:

Enter the amount of time in seconds that the REST resource will be cached before expiring. This field is only used if the cache options field is set to Use default expiry. By default, this field is set to 60 seconds.

Select the authentication type that will be used to access the requested URL. This will allow access to secure REST web services. The options available are as follows:

Assemble additional headers to send as the header of the request.

Assemble additional parameters to send as the body of the request. For example, you could set query parameters on a post request using the example request body shown below.

Query=`%globals_get_query^uppercase%&query1=%globals_get_query1^lowercase%`

Select this option to convert the response body to UTF-8 (8-bit Unicode Transformation Format) character encoding. Activate the option and then click Save. The Document encoding field appears.

Select this field to enable query strings passed on the URL of the REST resource to be appended on the URL of the HTTP request.

Select this field to forward user information on the HTTP request. This information can be useful when performing permission checks on the REST web service.

Select this field and select Save to run a request test. Sample return code will be displayed in this field, similar to what is shown in the figure.

Select whether keyword replacements should be replaced in the REST response. If this option is enabled, Matrix will identify and replace content in the keyword format (wrapped in percent signs). By default, this field is set to No, meaning that this option is disabled.

Select whether multiple runs will be allowed if the REST resource asset is nested more than once on the same page.

Select whether to forward headers from the REST response. This allows you to pass through objects of an unknown type without alteration. By default, this field is set to No.

Enter the content that will be displayed if the request returns a client (4xx) or server (5xx) error code. For example, say you have entered the text, this web service cannot be contacted into this field. This error message will be displayed if the REST web service URL returns a client or server error.