SSIS OData Connector

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.
You can use this connector to integrate REST API data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

See also
OData Connector Connect OData in SQL Server SQL Server
Connect OData in SQL Server
OData Connector Connect OData in Power BI Power BI
Connect OData in Power BI
OData Connector Connect OData in SSRS SSRS
Connect OData in SSRS
OData Connector Connect OData in Informatica Informatica
Connect OData in Informatica
OData Connector Connect OData in MS Access MS Access
Connect OData in MS Access
OData Connector Connect OData in MS Excel MS Excel
Connect OData in MS Excel
OData Connector Connect OData in SSAS SSAS
Connect OData in SSAS
OData Connector Connect OData in C# C#
Connect OData in C#
OData Connector Connect OData in Python Python
Connect OData in Python
OData Connector Connect OData in JAVA JAVA
Connect OData in JAVA
OData Connector Connect OData in Tableau Tableau
Connect OData in Tableau
OData Connector Connect OData in SAP Crystal Reports SAP Crystal Reports
Connect OData in SAP Crystal Reports
OData Connector Connect OData in Azure Data Factory (ADF) Azure Data Factory (ADF)
Connect OData in Azure Data Factory (ADF)
OData Connector Connect OData in ODBC ODBC
Connect OData in ODBC

Video Tutorial - Integrate OData data in SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for OData integration in SSIS
  • How to configure connection for OData
  • Features about API Source (Authentication / Query Language / Examples / Driver UI)
  • Using OData Connection in SSIS

Prerequisites

Before we perform steps listed in this article, you will need to make sure following prerequisites are met:
  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
  4. Optional (If you want to Deploy and Schedule ) - Deploy and Schedule SSIS Packages

How to read data from OData in SSIS (Export data)

In this section we will learn how to configure and use OData Connector in the API Source to extract data from the OData.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen 
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and drop API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled OData Connector from Popular Connector List or press Search Online radio button to download OData Connector. Once downloaded simply use it in the configuration:

    OData
    OData Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

     No Authentication [Http]

    OData
    No Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ZappySys Http Connection

     Windows Authentication [Http]

    OData
    Windows Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ZappySys Http Connection

     Basic Authentication [Http]

    OData
    Basic Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

     NTLM Authentication [Http]

    OData
    NTLM Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName (i.e. Domain\UserName) Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

     Token Authentication [Http]

    OData
    Token Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Token Fill in the parameter...
    Optional Parameters
    AuthScheme Fill in the parameter...
    AuthHeader Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

     OAuth Connection for OData API [OAuth]

    OData
    OAuth Connection for OData API [OAuth]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    GrantType Fill in the parameter...
    OAuthVersion Fill in the parameter...
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    UserName Fill in the parameter...
    Password Fill in the parameter...
    Scope Fill in the parameter...
    AuthUrl Fill in the parameter...
    TokenUrl Fill in the parameter...
    ReturnUrl Fill in the parameter...
    ExtraAttributesForTokenRequest Fill in the parameter...
    ExtraAttributesForAuthRequest Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - 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.
    API Source - Select Endpoint

  10. That's it; we are done. In a few clicks we configured the call to OData using ZappySys OData Connector

Load OData data in SQL Server using Upsert Destination (Insert or Update)

Once you read data from the desired source, now let's see how to Load OData data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.

  1. From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface

  2. Connect our Source component to Upsert Destination

  3. Double click on Upsert Destination component to configure it.

  4. Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

  5. Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
    SSIS SQL Upsert option

  6. Click on OK to save Upsert Destination settings UI.

  7. That's it; we are done. Run the SSIS Package and it will read the data from the OData and load the the data in the SQL Server/PostgreSql/Redshift.

Video Tutorial - Write or lookup data to OData using SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for OData integration in SSIS
  • How to configure connection for OData
  • How to Write or lookup data to OData
  • Features about SSIS API Destination
  • Using OData Connector in SSIS

How to write or lookup data to OData in SSIS (Import data)

