Video tutorial

Watch this quick video to see the integration in action. It walks you through the end-to-end setup, including:

• Installing the SSIS PowerPack
• Configuring a secure connection to OData
• Working with OData data directly inside SSIS
• Exploring advanced API Source features

Once you are done watching, simply follow the step-by-step written guide below to configure your data source.

Prerequisites

Before we begin, make sure the following prerequisites are met:

1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Make generic REST API request in SSIS

1. Open Visual Studio and click Create a new project.

2. Select Integration Services Project. Enter a name and location for your project, then click OK.

3. From the SSIS Toolbox, drag and drop a Data Flow Task onto the Control Flow surface, and double-click it:

   

4. Make sure you are in the Data Flow Task 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. Select your authentication scenario below to expand connection configuration steps to:

   • Configure the authentication in OData.
   • Enter those details into the API Connection Manager configuration.

   No Authentication

   OData authentication

   No instructions available.

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to No Authentication [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   OData

   No Authentication [Http]

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

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

   

   Find full details in the OData Connector authentication reference.

   Windows Authentication

   OData authentication

   No instructions available.

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to Windows Authentication [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   OData

   Windows Authentication [Http]

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

   There are no parameters to configure.

   

   Find full details in the OData Connector authentication reference.

   Basic Authentication

   OData authentication

   No instructions available.

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to Basic Authentication [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   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

   

   Find full details in the OData Connector authentication reference.

   NTLM Authentication

   OData authentication

   No instructions available.

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to NTLM Authentication [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   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

   

   Find full details in the OData Connector authentication reference.

   Token Authentication

   OData authentication

   No instructions available.

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to Token Authentication [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   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

   

   Find full details in the OData Connector authentication reference.

   OAuth Connection for OData API

   OData authentication

   No instructions available.

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to OAuth Connection for OData API [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Press Generate Token button to generate the tokens.
   5. Finally, hit OK button:

   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

   

   Find full details in the OData Connector authentication reference.

9. Select Generic Table (Bulk Read / Write) table from the dropdown and hit Preview Data:

   

   API Source - OData

   Read and write OData API data effortlessly. Query, integrate, and manage entities and feeds — almost no coding required.

   OData

   Generic Table (Bulk Read / Write)

   Required Parameters
   HTTP - Url or File Path	Fill-in the parameter...
   HTTP - Request Method	Fill-in the parameter...
   Optional Parameters
   HTTP - Request Body
   HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
   HTTP - Request Format (Content-Type)	ApplicationJson
   HTTP - Headers (e.g. hdr1:aaa || hdr2:bbb)	Accept: */* || Cache-Control: no-cache
   Parser - Response Format (Default=Json)	Default
   Parser - Filter (e.g. $.rows[*] )
   Parser - Encoding
   Parser - CharacterSet
   Download - Enable reading binary data	False
   Download - File overwrite mode	AlwaysOverwrite
   Download - Save file path
   Download - Enable raw output mode as single row	False
   Download - Raw output data RowTemplate	{Status:'Downloaded'}
   Download - Request Timeout (Milliseconds)
   General - Enable Custom Search/Replace
   General - SearchFor (e.g. (\d)-(\d)--regex)
   General - ReplaceWith (e.g. $1-***)
   General - File Compression Type
   General - Date Format
   General - Enable Big Number Handling	False
   General - Wait time (Ms) - Helps to slow down pagination (Use for throttling)	0
   JSON/XML - ExcludedProperties (e.g. meta,info)
   JSON/XML - Flatten Small Array (Not preferred for more than 10 items)
   JSON/XML - Max Array Items To Flatten	10
   JSON/XML - Array Transform Type
   JSON/XML - Array Transform Column Name Filter
   JSON/XML - Array Transform Row Value Filter
   JSON/XML - Array Transform Enable Custom Columns
   JSON/XML - Enable Pivot Transform
   JSON/XML - Array Transform Custom Columns
   JSON/XML - Pivot Path Replace With
   JSON/XML - Enable Pivot Path Search Replace	False
   JSON/XML - Pivot Path Search For
   JSON/XML - Include Pivot Path	False
   JSON/XML - Throw Error When No Match for Filter	False
   JSON/XML - Parent Column Prefix
   JSON/XML - Include Parent When Child Null	False
   Pagination - Mode
   Pagination - Attribute Name (e.g. page)
   Pagination - Increment By (e.g. 100)	1
   Pagination - Expression for Next URL (e.g. $.nextUrl)
   Pagination - Wait time after each request (milliseconds)	0
   Pagination - Max Rows Expr
   Pagination - Max Pages Expr
   Pagination - Max Rows DataPath Expr
   Pagination - Max Pages	0
   Pagination - End Rules
   Pagination - Next URL Suffix
   Pagination - Next URL End Indicator
   Pagination - Stop Indicator Expr
   Pagination - Current Page
   Pagination - End Strategy Type	DetectBasedOnRecordCount
   Pagination - Stop based on this Response StatusCode
   Pagination - When EndStrategy Condition Equals	True
   Pagination - Max Response Bytes	0
   Pagination - Min Response Bytes	0
   Pagination - Error String Match
   Pagination - Enable Page Token in Body	False
   Pagination - Placeholders (e.g. {page})
   Pagination - Has Different NextPage Info	False
   Pagination - First Page Body Part
   Pagination - Next Page Body Part
   Csv - Column Delimiter	,
   Csv - Has Header Row	True
   Csv - Throw error when column count mismatch	False
   Csv - Throw error when no record found	False
   Csv - Allow comments (i.e. line starts with # treat as comment and skip line)	False
   Csv - Comment Character	#
   Csv - Skip rows	0
   Csv - Ignore Blank Lines	True
   Csv - Skip Empty Records	False
   Csv - Skip Header Comment Rows	0
   Csv - Trim Headers	False
   Csv - Trim Fields	False
   Csv - Ignore Quotes	False
   Csv - Treat Any Blank Value As Null	False
   Xml - ElementsToTreatAsArray

   

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)

    

Conclusion

And there you have it — a complete guide on how to make generic REST API request in SSIS without writing complex code. All of this was powered by OData Connector, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

More actions supported by OData Connector

Got another use case in mind? We've documented the exact setups for a variety of essential OData operations directly in SSIS, so you can skip the trial and error. Find your next step-by-step guide below:

• Generic Read Data (JSON API)
• Generic Read Data (XML API)
• List Columns
• List Tables
• List Tables (JSON API)
• List Tables (XML API)
• Read [Dynamic Endpoint]
• Make Generic REST API Request (Bulk Write)

More OData integrations