skip to main content
Connection Option Descriptions : REST Sample Path
  

Try DataDirect Drivers Now

REST Sample Path

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 an input REST file. Note that if your session does any of the following, instead of using this option, you must create an input REST file and specify its location with the REST Config File 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

string
where:
string
is the endpoint that you want connect to and sample. Values must be enclosed in single quotes or curly braces when used in a connection string. For example, 'https://example.com/countries/'.

Notes

*Specifying an HTTPS endpoint using REST Sample Path 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.

Default

None

GUI Tab

General tab

See Also

*REST Config File
*Summary of Data Encryption Options