SharePoint Online Connector

ZappySys SharePoint Online Connector provide read / write capability inside your app (see list below), using these drag and drop , high performance connector you can perform many SharePoint Online operations without any coding. You can use this connector to integrate SharePoint Online data inside apps like SSIS, SQL Server or popular ETL Platforms / BI Tools/ Reporting Apps / Programming languages (i.e. Informatica, Power BI, SSRS, Excel, C#, JAVA, Python)

Download for SSIS Download for Other Apps Documentation

Video Tutorial - SharePoint Online - Connector REST API Integration

Click on your App below to get started with SharePoint Online Integration

Choose your App / Scenario for which you like to integrate SharePoint Online

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 'SomeValue'
Substring Search substringof(fields/SomeField,'abc')
Starts With startswith(fields/SomeField, 'abc')
 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 'SomeValue'
Substring Search substringof(fields/SomeField,'abc')
Starts With startswith(fields/SomeField, 'abc')
 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 => 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 ODBC PowerPack)

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"

Download for SSIS Download for Other Apps