OData Connector for PowerShellOData 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. In this article you will learn how to quickly and efficiently integrate OData data in PowerShell without coding. We will use high-performance OData Connector to easily connect to OData and then access the data inside PowerShell. Let's follow the steps below to see how we can accomplish that! OData Connector for PowerShell is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to OData in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from OData using PowerShell we first need to create a DSN (Data Source) which will access data from OData. We will later be able to read data using PowerShell. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
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:
OdataDSNOData
-
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.
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataNo Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcOptional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion 
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataWindows Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcThis Authentication Type has no parameters to fill-in.
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataBasic Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataNTLM Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired 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
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataToken Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Token Fill-in the parameter... Optional Parameters AuthScheme Bearer AuthHeader Authorization RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataOAuth Connection for OData API [OAuth]https://services.odata.org/V3/Northwind/Northwind.svcOptional 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 
-
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ODataOData 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.OdataDSN
-
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in PowerShell to retrieve data from OData. Hit OK button to use this query in the next step.
SELECT * FROM Customers
Some parameters configured in this window will be passed to the OData API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in PowerShell:
ZappySys API Driver - ODataOData 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.OdataDSNSELECT * FROM Customers
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHEREclause,LIMITkeyword will be performed on the client side, meaning that thewhole result set will be retrieved from the OData API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in OData servers). -
Click OK to finish creating the data source.
Video Tutorial
Read OData data in PowerShell
Sometimes, you need to quickly access and work with your OData data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at OData data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=OdataDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=OdataDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual OData fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }Access specific OData table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]DataTable.Rowsproperty in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in OData. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:
Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=OdataDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Display data in the console
foreach ($row in $table.Rows) {
$line = ""
foreach ($column in $table.Columns) {
$value = $row[$column.ColumnName]
# Let's handle NULL values
if ($value -is [DBNull])
{
$value = "(NULL)"
}
$line += $value + "`t"
}
Write-Host $line
}
LIMIT keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - ODataOData 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.OdataDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt - Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
Write OData data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query
$connectionString = "DSN=OdataDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -ForceSave data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -ForceSave data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -ForceConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.
Actions supported by OData Connector
Learn how to perform common OData actions directly in PowerShell with these how-to guides:
- Generic Read Data (JSON API)
- Generic Read Data (XML API)
- List Tables (JSON API)
- List Tables (XML API)
- Read [Dynamic Endpoint]
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to OData in PowerShell and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to OData, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download OData Connector for PowerShell and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download OData Connector for PowerShell Documentation
More integrations
Other connectors for PowerShell
Other application integration scenarios for OData
How to connect OData in PowerShell?
How to get OData data in PowerShell?
How to read OData data in PowerShell?
How to load OData data in PowerShell?
How to import OData data in PowerShell?
How to pull OData data in PowerShell?
How to push data to OData in PowerShell?
How to write data to OData in PowerShell?
How to POST data to OData in PowerShell?
Call OData API in PowerShell
Consume OData API in PowerShell
OData PowerShell Automate
OData PowerShell Integration
Integration OData in PowerShell
Consume real-time OData data in PowerShell
Consume real-time OData API data in PowerShell
OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination
Connect OData in PowerShell
Load OData in PowerShell
Load OData data in PowerShell
Read OData data in PowerShell
OData API Call in PowerShell