Attribute

RESTSamplePath (rsp)

Purpose

Specifies the endpoint that the driver connects to and samples. This option allows you to configure the driver to issue GET requests to a single endpoint without creating a Model file. Note that if your session does any of the following, instead of using this option, you must create a Model file and specify its location with the REST Config File (RESTConfigFile) option:

  • Accesses multiple endpoints
  • Issues POST requests
  • Accesses endpoints that require paging
  • Accesses endpoints that use custom HTTP headers
  • Uses custom HTTP response code processing
  • Requires a custom authentication flow

Valid Values

URI

where:

URI

is the endpoint that you connect to and sample. For example, https://example.com/countries/. Note that the value must be valid URL-encoded syntax. For example, spaces in an endpoint are replaced with %20. See "URL-encoded values" for details.

Notes

  • Specifying an HTTPS endpoint using the REST Sample Path option enables SSL data encryption. See "Data encryption options" for a list of related options.
  • When using the REST Sample Path option, the driver maps endpoints that consist of only a host name to the URL_ parent table by default.
  • In most scenarios, you will configure the REST Config File option, for specifying a Model File, or the REST Sample Path option, for specifying a single endpoint to sample. However, note that these options are not required for all use cases, such as when the driver is being used to execute dynamically created stored procedures or functions.

Default Value

No default value