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

Video doesn't load? Watch this video on YouTube.

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.

List columns 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:

    Drag Data Flow Task onto Control Flow to use SSIS PowerPack Data Flow components

  4. Make sure you are in the Data Flow Task designer:

    Make sure you are in Data Flow designer in SSIS package

  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:

    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:

    API Source - 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
    OData Connector Selection

  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
    ZappySys Http Connection
    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.
    ZappySys Http Connection
    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
    ZappySys Http Connection
    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
    ZappySys Http Connection
    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
    ZappySys Http Connection
    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
    ZappySys OAuth Connection
    Find full details in the OData Connector authentication reference.

  9. Select List Columns endpoint 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
    List Columns
    Optional Parameters
    TableName *
    SSIS API Source - Read from table or endpoint

  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)

    Execute Package - Reading data from OData and load into target

OData Connector actions

Need another use case? Pick the next OData action in SSIS below.

Conclusion

You now know how to list columns 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:

Download SSIS PowerPack
Chat with an Expert