OData Connector for SSRS

In this article you will learn how to integrate OData data in SSRS without coding in just a few clicks (live / bi-directional connection to 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..

Using OData Connector you will be able to connect, read, and write data from within SSRS. Follow the steps below to see how we would accomplish that.

Download Documentation

Connect to OData in other apps
OData Connector Connect OData in SSIS SSIS
Connect to OData in SSIS
OData Connector Connect OData in SQL Server SQL Server
Connect to OData in SQL Server
OData Connector Connect OData in Power BI Power BI
Connect to OData in Power BI
OData Connector Connect OData in Informatica Informatica
Connect to OData in Informatica
OData Connector Connect OData in MS Access MS Access
Connect to OData in MS Access
OData Connector Connect OData in MS Excel MS Excel
Connect to OData in MS Excel
OData Connector Connect OData in SSAS SSAS
Connect to OData in SSAS
OData Connector Connect OData in C# C#
Connect to OData in C#
OData Connector Connect OData in Python Python
Connect to OData in Python
OData Connector Connect OData in JAVA JAVA
Connect to OData in JAVA
OData Connector Connect OData in Tableau Tableau
Connect to OData in Tableau
OData Connector Connect OData in SAP Crystal Reports SAP Crystal Reports
Connect to OData in SAP Crystal Reports
OData Connector Connect OData in Azure Data Factory (Pipeline) Azure Data Factory (Pipeline)
Connect to OData in Azure Data Factory (Pipeline)
OData Connector Connect OData in Azure Data Factory (SSIS) Azure Data Factory (SSIS)
Connect to OData in Azure Data Factory (SSIS)
OData Connector Connect OData in Talend Studio Talend Studio
Connect to OData in Talend Studio
OData Connector Connect OData in UiPath UiPath
Connect to OData in UiPath
OData Connector Connect OData in PowerShell PowerShell
Connect to OData in PowerShell
OData Connector Connect OData in ODBC ODBC
Connect to OData in ODBC

Video Tutorial - Integrate OData data in SSRS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for OData integration in SSRS
  • How to configure connection for OData
  • Features about API Driver (Authentication / Query Language / Examples / Driver UI)
  • Using OData Connection in SSRS

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    ODataDSN

    ZappySys Data Gateway - Add Data Source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    ODataDSN
    OData
    ODBC DSN Template Selection

  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

     No Authentication [Http]

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    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...
    ODBC DSN HTTP Connection Configuration

     Windows Authentication [Http]

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    OData
    Windows Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Optional Parameters
    ODBC DSN HTTP Connection Configuration

     Basic Authentication [Http]

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    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...
    ODBC DSN HTTP Connection Configuration

     NTLM Authentication [Http]

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    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...
    ODBC DSN HTTP Connection Configuration

     Token Authentication [Http]

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    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...
    ODBC DSN HTTP Connection Configuration

     OAuth Connection for OData API [OAuth]

    Fill in all required parameters and set optional parameters if needed:

    ODataDSN
    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...
    ODBC DSN Oauth Connection Configuration

  7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Read data in SSRS from ZappySys Data Gateway

  1. Open Visual Studio and create a new SSRS project
  2. Then add a new Shared Data Source (you can create a non-shared data source inside report too): Adding a Data Source in SSRS project
  3. Continue with creating the Shared Data Source. Select Microsoft SQL Server as Type and hit Build button to proceed further: Configuring a Data Source to access API data in SSRS project
  4. Once a window opens, configure it similarly. Configure "ODataDSN" as database name. Finally, hit Test Connection and OK:
    ODataDSN
    Configuring thoroughly a Data Source to access API data in SSRS project
  5. Another window opens, and it should look similarly to this one below which ends the creation of a Data Source: How Data Source in SSRS project looks like
  6. Now it's time to create a Dataset. If you don't have a report created, in one of the wizard's steps it will look like this: Specifying a query in SSRS Dataset to access API data #1
  7. If you did not follow through report's creation wizard and already had report created, you can simply add a new dataset: Specifying a query in SSRS Dataset to access API data #2
  8. Finally, once you complete the report, similar results show up: ZappySys Data Gateway API data source results

Passing Parameters to SSRS Report / Filter data

If you want to parameterized your report then refer to this article

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here 

    CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
 AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>';

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01: 

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder. 

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here 

    SELECT
  "ShipCountry",
  "OrderID",
  "CustomerID",
  "EmployeeID",
  "OrderDate",
  "RequiredDate",
  "ShippedDate",
  "ShipVia",
  "Freight",
  "ShipName",
  "ShipAddress",
  "ShipCity",
  "ShipRegion",
  "ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only: 

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder. 

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Actions supported by OData Connector

OData Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 List Tables (JSON API)
   [Read more...]
 List Tables (XML API)
   [Read more...]
 Generic Read Data (JSON API)
   [Read more...]
Parameter Description
TableName Read data from specified module (Json Format API)
 Generic Read Data (XML API)
   [Read more...]
Parameter Description
TableName Read data from specified module (Xml Format API)
 Read [$parent.name$]
   [Read more...]
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

OData Connector Examples for SSRS Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Read all records from an JSON OData Service Table    [Read more...] 

SELECT * FROM Customers

Read all records from an XML OData Service Table    [Read more...] 

SELECT * FROM read_data_xml WITH(TableName='MyTable')

Filter records using server side criteria    [Read more...] 

SELECT * FROM Customers WITH( SearchCriteria='Country -eq ''USA'' ')

Filter records using client side criteria    [Read more...] 

SELECT * FROM Customers WHERE Country = 'USA'

List all Tables (JSON Based Format)    [Read more...] 

SELECT * FROM list_tables_json

List all Tables (XML Based Format)    [Read more...] 

SELECT * FROM list_tables_xml

Conclusion

In this article we discussed how to connect to OData in SSRS and integrate data without any coding. Click here to Download OData Connector for SSRS and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download OData Connector for SSRS Documentation 

More integrations

Other application integration scenarios for OData

OData for SSIS
SSIS
OData for SQL Server
SQL Server
OData for Power BI
Power BI
OData for Informatica
Informatica
OData for MS Access
MS Access
OData for MS Excel
MS Excel
OData for SSAS
SSAS
OData for C#
C#
OData for Python
Python
OData for JAVA
JAVA
OData for Tableau
Tableau
OData for SAP Crystal Reports
SAP Crystal Reports
OData for Azure Data Factory (Pipeline)
Azure Data Factory (Pipeline)
OData for Azure Data Factory (SSIS)
Azure Data Factory (SSIS)
OData for Talend Studio
Talend Studio
OData for UiPath
UiPath
OData for PowerShell
PowerShell
OData for ODBC
ODBC

Other connectors for SSRS

Amazon Ads Connector
Amazon Ads
Amazon MWS Connector
Amazon MWS
Amazon Selling Partner (SP-API) Connector
Amazon Selling Partner (SP-API)
Asana Connector
Asana
Azure DevOps Connector
Azure DevOps
Cosmos DB Connector
Cosmos DB
DropBox Connector
DropBox
ElasticSearch Connector
ElasticSearch
FastSpring Connector
FastSpring
Google BigQuery Connector
Google BigQuery
Google Calendar Connector
Google Calendar
Google Drive Connector
Google Drive
Google Sheets Connector
Google Sheets
Hubspot Connector
Hubspot
Jira Connector
Jira
Mailchimp Connector
Mailchimp
ManagedEngine ServiceDesk Plus (Zoho) Connector
ManagedEngine ServiceDesk Plus (Zoho)
Nativo Connector
Nativo
OData Connector
OData
OneDrive Connector
OneDrive
Outlook Mail (Office 365) Connector
Outlook Mail (Office 365)
Power BI Connector
Power BI
ServiceNow Connector
ServiceNow
SharePoint Online Connector
SharePoint Online
Shopify Connector
Shopify
Smartsheet Connector
Smartsheet
Stripe Connector
Stripe
YouTube Connector
YouTube
Zendesk Connector
Zendesk
Zoho CRM Connector
Zoho CRM
Zoho SalesIQ Connector
Zoho SalesIQ
Zoom Connector
Zoom
REST API Connector
REST API
JSON Connector
JSON
JSON File Connector
JSON File
XML Connector
XML
SOAP Connector
SOAP
XML File Connector
XML File
JDBC-ODBC Bridge Connector
JDBC-ODBC Bridge
Salesforce Connector
Salesforce
CSV Connector
CSV
Amazon S3 JSON File Connector
Amazon S3 JSON File
Amazon S3 XML File Connector
Amazon S3 XML File
Amazon S3 CSV File Connector
Amazon S3 CSV File
Azure Blob JSON File Connector
Azure Blob JSON File
Azure Blob XML File Connector
Azure Blob XML File
Azure Blob CSV File Connector
Azure Blob CSV File
FTP/SFTP JSON File Connector
FTP/SFTP JSON File
FTP/SFTP XML File Connector
FTP/SFTP XML File
FTP/SFTP CSV File Connector
FTP/SFTP CSV File
Custom Connector
Build your own Custom API Connector


Download OData Connector for SSRS Documentation

  • How to connect OData in SSRS?

  • How to get OData data in SSRS?

  • How to read OData data in SSRS?

  • How to load OData data in SSRS?

  • How to import OData data in SSRS?

  • How to pull OData data in SSRS?

  • How to push data to OData in SSRS?

  • How to write data to OData in SSRS?

  • How to POST data to OData in SSRS?

  • Call OData API in SSRS

  • Consume OData API in SSRS

  • OData SSRS Automate

  • OData SSRS Integration

  • Integration OData in SSRS

  • Consume real-time OData data in SSRS

  • Consume real-time OData API data in SSRS

  • OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination

  • Connect OData in SSRS

  • Load OData in SSRS

  • Load OData data in SSRS

  • Read OData data in SSRS

  • OData API Call in SSRS