OData Connector for SSIS : Make generic REST API request (bulk write)

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

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Prerequisites

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

1. SQL Server Data Tools (SSDT) designer installed for Visual Studio.
2. SQL Server Integration Services Projects 2022+ Visual Studio extension installed.
3. SSIS PowerPack is installed.

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. Read the data from the source, using any desired source component. You can even make an API call using the ZappySys JSON/XML/API Source and read data from there. In this example, we will use an OLE DB Source component to read real-time data from a SQL Server database.

6. 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.
   

7. Select New Connection to create a new connection:
   

   API Destination - OData

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

   

8. To configure the OData connector, choose one of the following methods:

   • Choose from Popular Connector List: Select a pre-installed service directly from the dropdown menu.
   • Search Online: Use this to find and download a new connector file to your computer.
   • Use Saved/Downloaded File: Once the file is downloaded, browse your local drive to load it into the configuration.

   After that, just click Continue >>:

   OData

   

9. 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

   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.

10. Select Generic Table (Bulk Read / Write) table from the dropdown, then select Insert, Update as operation, and hit Preview Data:

    

    API Destination - 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)

    Insert, Update

    Required Parameters
    Url	Fill-in the parameter...
    Request Method	Fill-in the parameter...
    Optional Parameters
    IsMultiPart
    Filter
    Request Format (Content-Type)	Default
    Body	{$rows$}
    JsonOutputFormat	Multicontent
    DoNotOutputNullProperty
    Batch Size (Default=1)	1
    Meta Detection Order	StaticDynamicVirtual
    Input Columns - For Mapping (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
    Output Columns (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
    Request Format
    Response Format	Default
    Headers	Accept: */* || Cache-Control: no-cache
    Csv - Column Delimiter	,
    Csv - Row Delimiter	{NEWLINE}
    Csv - Quote Around Value	True
    Csv - Always Quote regardless type
    Encoding
    CharacterSet
    Writer DateTime Format
    Csv - Has Header Row	True
    Xml - ElementsToTreatAsArray
    Layout Map	<?xml version="1.0" encoding="utf-8"?> <!-- Example#1: Output all columns --> <settings> <dataset id="root" main="True" readfrominput="True" /> <map src="*" /> </settings> <!-- Example#2: Records under array <?xml version="1.0" encoding="utf-8"?> <settings singledataset="True"> <dataset id="root" main="True" readfrominput="True" /> <map name="MyArray" dataset="root" maptype="DocArray"> <map src="OrderID" name="OrderID" /> <map src="OrderDate" name="OrderDate" /> </map> </settings> --> <!-- Example#3: Records under nested section <?xml version="1.0" encoding="utf-8"?> <settings> <dataset id="dsRoot" main="True" readfrominput="True" /> <map name="NestedSection"> <map src="OrderID" name="OrderID_MyLabel" /> <map src="OrderDate" name="OrderDate_MyLabel" /> </map> </settings> -->

    

11. Finally, map the desired columns:

    API Destination - OData

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

    

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

    

OData Connector actions

Need another use case? Pick the next OData action in SSIS 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

Conclusion

You now know how to make generic REST API request (bulk write) in SSIS without writing complex code. OData Connector handled pagination and authentication automatically.

Ready to get started? Download the trial or ping us via chat if you need help: