OData Connector
OData Connector Help
Version 2
ZappySys Logo File Version: v2
Supported Engine: v1 or higher

Write data in OData using OData Connector in SSIS


In this section we will learn how to configure and use OData Connector in the API Destination to write data in the OData.

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.

    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...
    ZappySys Http Connection
    OData
    Windows Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ZappySys Http Connection
    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...
    ZappySys Http Connection
    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...
    ZappySys Http Connection
    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...
    ZappySys Http Connection
    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...
    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