In upper section we learned how to read data, now in this section we will learn how to configure OData in the API Source to Post data to the OData.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - 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.
    API Destination - New Connection

  4. Use a preinstalled OData Connector from Popular Connector List or press Search Online radio button to download OData Connector. Once downloaded simply use it in the configuration:

    OData
    OData Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

     No Authentication [Http]

    OData
    No Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ZappySys Http Connection

     Windows Authentication [Http]

    OData
    Windows Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ZappySys Http Connection

     Basic Authentication [Http]

    OData
    Basic Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

     NTLM Authentication [Http]

    OData
    NTLM Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName (i.e. Domain\UserName) Fill in the parameter...
    Password Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

     Token Authentication [Http]

    OData
    Token Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Token Fill in the parameter...
    Optional Parameters
    AuthScheme Fill in the parameter...
    AuthHeader Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

     OAuth Connection for OData API [OAuth]

    OData
    OAuth Connection for OData API [OAuth]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    GrantType Fill in the parameter...
    OAuthVersion Fill in the parameter...
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    UserName Fill in the parameter...
    Password Fill in the parameter...
    Scope Fill in the parameter...
    AuthUrl Fill in the parameter...
    TokenUrl Fill in the parameter...
    ReturnUrl Fill in the parameter...
    ExtraAttributesForTokenRequest Fill in the parameter...
    ExtraAttributesForAuthRequest Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - 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.
    API Destination - Select Endpoint

  7. Finally, map the the desired columns:

    API Destination - 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.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the OData API call using ZappySys OData Connector

Conclusion

In this article we discussed how to connect to OData in SSIS and integrate data without any coding. Click here to Download OData Connector for SSIS 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 Connector 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

OData Connector for SQL Server
SQL Server
OData Connector for Power BI
Power BI
OData Connector for SSRS
SSRS
OData Connector for Informatica
Informatica
OData Connector for MS Access
MS Access
OData Connector for MS Excel
MS Excel
OData Connector for SSAS
SSAS
OData Connector for C#
C#
OData Connector for Python
Python
OData Connector for JAVA
JAVA
OData Connector for Tableau
Tableau
OData Connector for SAP Crystal Reports
SAP Crystal Reports
OData Connector for Azure Data Factory (ADF)
Azure Data Factory (ADF)
OData Connector for ODBC
ODBC

Other Connectors for SSIS

Zendesk Connector
Zendesk
ManagedEngine ServiceDesk Plus (Zoho) Connector
ManagedEngine ServiceDesk Plus (Zoho)
Zoho CRM Connector
Zoho CRM
Hubspot Connector
Hubspot
Google Sheets Connector
Google Sheets
Stripe Connector
Stripe
YouTube Connector
YouTube
Google BigQuery Connector
Google BigQuery
OneDrive Connector
OneDrive
OData Connector
OData
Amazon Ads Connector
Amazon Ads
Jira Connector
Jira
Zoom Connector
Zoom
Nativo Connector
Nativo
Google Drive Connector
Google Drive
SharePoint Online Connector
SharePoint Online
Amazon MWS Connector
Amazon MWS
ElasticSearch Connector
ElasticSearch
Google Calendar Connector
Google Calendar
DropBox Connector
DropBox
REST API Connector
REST API
JSON Connector
JSON
JSON File Connector
JSON File
XML Connector
XML
SOAP Connector
SOAP
XML File Connector
XML File
JDBC-ODBC Bridge Connector
JDBC-ODBC Bridge
Salesforce Connector
Salesforce
CSV Connector
CSV


Documentation 

  • How to connect OData in SSIS?

  • How to get OData data in SSIS?

  • How to read OData data in SSIS?

  • How to load OData data in SSIS?

  • How to import OData data in SSIS?

  • How to pull OData data in SSIS?

  • How to push data to OData in SSIS?

  • How to write data to OData in SSIS?

  • How to POST data to OData in SSIS?

  • Call OData API in SSIS

  • Consume OData API in SSIS

  • OData SSIS Automate

  • OData SSIS Integration

  • Integration OData in SSIS

  • Consume real-time OData data in SSIS

  • Consume realtime OData API data in SSIS

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

  • Connect OData in SSIS

  • Load OData in SSIS

  • Load OData data in SSIS

  • Read OData data in SSIS

  • OData API Call in SSIS