OneDrive Connector for C# In this article you will learn how to integrate OneDrive data in C# (live / bi-directional connection to OneDrive). OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!. Using OneDrive Connector you will be able to connect, read, and write data from within C#. Follow the steps below to see how we would accomplish that. Download Documentation The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

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

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from OneDrive using C# we first need to create a DSN (Data Source) which will access data from OneDrive. We will later be able to read data using C#. Perform these steps:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "OneDrive" from the list of Popular Connectors. If "OneDrive" 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:

   OneDriveDSN

   OneDrive

   

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

    User Credentials [OAuth]

   OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-register-app-v2. [API Help..]

   Steps to get OneDrive Credentials
   

   Firstly, login into Azure Portal and there create an OAuth application:

   1. Go to Azure Portal and login there.
   2. Then go to Azure Active Directory.
   3. On the left side click menu item App registrations
   4. Then proceed with clicking New registration.
   5. Enter a name for your application.
   6. Select one of Accounts in this organizational directory only as supported account type to access data in your company.
   7. In Redirect URI section leave option selected at Web.
   8. In nearby textbox enter https://login.microsoftonline.com/common/oauth2/nativeclient as Redirect URI or any other valid redirect URL, e.g. https://zappysys.com/oauth
   9. Use this Redirect URI in Redirect URL grid row.
   10. Copy Application (client) ID and paste it into API Connection Manager configuration grid in Client ID row.
   11. Then click on Endpoints link and copy first URL to Authorization URL and second one to Token URL in configuration grid. Usually they look similar to these:
       • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/authorize
       • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
       • https://login.microsoftonline.com/common/oauth2/v2.0/authorize
       • https://login.microsoftonline.com/common/oauth2/v2.0/token
   12. Close "Endpoints" and create a Client Secret by clicking Certificates & secrets.
   13. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
   14. Use these scopes in Scopes field: offline_access Files.Read Files.Read.All Files.ReadWrite Files.ReadWrite.All openid profile User.Read email
   15. Click Generate Token to generate tokens.
       NOTE: If you are planning to use your current data connection/token for automated processes, we recommend that you use a generic account for token generation when the login box appears (e.g. sales_automation@mycompany.com instead of bob_smith@mycompany.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will fail. Another potentially unwanted effect of using a personal token is incorrect logging; the API calls (e.g. Read, Edit, Delete, Upload) made with that token will record the specific user as performing the calls instead of an automated process.
   16. That's it!

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

   OneDriveDSN

   OneDrive

   User Credentials [OAuth]

   https://graph.microsoft.com/v1.0

   Required Parameters
   Authorization URL	Fill in the parameter...
   Token URL	Fill in the parameter...
   Client ID	Fill in the parameter...
   Scope	Fill in the parameter...
   Optional Parameters
   Client Secret	Fill in the parameter...
   Refresh Token File Path	Fill in the parameter...
   ReturnUrl	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...
   Login Prompt Option	Fill in the parameter...
   Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed)	Fill in the parameter...
   Extra Headers (e.g. Header1:AAA||Header2:BBB)	Fill in the parameter...

   

    Application Credentials [OAuth]

   OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-v2-service [API Help..]

   Steps to get OneDrive Credentials
   

   Firstly, login into Azure Portal and there create an OAuth application:

   1. Go to Azure Portal and login there.
   2. Then go to Azure Active Directory.
   3. On the left side click menu item App registrations
   4. Then proceed with clicking New registration.
   5. Enter a name for your application.
   6. Select one of Accounts in this organizational directory only as supported account type to access data in your company.
   7. In Redirect URI section leave option selected at Web.
   8. Copy Application (client) ID and paste it into API Connection Manager configuration grid in Client ID row.
   9. Then click on Endpoints link and copy second, Token, URL to Token URL field in configuration grid. Usually they look similar to these:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
      • https://login.microsoftonline.com/common/oauth2/v2.0/token
   10. Close "Endpoints" and create a Client Secret by clicking Certificates & secrets.
   11. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
   12. Go to API Permissions section and add Microsoft Graph permissions. Then and add Drive permissions, e.g. Files.Read.All, Files.ReadWrite.All.
   13. Use these scopes in Scopes field: offline_access Files.Read Files.Read.All Files.ReadWrite Files.ReadWrite.All openid profile User.Read email
   14. Finally, Grant admin consent for your domain for your permissions.
   15. That's it!

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

   OneDriveDSN

   OneDrive

   Application Credentials [OAuth]

   https://graph.microsoft.com/v1.0

   Required Parameters
   Token URL	Fill in the parameter...
   Client ID	Fill in the parameter...
   Client Secret	Fill in the parameter...
   Optional Parameters
   Scope	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...
   Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed)	Fill in the parameter...
   Extra Headers (e.g. Header1:AAA||Header2:BBB)	Fill in the parameter...

   

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

