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

In this section we will learn how to configure and use OData Connector in API Source to extract data from 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 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
   
   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.
   

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

6. Select New Connection to create a 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

   

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
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...
   IgnoreSSLCertificateErrors	Fill in the parameter...
   SslVersion	Fill in the parameter...

   

    Windows Authentication [Http]

   OData

   Windows Authentication [Http]

   https://services.odata.org/V3/Northwind/Northwind.svc

   Required Parameters
   Optional Parameters

   

    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...
   IgnoreSSLCertificateErrors	Fill in the parameter...
   SslVersion	Fill in the parameter...

   

    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...
   IgnoreSSLCertificateErrors	Fill in the parameter...
   SslVersion	Fill in the parameter...

   

    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...
   IgnoreSSLCertificateErrors	Fill in the parameter...
   SslVersion	Fill in the parameter...

   

    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...
   IgnoreSSLCertificateErrors	Fill in the parameter...
   SslVersion	Fill in the parameter...

   

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.

   

10. That's it! We are done! Just in a few clicks we configured the call to OData using OData Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)