C# SharePoint Online Connector

In this article you will learn how to integrate SharePoint Online data to C# (live / bi-directional connection to SharePoint Online). SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!.

Using SharePoint Online 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  Help File  Buy 

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

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

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

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

    ZappySys API Driver
    Create new System DSN for 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 "SharePoint Online" from the list of Popular Connectors. If "SharePoint Online" 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:

    SharePointOnlineDSN
    SharePoint Online
    ODBC DSN Template Selection

  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.

    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 SharePoint Online 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 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 Sites.Read.All Sites.ReadWrite.All 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!
    For more information you can read this link https://docs.microsoft.com/en-us/graph/auth-register-app-v2 Also https://docs.microsoft.com/en-us/graph/auth-register-app-v2

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

    SharePointOnlineDSN
    SharePoint Online
    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...
    SiteId (select after pressing 'Generate Token') Fill in the parameter...
    Optional Parameters
    Client Secret Fill in the parameter...
    ReturnUrl Fill in the parameter...
    Login Prompt Option Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

    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 SharePoint Online Credentials

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

    Step-1: Create OAuth App

    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 for SharePoint and Drive, e.g. Sites.Selected, Sites.Read.All, Sites.ReadWrite.All, Files.Read.All, Files.ReadWrite.All.
    13. Finally, Grant admin consent for your domain for your permissions.

    Step-2: Register OAuth App in SharePoint Admin Portal

    1. After we create OAuth App we need to add grant SharePoint access to that App using Admin Portal. Make sure you have admin permission to acces Portal. For detailed steps you may refer to this link. Here are basic steps you can follow.
    2. Log in to SharePoint Admin Portal and access below URL
      (Replace YOURCOMPANY)
      https://YOURCOMPANY-admin.sharepoint.com/_layouts/15/appprincipals.aspx?Scope=Web
    3. Enter App Id and other information
    4. Enter XML snippet which describes which permission you want to grant. Here is an example permission (App with FullControl / Read / Write)
      <AppPermissionRequests AllowAppOnlyPolicy="true">
        <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
      </AppPermissionRequests>
        
    5. Click Add to grant the permission. That's it!
    NOTE: After adding App in SharePoint if you ever remove the permission then you can visit the following URL and delete the App.
    https://YOURCOMPANY-admin.sharepoint.com/_layouts/15/appprincipals.aspx?Scope=Web

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

    SharePointOnlineDSN
    SharePoint Online
    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...
    SiteId 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...
    ODBC DSN Oauth Connection Configuration

  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:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Read data in C# from the DSN

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

    "SharePointOnlineDSN";
    Make ZappySys Driver call in c#

  2. Press F5 to run the code and read the data:
    ZappySys Driver Output in c#

  3. Here is the code in text format:

    
    using System;
    using System.Data.Odbc;
    
    namespace ConsoleApp {
        class Program {
            static void Main() {
                var dsn = "SharePointOnlineDSN";
                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();
            }
        }
    }
    

  4. 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 . 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};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;";
    
            using (var conn = new OdbcConnection(connectionString))
            {
            // ...
            }
        
    
    How to get ZappySys Driver Connection String?

    Please follow the instructions below to retrieve the connection string for the ZappySys driver.

    1. Click on the Windows Start menu.

    2. In the search bar, type ODBC and press Enter.

    3. From the search results, choose ODBC Data Sources or ODBC Data Sources (32-bit) or a similar option depending on your system architecture and ODBC driver configuration.

    4. Choose your data source from the list, then click on the Configure button.
    5. After opening the Data Source UI, you should copy the connection string to a Notepad or text file for reference.
    6. Click on Copy Connection String button.
      When you click 'Copy Connection String,' you may encounter the following option:
      Choose the third option All Settings to copy everything and click on OK button.
      zappysys-data-source-copy-connectionstring
      zappysys-data-source-copy-connectionstring

    That's it connection string has been successfully copied.

    How to Overcome the Long Connection String Issue

    This issue is typically caused when the connection string includes a long RefreshToken attribute (i.e. RefreshToken=xxxxxxxxxxxx...xxx, especially if it's more than 1,000 characters).

    A good solution is to supply the RefreshToken by a file. Simply copy and paste the RefreshToken into a text file and save it, and then pass that file path in the connection string instead of directly supplying the RefreshToken.

    Here is an example of a connection string that can cause the issue:

    
        var connectionString = "Driver={ZappySys API Driver};RefreshToken=xxxxxxxxxxxx...xxxxxxx;ServiceUrl=...;";
    
        using (var conn = new OdbcConnection(connectionString))
        {
        // ...
        }
    
    

    Here is an example of a connection string that has resolved the issue by moving the RefreshToken attribute to the file c:\my_refresh_token.txt:

    
        var connectionString = "Driver={ZappySys API Driver};RefreshTokenFile=c:\my_refresh_token.txt;ServiceUrl=...;";
    
        using (connectionString)
        {
        // ...
        }
    
    

Insider Insights

While using ExecuteNonQuery make sure to use output=0.

Sometime Executing `cmd.ExecuteNonQuery` in C# didn't trigger the API call immediately specifically for `INSERT`, `UPDATE`, or `DELETE` statement, as it only initiates the call when the iterator is requested. When using ExecuteNonQuery(), it's primarily intended for SQL statements that don't return data, such as UPDATE, INSERT, or DELETE. If you're not seeing any changes made by the UPDATE statement, there could be several reasons for this.

One potential reason, as you've mentioned, is related to deferred execution. In some cases, the changes made by the UPDATE statement might not be visible immediately, especially if you're not requesting any output from the query. In such cases, explicitly setting Output = 0 can force the iterator to be called, ensuring that the changes are applied.

Here's an example of how you might modify your code to include this:

using System;
using System.Data.Odbc;

namespace ConsoleApp {
    class Program {
        static void Main() {
            var dsn = "SharePointOnlineDSN";
            using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
            {
                conn.Open();
                
                //We're currently referring to the example with the Products table. Please substitute it with the table of your choice.
                var cmd =new OdbcCommand("UPDATE Products SET ProductName='Chai' Where ProductID=1 WITH(Output=0)", conn);
                
                //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                cmd.CommandTimeout=600; // 600-Seconds
                
                // Execute the query
                int rowsAffected = cmd.ExecuteNonQuery();

                // Check the number of rows affected
                if (rowsAffected > 0)
                {
                    Console.WriteLine("Update successful.");
                }
                else
                {
                    Console.WriteLine("No rows were updated.");
                } 
            }
            Console.ReadKey();
        }
    }
}

Create Custom Store 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 Store 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 Store Procedure

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

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store 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 Store Procedure

  4. That's it now go to Preview Tab and Execute your Store 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 Store Procedure

  5. Let's generate the SQL Server Query Code to make the API call using store 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 store 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 store 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 store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

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

Actions supported by SharePoint Online Connector

SharePoint Online 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.
 Read Main Site
   [Read more...]
 List Sites
   [Read more...]
 List Drives
   [Read more...]
Parameter Description
SiteId Specify a site
 Read Drive
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List Folders
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List Files
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List Excel Files
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List SharePoint Lists
   [Read more...]
Parameter Description
SiteId Specify a site
 List SharePoint System Lists
   [Read more...]
Parameter Description
SiteId Specify a site
 Read List Fields
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
Expand
 Read List
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
 Read List Items
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
Filter To filter data on a field, you will first need to index it: https://support.microsoft.com/en-us/office/add-an-index-to-a-list-or-library-column-f3f00554-b7dc-44d1-a2ed-d477eac463b0
Option Value
None
Equal Search fields/SomeColumn eq &#39;SomeValue&#39;
Substring Search substringof(fields/SomeField,&#39;abc&#39;)
Starts With startswith(fields/SomeField, &#39;abc&#39;)
 Read List Items (Dynamic Columns)
Use this endpoint if you face issue with NULl values in some columns. This endpoint scans metadata from few sample rows and decides datatypes. Use this if other endpoing showing null values for Complex datatypes (e.g. Lookup, Location, Person)    [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
Filter To filter data on a field, you will first need to index it: https://support.microsoft.com/en-us/office/add-an-index-to-a-list-or-library-column-f3f00554-b7dc-44d1-a2ed-d477eac463b0
Option Value
None
Equal Search fields/SomeColumn eq &#39;SomeValue&#39;
Substring Search substringof(fields/SomeField,&#39;abc&#39;)
Starts With startswith(fields/SomeField, &#39;abc&#39;)
 Read List Item (By ID)
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
ListItemId Specify a list item id (Record ID)
 Create List Item
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
 Update List Item
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
ListItemId Specify a list item id
 Delete List Item
   [Read more...]
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
ListItemId Specify a list item id
 List Excel Worksheets (Tabs)
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id to search items in
FileId Specify a drive Id to search items in
 Read Excel Worksheet (Auto Detect Range)
Use this endpoint to read data from a Sheet without supplying address range (e.g. A1:D100). This endpoint auto detects address range based on used cells in a sheet.    [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
SheetId Specify a sheet name
AutoDetectByValue Auto detect cell range based on values only and do not consider cell formatting (for empty values) to detect the range.
Option Value
true true
false false
 Read Excel Worksheet (Specific Range)
Use this endpoint to read data from excel worksheets with address range e.g. A1:D100. If you want dynamic range or unsure about end row then use the other endpoint with Auto Detect feature    [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
SheetId Specify a sheet name
Range
 Download File as a column field
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
 Download File to disk
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
 Delete File from Sharepoint Site
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
 Upload File
   [Read more...]
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
DiskFilePath Specify a disk file path
SharePointFilePath Specify target file path
 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 Check 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 =&gt; 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

SharePoint Online 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 lists from Lists table    [Read more...]

SELECT * FROM Lists

Select data from a named list    [Read more...]

SELECT * FROM [Type here your list name] --Where Id=1234

Insert data into a named list    [Read more...]

INSERT INTO [Type here your list name](Name, Surname)
VALUES ('John', 'Doe') WITH (Output=1)

Update data in a named list    [Read more...]

UPDATE [Type here your list name]
SET Name = 'Elizabeth', Surname = 'Johnson'
WITH (ListItemId='887',Output=1)
--ListItemId can be retrieved by selecting from named list table, e.g. 'MyEmployeesList'.

Delete item from a named list    [Read more...]

DELETE FROM [Type here your list name] WHERE Id=888
--OR--        
DELETE FROM [Type here your list name] WITH (ListItemId='888')
        
--ListItemId can be retrieved by selecting from named list table, e.g. 'MyEmployeesList'.

Main site    [Read more...]

Gets main SharePoint site details

SELECT * FROM get_main_site

List sites    [Read more...]

Lists all available SharePoint sites

SELECT * FROM Sites

List drives    [Read more...]

Lists all drives

SELECT * FROM Drives

Get drive    [Read more...]

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

List folders    [Read more...]

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

List files    [Read more...]

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

List Excel files    [Read more...]

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

Get list fields    [Read more...]

SELECT * FROM get_list_fields
WITH (ListId='2e1d58e4-eced-4d1c-9279-XXXXXXXXXXXXX')
--You can get ListId by selecting from 'list_lists' endpoint.

Get list items    [Read more...]

SELECT * FROM get_list_items
WITH (ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX')
--You can get ListId by selecting from 'list_lists' endpoint.

Get list items (dynamic metadata)    [Read more...]

Gets items of a specific list using dynamic metadata approach. Use this if other endpoint is showing null values for complex datatypes (e.g. Lookup, Location, Person)

SELECT * FROM get_list_items_dynamic
WITH (ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX')
--You can get ListId by selecting from 'list_lists' endpoint.

Create list item    [Read more...]

INSERT INTO create_list_item(Title, OrderId)
VALUES ('My super title', 12345)
WITH (ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX'
     ,Output=1)
--You can get ListId by selecting from 'list_lists' endpoint.

Update list item    [Read more...]

UPDATE update_list_item
SET Title = 'My super title', OrderId = 12345
WITH (ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXX'
     ,ListItemId='775'
     ,Output=1)
--You can get ListId by selecting from 'list_lists' endpoint.
--ListItemId can be retrieved by selecting from 'get_list_items' endpoint.

Delete list item    [Read more...]

DELETE FROM delete_list_item
WITH (ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX'
     ,ListItemId='775')
--You can get ListId by selecting from 'list_lists' endpoint.
--ListItemId can be retrieved by selecting from 'get_list_items' endpoint.

List Excel file worksheets    [Read more...]

SELECT * FROM list_excel_worksheets
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXXX'
     ,FileId='01SUOJPKECYDDVFZWXXXXXXXXXXXXXXXXX')
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.

Read Excel Worksheet data - Auto Detect Range    [Read more...]

Reads an Excel file without supplying Cell Address Range (It auto detects based on first and last cell)

SELECT * FROM get_excel_worksheet_autodetect
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX'
  	    ,FileId='01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX'
	    ,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.

Read Excel Worksheet data for a specified Cell Address Range    [Read more...]

Reads an Excel file from a specified Cell Range. To automatically read without cell range use other endpoint get_excel_worksheet_autodetect

SELECT * FROM get_excel_worksheet
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX'
  	 ,FileId='01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX'
	   ,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.

Upload a file to a SharePoint site    [Read more...]

SELECT * FROM upload_file
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX'
	 ,DiskFilePath='C:\My files\Employees\List.xls'
	 ,SharePointFilePath='Uploads/Employees/List.xls')
--DriveId can be retrieved by selecting from 'Drives' table.

Download a file to a local disk from a SharePoint site    [Read more...]

SELECT * FROM download_file_to_disk
    WITH(
    DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMxxxxxxxxxxxxx'
    , FileId='01SUOJPKDXTQL2XI2EIFDYZxxxxxxxxxxxxx'
    , TargetFilePath='C:\temp\List.xlsx'
    --, FileOverwriteMode='FailIfExists' //change default overwrite mode from AlwaysOverwrite to FailIfExists
    )
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.

Read a file content as BASE64 (Binary to string)    [Read more...]

Read file content as base64 string (Binary to Base64) and also save Base64 to disk to recreate file.

SELECT Data as BYTES_AS_BASE64_STRING, BASE64_TO_FILE('C:\My files\Employees\List.xls', Data) FILE_SAVED_TO_DISK_FROM_BASE64 
FROM download_file
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXX'
	 ,FileId='01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX')
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.

Get full image path from Image type field    [Read more...]

By default Image field in your List will show JSON document which contains many pieces of your Image field. To get full path of your Image file you can use JSON_VALUE function and extract multiple fields and concat together to get full path like below.

SELECT *,(JSON_VALUE(MyImageField,'$.serverUrl') || JSON_VALUE(MyImageField,'$.serverRelativeUrl')) as DevicePhotoUrl,
    FROM "My SharePoint List Name"

Other App Integration scenarios for SharePoint Online

Other Connectors for C#


Download SharePoint Online Connector for C# Documentation 

  • How to connect SharePoint Online in C#?

  • How to get SharePoint Online data in C#?

  • How to read SharePoint Online data in C#?

  • How to load SharePoint Online data in C#?

  • How to import SharePoint Online data in C#?

  • How to pull SharePoint Online data in C#?

  • How to push data to SharePoint Online in C#?

  • How to write data to SharePoint Online in C#?

  • How to POST data to SharePoint Online in C#?

  • Call SharePoint Online API in C#

  • Consume SharePoint Online API in C#

  • SharePoint Online C# Automate

  • SharePoint Online C# Integration

  • Integration SharePoint Online in C#

  • Consume real-time SharePoint Online data in C#

  • Consume realtime SharePoint Online API data in C#

  • SharePoint Online ODBC Driver | ODBC Driver for SharePoint Online | ODBC SharePoint Online Driver | SSIS SharePoint Online Source | SSIS SharePoint Online Destination

  • Connect SharePoint Online in C#

  • Load SharePoint Online in C#

  • Load SharePoint Online data in C#

  • Read SharePoint Online data in C#

  • SharePoint Online API Call in C#