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]

   
   Configuring authentication parameters
   

   OData

   No Authentication [Http]

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

   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    Windows Authentication [Http]

   
   Configuring authentication parameters
   

   OData

   Windows Authentication [Http]

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

   This Authentication Type has no parameters to fill-in.

   

    Basic Authentication [Http]

   
   Configuring authentication parameters
   

   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	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    NTLM Authentication [Http]

   
   Configuring authentication parameters
   

   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	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    Token Authentication [Http]

   
   Configuring authentication parameters
   

   OData

   Token Authentication [Http]

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

   Required Parameters
   Token	Fill-in the parameter...
   Optional Parameters
   AuthScheme	Bearer
   AuthHeader	Authorization
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    OAuth Connection for OData API [OAuth]

   
   Configuring authentication parameters
   

   OData

   OAuth Connection for OData API [OAuth]

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

   Optional Parameters
   GrantType	Default
   OAuthVersion	Default
   ClientId
   ClientSecret
   UserName
   Password
   Scope
   AuthUrl	https://some-domain.com/api/auth
   TokenUrl	https://some-domain.com/api/token
   ReturnUrl	https://zappysys.com/oauth
   ExtraAttributesForTokenRequest
   ExtraAttributesForAuthRequest
   DoNotIncludeCredentialsInHeader
   DoNotIncludeCredentialsInBody
   RenewBeforeSec
   ExtraHeaders (e.g. x-hdr1:AAA||x-hdr2:BBB)
   ContentType
   EnableCodeVerifier
   RemoveAuthHeader
   CustomAuthHeader
   CustomTokenPrefix
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

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)