7. Click OK to finish creating the data source.

Video instructions

Read data in C#

Using ODBC DSN

1. Create a new Console project and use this code to read the data:
   

   "OneDriveDSN";

   

2. Press F5 to run the code and read the data:
   

3. Here is the code in text format:

   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "OneDriveDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   
                   //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                   cmd.CommandTimeout=600; // 600-Seconds
                   
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - OneDrive

   OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!

   OneDriveDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:

3. Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:

   var connectionString = "DRIVER={ZappySys API Driver};SomeProperty=12345;AnotherProperty=some_value;";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // your code goes here
   }

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. It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If it happens you use such API, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the Refresh Token in a file instead of directly in ODBC connection string. Follow the steps below to achieve this.

1. Open your ODBC data source
2. Hit Advanced tab and enter a file path:
   

   ZappySys API Driver - OneDrive

   OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!

   OneDriveDSN

   
   If you cannot find the Advanced tab, try looking for Click to Configure link in Properties tab, under URL text box. Click it, and then configure the file path in OAuth Grant Options tab.
3. Then click Copy settings button to copy a full connection string and paste it into your script.
4. Proceed by pasting the connection string into your C# code as an argument when calling the OdbcConnection object's constructor.
5. Remove long AccessToken and RefreshToken properties from the connection string, and leave RefreshTokenFile property intact together with all the other properties:

   var connectionString = "Driver={ZappySys API Driver};RefreshTokenFile=C:\Users\john\Documents\tokens.txt;SomeProperty=12345;AnotherProperty=some_value;[AllOtherProperties=...]";
       using (var conn = new OdbcConnection(connectionString))
       {
           // your code goes here
       }

   AccessToken and RefreshToken will be stored in C:\Users\john\Documents\tokens.txt, specified by RefreshTokenFile property.
6. Our troubles are over, now you should be able to execute the script with no problems.

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:
   

2. Enter the desired Procedure name and click on OK:
   

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>';
   

   
   

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';

   
   

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''')

   
   

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.
   

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:
   

2. Enter the desired Table name and click on OK:
   

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'

   
   

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"

   
   

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''')

   
   

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.
   

Actions supported by OneDrive Connector

OneDrive Connector Examples for C# 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.

SELECT * FROM Drives

SELECT * FROM get_drive
WITH (DriveId='b!GtLQTMU726XXXXY5F2BBNi14')
--You can get DriveId by selecting from 'Drives' table.

SELECT * FROM list_root
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wa')
--You can get DriveId by selecting from 'Drives' table.

SELECT *
FROM list_folder
WITH(
	  Filter='$.value[*]' --list both files and folders
	--Filter='$.value[?(@.file.mimeType != null)]' --list only files
	--Filter='$.value[?(@.folder.childCount != null)]' --list only folders
	  ,DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0'
	--,FolderId='01R65QTTUIVFJ6HVJ2WBC37KCAOQRKX7PP' --exact Id of Folder
	--,FolderId='root' --default is root if FolderId is not passed
	--,FolderId='root:/Documents/My Projects:'
	--,FolderId='root:/Documents/My Projects/Sample Project:'
)		
--You can get DriveId by selecting from 'Drives' table.
--You can get FolderId by selecting from 'list_root' table OR selection from 'list_folder'.

