skip to main content
Connection property descriptions : Sample
  

Try DataDirect Drivers Now

Sample

Purpose

Specifies the endpoint that the driver connects to and samples. This property 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 property, you must create an input REST file and specify its location with the Config property:
*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. For example, https://example.com/countries/.

Notes

*The Table connection property allows you to determine the name of the table the specified endpoint maps to. If you do not provide a table name, the driver will determine the name based on the name of the endpoint.
*When using the Sample property, the driver maps endpoints that consist of only a host name to the URL_ parent table by default. You can specify a different table name using the Table property.

Data Source Method

setSample

Default

None

Data Type

String

See Also

*Config
*Table
*Required properties