API v1 - Driver

API v1 - Driver


Overview

This is a guide to providing details on the Driver API services offered by Matillion ETL. These services provides the list of Drivers available within the Matillion ETL instance. The Driver API endpoint is of singular function usable only by users running an Matillion ETL instance.

Driver API provides the "resource" data (“Resources” refers to the information returned by an API). These resources usually have various endpoints which are combined with multiple HTTP methods for each endpoint. Driver API endpoint uses only GET method to retrive the data within the Matillion ETL instance.

Important Information

  • Users responsible for experimenting with Matillion ETL API services require access to the Matillion ETL instance and ought to know how to make REST API calls either employing a REST API GUI client such as Postman or employing a command-line interface like cURL.
  • For more information about accessing the Matillion API, and general information on the Matillion API platform before using the API, please refer to Matillion ETL API - v1.
  • Matillion ETL API endpoints require authorisation to make any REST API call, so ensure a username and password for the Matillion ETL instance is configured before making any API call.

API Endpoints and Function

Driver API is available on standard REST-based APIs that uses HTTP or HTTPS request to GET data. The Driver API service is accessed through the Uniform Resource Identifier (URI). The Driver API has one PATH /driver to retrieve the information available within the instance.

Below is the description of the endpoint with example.

PATH /driver

In the example below, we will be retrieving multiple resource information, perform a GET request for the resource endpoint. The endpoint will retrieve the list of drivers within the instance. The information will include the "drivername", "group", "fillfilepath", and "filename".

  • Base URL
    http://<InstanceAddress>/rest/v1/driver
  • Server Response
    [
      {
        "driverName": "Oracle",
        "files": [
          {
            "group": "<groupname>",
            "fullFilePath": "<file path>",
            "fileName": "<file name>"
          }
        ]
      },
      {
        "driverName": "SAPHana",
        "files": []
      },
      {
        "driverName": "SQL Server (Microsoft Driver)",
        "files": []
      },
      {
        "driverName": "MySQL",
        "files": []
      }
    ]
    
  • Below is the description of the fields included in the Server Response of Driver JSON body:

    Field Name Description
    <driverName> The name of the driver.
    <group> The group name to which driver belong to.
    <fullFilePath> The file or directory for which to obtain absolute path information.
    <fileName> The name of the file given.