SELECT * FROM list_files
WITH(
     Filter='$.value[*]' --list both files and folders
   --Filter='$.value[?(@.file.mimeType != null)]' --list only files
   --Filter='$.value[?(@.folder.childCount != null)]' --list only folders
	,DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-Sa5UzSpkaY9E'
  --,SearchPath='/root:/myfolder:'	--folder path
	,SearchPath='/root:/myfolder/subfolder:' --folder path nested
    ,OrderBy='lastModifiedDateTime desc'
)		
--You can get DriveId by selecting from 'Drives' table.
--You can get SearchPath by selecting from 'list_root' table OR selection from 'list_folder'.

SELECT * FROM list_folder
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wa',
      FolderId='atLNa26LE0eYFa2BeNi1awa',
      Filter='$.value[?(@.folder)]')
--You can get DriveId by selecting from 'Drives' table.
--You can get FolderId by selecting from 'list_root' table OR selection from 'list_folder'.

SELECT * FROM list_folder
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wa',
      FolderId='atLNa26LE0eYFa2BeNi1awa',
      Filter='$.value[?(@.file)]')
--You can get DriveId by selecting from 'Drives' table.
--You can get FolderId by selecting from 'list_root' table OR selection from 'list_folder'.

SELECT * FROM list_excel_files
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14')
--You can get DriveId by selecting from 'list_drives' endpoint.

SELECT * FROM list_excel_worksheets
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14'
     ,FileId='01SUOJPKECYDDVFZWXXXXXXXXXXXXXXXXX')
--DriveId can be retrieved by selecting from 'list_drives' endpoint.
--FileId can be retrieved by selecting from 'list_excel_files' endpoint.

SELECT * FROM get_excel_worksheet_autodetect
WITH (
         DriveId='b!GtLN726LE-XXXXXXXXXXX'
  	    ,FileId='01SUOJPFXXXXXXXXXXXXXXXXXX'
	    ,SheetId='Sheet1' --Id or Name
	    ,AutoDetectByValue='true'
		,ArrayTransEnableCustomColumns='True' --set this to False if No header in first row
		)
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.
--SheetId can be retrieved by downloading Excel file and discovering what sheets exist or by selecting from 'list_excel_worksheets' endpoint.

SELECT * FROM get_excel_worksheet
WITH (
        DriveId='b!GtLN726LE-XXXXXXXXXXX'
  	   ,FileId='01SUOJPFXXXXXXXXXXXXXXXXXX'
	   ,SheetId='Sheet1' --Id or Name
	   ,Range='A1:K10000'
	   ,ArrayTransEnableCustomColumns='True' --set this to False if No header in first row
	   )
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.
--SheetId can be retrieved by downloading Excel file and discovering what sheets exist or by selecting from 'list_excel_worksheets' endpoint.
--Range should be set to Excel-type of range where data is located.

SELECT * FROM upload_file
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14'
     ,SourceFilePath='C:\My files\Employees\List.xls'
     ,TargetFilePath='Uploads/Employees/List.xls')
--DriveId can be retrieved by selecting from 'list_drives' endpoint.

SELECT * FROM download_file
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14'
,FileId='01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX'
,TargetFilePath='C:\My files\Employees\List.xlsx')
--DriveId can be retrieved by selecting from 'list_drives' endpoint.
--FileId can be retrieved by selecting from 'list_files' endpoint.

SELECT * FROM delete_item
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14'
     ,ItemId='01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX')
--DriveId can be retrieved by selecting from 'list_drives' endpoint.
--FileId can be retrieved by selecting from 'list_folder' or 'list_root' endpoints.

Conclusion

In this article we discussed how to connect to OneDrive in C# and integrate data without any coding. Click here to Download OneDrive Connector for C# 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 OneDrive Connector for C# Documentation 

More integrations

Other application integration scenarios for OneDrive

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for C#

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Download OneDrive Connector for C# Documentation

Common Searches: