OneDrive Connector

ZappySys OneDrive Connector provide read / write capability inside your app (see list below), using these drag and drop , high performance connector you can perform many OneDrive operations without any coding. You can use this connector to integrate OneDrive 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

Click on your App below to get started with OneDrive Integration

Choose your App / Scenario for which you like to integrate 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

Actions supported by OneDrive Connector

OneDrive Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.

List Drives

[Read more...]

Read Drive

[Read more...]

Parameter	Description
DriveId	Specify a drive

List Root

[Read more...]

Parameter	Description
DriveId	Specify a drive

Lists Folder (Non-Recursive)

[Read more...]

Parameter

Description

DriveId

Specify a drive

FolderId or Path

Specify a folder

Option	Value
root	root
root:/Documents/WinCHM%20Projects/Sample%20Project:	root:/Documents/WinCHM%20Projects/Sample%20Project:
SOME-FOLDER-ID	SOME-FOLDER-ID

List Files

[Read more...]

Parameter

Description

Record Filter (Client Side)

Option	Value
All Files	$.value[?(@.file.mimeType != null)]
All Files Under a Specific Folder	$.value[?(@.file.mimeType != null && @parentReference.id=='SOME-FOLDER-ID-GOES-HERE')]
All Folders	$.value[?(@.folder.childCount != null)]
File Name Equals	$.value[?(@.file.mimeType != null && @name=='somefile.txt')]
File Id Equals	$.value[?(@.file.mimeType != null && @id=='SOME-FILE-ID-GOES-HERE')]
File Name Contains	$.value[?(@.file.mimeType != null && @name=~/somename$/)]
File Name With Regex Pattern	$.value[?(@.file.mimeType != null && @name=~/^somefile_\d\d\d.txt$/)]
File Name With Regex Pattern (Multiple)	$.value[?(@.file.mimeType != null && @name=~/somefile.txt\|somefile.json/)]

DriveId

Specify a drive

Search Type (Default=Recursive)

If you do not wish to see files from child folders then use Non-Recursive option. Recursive option has certain limitations (e.g. Only indexed files will appear so it takes time to show up in the list). If you do not see some files listed in the output then use Non-Recursive option (must specify Parent Folder Path in SearchPath property).

Option	Value
Recursive	search(q='')
NonRecursive	children

Search Path (Default=Root Folder)

Option	Value
/root:	/root:
/root:/somefolder/subfolder:	/root:/somefolder/subfolder:

Order By Field(s) - Only for Recursive SearchType

Order by Field(s) for output. You can order by single or multiple fields and use filed suffix asc for ascending and desc for descending order. For example to order by lastModifiedDateTime in descending order use lastModifiedDateTime desc. To order by nested field you can supply lastModifiedBy/user/email asc

Option	Value
id	id
name	name
name desc	name desc
size	size
size desc	size desc
createdDateTime	createdDateTime
createdDateTime desc	createdDateTime desc
lastModifiedDateTime	lastModifiedDateTime
lastModifiedDateTime desc	lastModifiedDateTime desc

List Excel Files

[Read more...]

Parameter	Description
DriveId	Specify a drive

List Excel Worksheets (Tabs)

[Read more...]

Parameter	Description
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

DriveId

Specify a drive Id to search items in

FileId

Specify a file id

SheetId

Specify a sheet id or 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

[Read more...]

Parameter	Description
DriveId	Specify a drive Id
FileId	Specify a file id or name
SheetId	Specify a sheet id or name
Range

Download File

[Read more...]

Parameter	Description
DriveId	Specify a drive Id
FileId	Specify a file id

Upload File

Don't forget to set up [Read more...]

Parameter	Description
DriveId	Specify a drive Id
SourceFilePath	Specify a disk file path
TargetFilePath	Specify Target file path

Delete Item

[Read more...]

Parameter	Description
DriveId	Specify a drive Id
ItemId	Specify a drive Id

Generic Request

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [Read more...]

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

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

List drives [Read more...]

Lists all drives

SELECT * FROM Drives

Get drive [Read more...]

Gets info about drive

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

List root [Read more...]

Lists items at a root level

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

List items in a folder (Non-Recursive) [Read more...]

Lists items in a folder

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

List files in a folder path (Recursive) [Read more...]

Use list_files endpoint to list files recursivly (list from child folder). However there are some limitations to list recursively, such as some new files may not appear right away or files not indexed wont show up.

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

List folders in a folder [Read more...]

Lists folders in a 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'.

List files in a folder [Read more...]

Lists files in a 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'.

List Excel files [Read more...]

Lists Excel files in a specified drive

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

List Excel file Worksheets [Read more...]

Enumerates Worksheets that are part of Excel file

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.

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

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

Upload a file [Read more...]

Uploads a file to a OneDrive

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.

Download a file [Read more...]

Downloads a file from OneDrive

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.

Delete a file/folder [Read more...]

Deletes a file or folder in OneDrive

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.

Download for SSIS Download for Other Apps