Attribute

RESTConfigFile (rcf)

Purpose

Specifies the name and location of the Model file used to define your endpoints for sampling. This file allows you to specify multiple endpoints, define POST requests, and configure paging. You will need to create and specify a Model file if your session:

  • 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 name and location of your Model file. For example, C:\path\to\myrest.rest (Windows) or <home_dir>/path/to/myrest.rest (UNIX/Linux).

Notes

  • 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