ODBC OData API Connector

In this article you will learn, how to integrate OData data to ODBC without coding in few clicks (Live / Bi-directional connection to OData). OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.

Using OData API Connector you will be able to connect, read and write data from within ODBC. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

Create ODBC Data Source (DSN) based on ZappySys API Driver

To get data from OData using ODBC we first need to create a DSN - Data Source - which will access data from OData, which later will be able to get using ODBC. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver:

    Create new API Connection for OData

    You should create System DSN if client application is launched under Windows System Account, e.g. as a Windows Service.
    Launch ODBC Data Sources 32-bit version in case your client application is a 32-bit (x86) application (required only for System DSN).
  4. When a window appears, firstly give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" is not present in the list, then click "Search Online" and download it. Then set the path to the one where you downloaded it. Finally, hit Continue >> button to continue configuring DSN:

    ODataDSN
    OData
    ODBC DSN Template Selection

  5. Another window appears and it's time to configure the Connection Manager. Firstly, select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases default one is the right one). More info is available in Authentication section.

    And finally, fill in all the required parameters and set optional parameters if needed.:

    ODataDSN
    OData
    No Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ODBC DSN HTTP Connection Configuration

  6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>'

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01'

    ZappySys Driver - Execute Custom Store Procedure

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
    "ShipCountry",
    "OrderID",
    "CustomerID",
    "EmployeeID",
    "OrderDate",
    "RequiredDate",
    "ShippedDate",
    "ShipVia",
    "Freight",
    "ShipName",
    "ShipAddress",
    "ShipCity",
    "ShipRegion",
    "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

Conclusion

In this article we discussed how to connect to OData in ODBC and integrate data without any coding. Click here to Download OData Connector for ODBC and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Documentation 

Actions supported by OData Connector

OData Connectors support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 List Tables (JSON API)
 List Tables (XML API)
 Generic Read Data (JSON API)
Parameter Description
TableName Read data from specified module (Json Format API)
 Generic Read Data (XML API)
Parameter Description
TableName Read data from specified module (Xml Format API)
 Read [$parent.name$]
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Other App Integration scenarios for OData

Other API Connectors for ODBC


Documentation 

  • How to connect OData in ODBC?

  • How to get OData data in ODBC?

  • How to read OData data in ODBC?

  • How to load OData data in ODBC?

  • How to import OData data in ODBC?

  • How to pull OData data in ODBC?

  • How to push data to OData in ODBC?

  • How to write data to OData in ODBC?

  • How to POST data to OData in ODBC?

  • Call OData API in ODBC

  • Consume OData API in ODBC

  • OData ODBC Automate

  • OData ODBC Integration

  • Integration OData in ODBC

  • Consume real-time OData data in ODBC

  • Consume realtime OData API data in ODBC

  • OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination

  • Connect OData in ODBC

  • Load OData in ODBC

  • Load OData data in ODBC

  • Read OData data in ODBC

  • OData API Call in ODBC