skip to main content
Hybrid Data Pipeline API reference : Management API : Driver Files API
  

Try Now

Driver Files API

The Driver Files API is an extension of the Data Sources API. The Driver Files API can be used for the following purposes.
*Export schema map files for non-relational data sources
*Manage input and output REST files for REST data sources

Export schema map files for non-relational data sources

When initially connecting to a data source for a non-relational data store such as Salesforce, the connectivity service creates a pair of schema map files. These files include the native file and the config file. The native file is an XML file that describes the object model of a non-relational data store. The config file is an XML file that exposes the object model as a set of relational tables with rows and columns. Together these files support SQL queries to non-relational data stores. These files can be useful in developing valid SQL statements and in troubleshooting issues that may arise when querying non-relational data stores. The following operations allow you to export these files.
Note: The Driver Files API cannot be used to retrieve files when the On-Premises Connector is used to connect to a web service (or non-relational data store) such as Salesforce.
Task
Request
URL
GET
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles
GET
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/config
GET
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/native

Manage input and output REST files for REST data sources

A Hybrid Data Pipeline REST data source can be created by way of the Autonomous REST Connector data store. A REST data source must include the specification REST endpoints either via the Web UI or by uploading an input REST file. The input REST file is a JSON file which specifies one or more REST endpoints in the form of a JSON object (see Creating an input REST file for syntax requirements). The input REST file can be retrieved and managed using API requests listed in the table below.
When initially connecting to a REST endpoint, Hybrid Data Pipeline uses the input REST file to build a relational model of the REST data. This model is used to translate and execute SQL queries against the REST service, and it is available in the form of the output REST file. Therefore, a review of the output REST file may be useful for developing an input REST file and creating better SQL queries. The output REST file cannot be edited directly. Note that an initial connection to the REST service must be made before the output REST file is available.
Note: For an overview on REST connectivity, see Creating and using REST data sources.
Task
Request
URL
GET
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/inputrest
POST
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/inputrest
PUT
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/inputrest
GET
https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/outputrest
* Export driver files for data source
* Export config files for data source
* Export native file for data source
* Get input REST file
* Upload input REST file
* Update input REST file
* Get output REST file