SharePoint Online Connector for PowerShell
In this article you will learn how to integrate Using SharePoint Online Connector you will be able to connect, read, and write data from within PowerShell. Follow the steps below to see how we would accomplish that. 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. |
Connect to SharePoint Online in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from SharePoint Online using PowerShell we first need to create a DSN (Data Source) which will access data from SharePoint Online. We will later be able to read data using PowerShell. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou 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. -
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:
SharepointOnlineDSNSharePoint Online -
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.
Use delegated access (User Credentials) whenever you want to let a signed-in user work with their own resources or resources they can access. Whether it's an admin setting up policies for their entire organization or a user deleting an email in their inbox, all scenarios involving user actions should use delegated access. [API reference]
Steps how to get and use SharePoint Online credentials
Follow these simple steps below to create Microsoft Entra ID application with delegated access:
WARNING: If you are planning to automate processes, we recommend that you use a Application Credentials authentication method. In case, you still need to use User Credentials, then make sure you use a system/generic account (e.g.automation@my-company.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 start to fail.- Navigate to the Azure Portal and log in using your credentials.
- Access Microsoft Entra ID.
-
Register a new application by going to App registrations and clicking on New registration button:
INFO: Find more information on how to register an application in Graph API reference. -
When configuration window opens, configure these fields:
-
Supported account type
- Use
Accounts in this organizational directory only
, if you need access to data in your organization only.
- Use
-
Supported account type
-
Redirect URI:
- Set the type to
Public client/native (mobile & desktop)
. - Use
https://zappysys.com/oauth
as the URL.
- Set the type to
-
After registering the app, copy the Application (client) ID for later:
-
Copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs to use later in the configuration:
-
Now go to SSIS package or ODBC data source and use the copied values in User Credentials authentication configuration:
- In the Authorization URL field paste the OAuth authorization endpoint (v2) URL value you copied in the previous step.
- In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
- In the Client ID field paste the Application (client) ID value you copied in the previous step.
-
In the Scope field use the default value or select individual scopes, e.g.:
-
email
-
offline_access
-
openid
-
profile
-
User.Read
-
Sites.Read.All
-
Sites.ReadWrite.All
-
Files.Read.All
-
Files.ReadWrite.All
-
- Press Generate Token button to generate Access and Refresh Tokens.
- Optional step. Choose Default Site Id from the drop down menu.
- Click Test Connection to confirm the connection is working.
- Done! Now you are ready to use the API Connector!
Fill in all required parameters and set optional parameters if needed:
SharepointOnlineDSNSharePoint OnlineUser Credentials [OAuth]https://graph.microsoft.com/v1.0Required Parameters Authorization URL Fill-in the parameter... Token URL Fill-in the parameter... Client ID Fill-in the parameter... Scope Fill-in the parameter... Return URL Fill-in the parameter... Default Site Id (select after pressing 'Generate Token') Fill-in the parameter... Optional Parameters Client Secret Default Drive Id (select after pressing 'Generate Token') Login Prompt Option RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503|423 RetryCountMax 5 RetryMultiplyWaitTime True Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed) Extra Headers (e.g. Header1:AAA||Header2:BBB) IsAppCred 0 Application-only access is broader and more powerful than delegated access (User Credentials), so you should only use app-only access where needed. Use it when: 1. The application needs to run in an automated way, without user input (for example, a daily script that checks emails from certain contacts and sends automated responses). 2. The application needs to access resources belonging to multiple different users (for example, a backup or data loss prevention app might need to retrieve messages from many different chat channels, each with different participants). 3. You find yourself tempted to store credentials locally and allow the app to sign in 'as' the user or admin. [API reference]
Steps how to get and use SharePoint Online credentials
Follow these simple steps to create Microsoft Entra ID application with application access permissions:
-
Create an OAuth app
-
Grant application SharePoint Online permissions (optional, for granular permissions)
This step allows to grant OAuth application granular permissions, i.e. access configured specificSites
,Lists
, andList Items
.Step-1: Create OAuth app
- Navigate to the Azure Portal and log in using your credentials.
- Access Microsoft Entra ID.
-
Register a new application by going to
App registrations
and clicking on New registration button:
INFO: Find more information on how to register an application in Graph API reference.
-
When configuration window opens, configure these fields:
-
Supported account type
- e.g. select
Accounts in this organizational directory only
if you need access to data in your organization only.
- e.g. select
-
Supported account type
-
Redirect URI:
- Set the type to
Public client/native (mobile & desktop)
. - Leave the URL field empty.
- Set the type to
-
After registering the app, copy the Application (client) ID for later:
-
Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs:
-
Continue and create Client secret:
-
Then copy the Client secret for later steps:
-
Continue by adding permissions for the app by going to the API permissions section, and clicking on Add a permission:
-
Select Microsoft Graph:
-
Then choose Application permissions option:
-
Continue by adding these Sites permissions (search for
site
):INFO: If you want to access specific lists or list items (table-level vs row-level security) rather than the full site, then addLists.SelectedOperations.Selected
orListItems.SelectedOperations.Selected
permissions , just like in the previous step (search forlist
).WARNING: If you add any of these permissions -Sites.Selected
,Lists.SelectedOperations.Selected
, orListItems.SelectedOperations.Selected
- you must grant the app the SharePoint permissions for the specific resource (e.g. aSite
, aList
, or aListItem
). Follow instructions in Grant SharePoint permissions to the OAuth app (optional) section on how to accomplish that. -
Finish by clicking Add permissions button:
-
Now it's time to Grant admin consent for your application:
-
Confirm all the permissions are granted:
-
Now go to SSIS package or ODBC data source and use the copied values in Application Credentials authentication configuration:
- In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
- In the Client ID field paste the Application (client) ID value you copied in the previous step.
- In the Client Secret field paste the Client secret value you copied in the previous step.
- Optional step. Choose Default Site Id from the drop down menu.
- Click Test Connection to confirm the connection is working.
- Done!
Step-2 (optional): Grant SharePoint permissions to the OAuth app (optional)
If you used
Sites.Selected
,Lists.SelectedOperations.Selected
orListItems.SelectedOperations.Selected
permission in the previous section, you must grant the app the SharePoint permissions for the specific resource (e.g. aSite
, aList
, or aListItem
). You can do it using PowerShell or SharePoint admin center (obsolete method).Granting SharePoint permissions using PowerShell
Unfortunately, there is no user interface available to control these permissions yet. For now, granting permissions has to be accomplished via Microsoft Graph API [Microsoft reference]:
You must be the owner of the resource to grant permissions (i.e. belong to SharePoint owners group or be the owner of theSite
orList
).- Open PowerShell (run as admin).
-
Call the following PowerShell code to grant
read
andwrite
permission for the app we created earlier (assuming Application (client) ID is89ea5c94-aaaa-bbbb-cccc-3fa95f62b66e
):# More info at: # - https://learn.microsoft.com/en-us/graph/permissions-selected-overview?tabs=powershell # - https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.sites/?view=graph-powershell-1.0 # Find SharePoint Site Id by following these steps: # - Login into SharePoint Online # - Open this URL https://{your-company}.sharepoint.com/_api/site in the browser # NOTE: For a subsite use https://{your-company}.sharepoint.com/sites/{your-subsite}/_api/site # - Find 'Id' element in the response (e.g. <d:Id m:type="Edm.Guid">efcdd21a-aaaa-bbbb-cccc-5d8104d8b5e3</d:Id>) # - Copy the Site Id, i.e.: efcdd21a-aaaa-bbbb-cccc-5d8104d8b5e3 # Set $siteId variable to the retrieved Site Id: $siteId="efcdd21a-aaaa-bbbb-cccc-5d8104d8b5e3" # Find your Application Id (i.e. Client Id) in the Azure Portal, in App Registrations page: # https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade $applicationId="89ea5c94-aaaa-bbbb-cccc-3fa95f62b66e" # Available permissions: read, write, fullcontrol, owner ('write' includes 'read' permission) $appPermission="write" # Step-1: Install 'Microsoft.Graph.Sites' module if it's not installed if (-not (Get-Module Microsoft.Graph.Sites -ListAvailable)) { Install-Module Microsoft.Graph.Sites } # Step-2: Load module Import-Module Microsoft.Graph.Sites # Step-3: Login (use Azure admin or SharePoint owner account) DisConnect-MgGraph Connect-MgGraph # Step-4: Set parameters for API call (set permissions, Site ID and Application ID) $params = @{ roles = @($appPermission) grantedTo = @{ application = @{id = $applicationId} } } # Step-5: Grant permissions New-MgSitePermission -SiteId $siteId -BodyParameter $params # Done! Write-Host "Granted SharePoint permissions to application '$applicationId' for site '$siteId'."
- That's it! Now you can use the API Connector!
Granting SharePoint permissions using SharePoint admin center (obsolete method)
If you used
Site.Selected
permission you can link it SharePoint site in SharePoint admin center [SharePoint reference]. Follow these simple steps to accomplish that:-
Log in to SharePoint admin center using this URL:
(replace
YOURCOMPANY
with your company name):https://YOURCOMPANY-admin.sharepoint.com/_layouts/15/appinv.aspx
INFO: To view all the registered apps in SharePoint, visit this page:https://YOURCOMPANY-admin.sharepoint.com/_layouts/15/appprincipals.aspx?Scope=Web
. - In the App Id field enter Application (client) ID you copied in the previous step.
-
In the Permission Request XML field enter XML snippet which describes which SharePoint permissions you want to grant to the OAuth app, e.g.:
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" /> </AppPermissionRequests>
INFO: This example gives appFullControl
, but you can also grant itRead
orWrite
permissions. - Click Create to grant the permission to your OAuth app.
- That's it! Now you can use the API Connector!
Fill in all required parameters and set optional parameters if needed:
SharepointOnlineDSNSharePoint OnlineApplication Credentials [OAuth]https://graph.microsoft.com/v1.0Required Parameters Token URL Fill-in the parameter... Client ID Fill-in the parameter... Client Secret Fill-in the parameter... Default Site Id Fill-in the parameter... Optional Parameters Scope https://graph.microsoft.com/.default Default Drive Id RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503|423 RetryCountMax 5 RetryMultiplyWaitTime True Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed) Extra Headers (e.g. Header1:AAA||Header2:BBB) IsAppCred 1
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:
Click OK to finish creating the data source.
Video instructions
Read SharePoint Online data in PowerShell
Sometimes, you need to quickly access and work with your SharePoint Online data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at SharePoint Online data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=SharepointOnlineDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=SharepointOnlineDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual SharePoint Online fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }
Access specific SharePoint Online table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]
DataTable.Rows
property in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in SharePoint Online. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:
"DSN=SharepointOnlineDSN"Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=SharepointOnlineDSN" $query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Display data in the console foreach ($row in $table.Rows) { $line = "" foreach ($column in $table.Columns) { $value = $row[$column.ColumnName] # Let's handle NULL values if ($value -is [DBNull]) { $value = "(NULL)" } $line += $value + "`t" } Write-Host $line }
You can limit the numbers of lines to retrieve by using aLIMIT
keyword in the query, e.g.:SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - SharePoint OnlineSharePoint 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!SharepointOnlineDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
- Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.Write SharePoint Online data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query $connectionString = "DSN=SharepointOnlineDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Export table data to a file $table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file $table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file $table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
Check useful PowerShell cmdlets other thanConvertTo-Csv
,ConvertTo-Json
, andConvertTo-Html
for other data manipulation scenarios.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
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
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>';
-
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';
-
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''')
-
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.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
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'
-
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"
-
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''')
-
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 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 SiteList SitesList Drives[Read more...]Parameter Description Site Id Specify a site Read Drive[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive List Folders[Read more...]Parameter Description Record Filter (Client Side) Option Value All Folders $.value[?(@.folder.childCount !=null)] All Folders Under a Specific Folder $.value[?(@.folder.childCount !=null && @parentReference.id=='SOME-FOLDER-ID-GOES-HERE')] Folder Name Equals $.value[?(@.folder.childCount !=null && @name=='SOME-FOLDER-NAME-HERE')] Folder Id Equals $.value[?(@.folder.childCount !=null && @id=='SOME-FOLDER-ID-GOES-HERE')] Folder Name Contains $.value[?(@.folder.childCount !=null && @name=~/somename$/)] Folder Name With Regex Pattern $.value[?(@.folder.childCount !=null && @name=~/^somefolder_\d\d\d.txt$/)] Folder Name With Regex Pattern (Multiple) $.value[?(@.folder.childCount !=null && @name=~/somefolderAAA|somefolderBBB/)] Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Path (Default=Root Folder) - Max 200 items listed 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 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 Files[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Path (Default=Root Folder) - Max 200 items listed 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 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 Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (Default=Recursive) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope - Use Non-Recursive search option (children) instead. 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 (not supported for Application Credentials with Sites.Selected Scope) search(q='.xls') Non-Recursive (Only for Non-Shared Items) children Search Path (Default=Root Folder) 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 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 SharePoint Lists[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site List SharePoint System Lists[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Read List Fields[Read more...]Parameter Description SiteId (Re-Select ListId after you change this) Specify a site ListId Specify a list id to search items for Expand Read List[Read more...]Parameter Description SiteId (Re-Select ListId after you change this) Specify a site ListId Specify a list id to search items for Read List Items[Read more...]Parameter Description SiteId (Re-Select ListId after you change this) 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 (Re-Select ListId after you change this) 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 (Re-Select ListId after you change this) Specify a site ListId (Re-Enter ListItemId after you change this) Specify a list id to search items for ListItemId Specify a list item id (Record ID) Create List Item[Read more...]Parameter Description SiteId (Re-Select ListId after you change this) Specify a site ListId Specify a list id to search items for Update List Item[Read more...]Parameter Description SiteId (Re-Select ListId after you change this) Specify a site ListId (Re-Enter ListItemId after you change this) Specify a list id to search items for ListItemId Specify a list item id Delete List Item[Read more...]Parameter Description SiteId (Re-Select ListId after you change this) Specify a site ListId (Re-Enter ListItemId after you change this) Specify a list id to search items for ListItemId Specify a list item id List Excel Worksheets of a File (i.e. List Tabs)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). FileId -OR- Path Specify a file Id or Path. Syntax: [items/{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/myfile.xlsx: ) 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 Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). Excel File Id or Path (e.g. root:/somefolder/myfile.xlsx: ) - Max 200 Listed Specify a file Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xlsx: ) Sheet Id or Name (e.g. {00xx-xxx-xx123} -OR- Sheet1 ) Specify a sheet id or name (e.g. {00000000-0001-0000-0000-000000000000} -OR- Sheet1 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 (From Exact Range)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). Excel File Id or Path (e.g. root:/somefolder/myfile.xlsx: ) - Max 200 Listed Specify a file Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xlsx: ) Sheet Id or Name (e.g. {00xx-xxx-xx123} -OR- Sheet1 ) Specify a sheet id or name (e.g. {00000000-0001-0000-0000-000000000000} -OR- Sheet1 Range Read CSV File (Generic)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) Create / Update CSV File (Generic)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) Read JSON File (Generic)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) Create / Update JSON File (Generic)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) Read File Data (As Byte Array)Get file data as a column field (Binary data) [Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) Download File[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) Upload FileUpload a file to the specified path [Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Disk File Path (e.g. c:\somefolder\file.xlsx) Specify a disk file path Target File Path OR Id (e.g. file.xlsx -OR- myfolder/file.xlsx -OR- 0Zxxxx1234) Specify target file path Option Value Example #1 (Save On Root) file.xlsx Example #2 (Save Under Folder) myfolder/myfile.xlsx Example #3 (Save Under Child Folder) myfolder/subfolder/myfile.xlsx Example #4 (Overwrite Exising File by ID) 0Zxxxx1234 Conflict Behavior (What to do if file exists) Option Value fail fail replace replace rename rename Use Source File Created/Modified DateTime rather than Uploaded Time Set this property if you like to set file creation/modified date as original file. By default its set to uploaded date/time. This may not be desired if file was actually created on different date than uploaded. If you do not set then current date/time used (Upload time). Option Value Use Uploaded Time (Blank) Use Source File Time true Get Item (File or Folder)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). File/Folder Id or Path (e.g. root:/myfolder: -OR- root:/myfolder/file.xyz: ) - Max 1000 Listed Specify a File/Folder Id or Path (e.g. root:/myfolder/file.xyz: ) Delete Item (File or Folder)[Read more...]Parameter Description Site Id (Re-Select Drive Id after you change this) Specify a site Drive Id Specify a drive File/Folder Id or Path (e.g. root:/myfolder: -OR- root:/myfolder/file.xyz: ) - Max 1000 Listed Specify an item Id you like to delete Move or rename item (File or Folder)Move or rename an item (File or Folder) to a different location in the same drive or another drive (e.g. different Document Library) [Read more...]Parameter Description Operation Option Value Move Move Rename Rename Source Site Id (Optional - Select if different than default site) Specify a site Source Drive Id Specify a drive Source File or Folder Id you like to move or rename Specify an item Id you like to move or rename Target Site Id (Optional - Select if different than source SiteId) Specify a site Target DriveId (Optional - Select if different than source DriveId) Specify a drive Target Folder Id (e.g. 01R65Qxxxxxxx123 -OR- root) - Max 200 items listed Specify a target folder where item should move after move or rename operation. If you are doing inplace rename and not doing move after rename then keep it blank Target Item Name (Optional for Move - e.g. Myfile.pdf or MyFolder) Specify target item name you like to give after move or rename operation. If its move operation and you like to keep same item name as source then keep this blank. Source Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Source Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). Target Search Type (For UI Only - Default=Recursive - i.e. Blank) 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 All Files (Keep Blank) - For User Creds Only Non-Recursive / Children - All Files children Target Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). Prefer Async Operation (Enable if you get error) Option Value None Async (Needed for Large files, Cross Site) respond-async Copy item (File or Folder)Copy an item (File or Folder) to a different location in the same drive or another drive (e.g. different User's drive) [Read more...]Parameter Description Source Site Id (Optional - Select if different than default site) Specify a site Source Drive Id Specify a drive Source File or Folder Id you like to copy Specify an item Id you like to copy Target Site Id (Optional - Select if different than source SiteId) Specify a site Target DriveId (Optional - Select if different than source DriveId) Specify a drive Target Folder Id (e.g. 01R65QTTRxxxxx -OR- root) Specify a target folder where item should be copied Target Item Name (Optional) Specify target item name you like to give after copy operation. Keep it blank if you like to keep same name as source. Source Search Type (For UI Only - Default=Recursive - i.e. Blank) NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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 All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope Non-Recursive / Children All Files (Only for Non-Shared Items) children Recursive *.xlsx Files - For User Creds Only search(q='.xls') Recursive *.csv Files - For User Creds Only search(q='.csv') Recursive *.json Files - For User Creds Only search(q='.json') Recursive Custom Extension Files - For User Creds Only search(q='.myext') Source Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). Target Search Type (For UI Only - Default=Recursive - i.e. Blank) 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 All Files (Keep Blank) - For User Creds Only Non-Recursive / Children - All Files children Target Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). Prefer Async Operation (Enable if you get error) Option Value None Async (Needed for Large files, Cross Site) respond-async Conflict Behavior (What to do if file exists at target location) Default ConflictBehavior is fail if file exists. The conflictBehavior is not supported for OneDrive Consumer. Also it will not fail if TargetItemName same as source file name Option Value fail fail replace replace rename rename Generic RequestThis 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 Option Value No filter Example1 $.store.books[*] Example2 (Sections Under Books) $.store.books[*].sections[*] Example3 (Equals) $.store.books[?(@author=='sam')] Example4 (Equals - Any Section) $..[?(@author=='sam')] Example5 (Not Equals - Any Section) $..[?(@author!='sam')] Example6 (Number less than) $.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )] Example8 (Regular Expression - Does Not Contain Pattern) $.store.books[?(@author=~ /^((?!sam|bob).)*$/ )] Example9 (Regular Expression - Exact Pattern Match) $.store.books[?(@author=~ /^sam|bob$/ )] Example10 (Regular Expression - Starts With) $.store.books[?(@author=~ /^sam/ )] Example11 (Regular Expression - Ends With) $.store.books[?(@author=~ /sam$/ )] Example12 (Between) $.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )] Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair Generic Request (Bulk Write)This is a generic endpoint for bulk write purpose. 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 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 SharePoint Online Connector Examples for PowerShell 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 MyList --WHERE Id = 1234
Insert data into a named list [Read more...]
INSERT INTO MyList(Name, Surname) VALUES ('John', 'Doe') WITH (Output=1)
Insert multiple Lookup or Person/Group IDs into a named list [Read more...]
--new version -- INSERT INTO MyList(Title, ManyPersonsLookupId, ManyPersonsLookupIdOdataType) VALUES ('John Doe', '[11,22,33]', 'Collection(Edm.Int32)') WITH (Output=1) --old version -- INSERT INTO MyList(Title, ManyPersonsLookupId, "fields.ManyPersonsLookupId@odata\u002Etype") VALUES ('John Doe', '[11,22,33]', 'Collection(Edm.Int32)') WITH (Output=1) --Considering "ManyPersons" is the name of the field in SharePoint List
Insert multiple Choice Values into a named list [Read more...]
--new version -- INSERT INTO MyList(Title, MultiChoiceField, MultiChoiceFieldODataType) VALUES ('John Doe', '["Choice1","Choice5"]', 'Collection(Edm.String)') WITH (Output=1) --old version -- INSERT INTO MyList(Title, MultiChoiceField, "fields.MultiChoiceField@odata\u002Etype") VALUES ('John Doe', '["Choice1","Choice5"]', 'Collection(Edm.String)') WITH (Output=1) --Considering "MultiChoiceField" is the name of the field in SharePoint List
Update data in a named list [Read more...]
UPDATE MyList SET Name = 'Elizabeth', Surname = 'Johnson' WHERE Id = '123'
Update Multi Select Lookup or Person/Group IDs field [Read more...]
UPDATE MyList SET Title = 'Elizabeth Johnson', --Method#1 (Pass type info in the same value) ManyPersonsLookupId = '[11,22,33]', "fields.ManyPersonsLookupId@odata\u002Etype" = 'Collection(Edm.Int32)' --Method#2 (Pass type info via ODataField) --OR-- --ManyPersonsLookupId = '[11,22,33]', --ManyPersonsLookupIdODataType" = 'Collection(Edm.Int32) WHERE Id = '123'
Update / Insert Sharepoint List Data (Mixed Data Types - e.g. Multi Choice, Lookup, Person, DateTime, Number) [Read more...]
UPDATE "Travel Requests" --list name SET Title='MyTitle @ <<FUN_NOW>>' --Method#1 Pass Value and Type in 2 fields , CustomText = 'This is text' , CustomTextLarge = 'This is really long text ....' , CustomNumber = 10000.12345 , CustomDateTime ='2012-12-31T23:59:59.123Z' --End with Z to treat as UTC time (avoid local-UTC conversion) , CustomChoice = 'BB' --Choice Multi-Select , CustomChoiceMulti = '["AA", "BB"]' , CustomChoiceMultiODataType='Collection(Edm.String)' --for multi select must supply OData Type --OR-- append like below in one field --, CustomChoiceMulti = '["AA", "BB"], "CustomChoiceMulti@odata.type" : "Collection(Edm.String)"' --Lookup --field with Lookup type must be set to [<field-name>LookupId] field (suffix with LookupId) , CustomLookupSingleLookupId = 1 --Lookup Multi-Select , CustomLookupMultiLookupId = '[1,3]' --for multi select must supply OData Type , CustomLookupMultiLookupIdODataType='Collection(Edm.Int32)' --OR-- append like below in one field --, CustomLookupMultiLookupId = '[1,3], "CustomLookupMultiLookupId@odata.type" : "Collection(Edm.String)"' --Person ,CustomPersonLookupId = 11 --Person Multi-Select , CustomPersonMultiLookupId = '[11, 22]' , CustomPersonMultiLookupIdODataType='Collection(Edm.Int32)' --OR-- append like below in one field --, CustomPersonMultiLookupIdODataType = '[11,22], "CustomPersonMultiLookupIdODataType@odata.type" : "Collection(Edm.Int32)"' Where Id=1 --List Item Id --- Insert Example ---- INSERT INTO "Travel Requests" --list name ( Title , CustomText , CustomTextLarge , CustomNumber , CustomDateTime , CustomChoice , CustomChoiceMulti , CustomChoiceMultiODataType , CustomLookupSingleLookupId --Lookup Multi-Select , CustomLookupMultiLookupId , CustomLookupMultiLookupIdODataType --Person ,CustomPersonLookupId , CustomPersonMultiLookupId , CustomPersonMultiLookupIdODataType ) VALUES( 'MyTitle @ <<FUN_NOW>>' , 'This is text' , 'This is really long text .. ' , 10000.12345 , '2012-12-31T23:59:59.123Z' --End with Z to treat as UTC time (avoid local-UTC conversion) , 'BB' --Choice Multi-Select , '["AA", "BB"]' , 'Collection(Edm.String)' --for multi select must supply OData Type --Lookup , 1 --Lookup Multi-Select , '[1,3]' --for multi select must supply OData Type , 'Collection(Edm.Int32)' --Person ,11 --Person Multi-Select , '[11, 22]' , 'Collection(Edm.Int32)' )
Delete item from a named list [Read more...]
DELETE FROM MyList WHERE Id=888 --OR-- DELETE FROM MyList WITH (ListItemId='123') --ListItemId can be retrieved by selecting from named list table, e.g. 'MyList'.
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 from SharePoint Document Library [Read more...]
SELECT * FROM list_folders WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXX') --You can get DriveId by selecting from 'Drives' table.
List files from SharePoint Document Library [Read more...]
SELECT * FROM list_files WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXX') --You can get DriveId by selecting from 'Drives' table.
List Excel files from SharePoint Document Library [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 (SharePoint Document Library) [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 (SharePoint Document Library) [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 (SharePoint Document Library) [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 (SharePoint Document Library) [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 (SharePoint Document Library) [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 (SharePoint Document Library) [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 (SharePoint Document Library) - 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 (SharePoint Document Library) 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 Document Library [Read more...]
SELECT * FROM upload_file WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX' ,DiskFilePath='C:\My files\Employees\List.xls' ,SharePointFilePath='List.xlsx' --Upload on Root (Create -or- Overwrite if ConflictBehavior = 'replace') --,SharePointFilePath='myfolder/List.xlsx' --Upload under some folder --,SharePointFilePath='01SUOJPKGJXIXXGXACFVDK3QH5JYARFOMB' --Overwrite Exising File Id --,ConflictBehavior = 'replace' -- fail, rename, replace (If File Exists Default=fail) --,UseSourceFileTimeStamp = 'true' --By default uploaded file set Current Date/Time for Creation/Modified date ) --DriveId can be retrieved by selecting from 'Drives' table.
Upload a file to SharePoint Document Library (Overwrite file if exists) [Read more...]
Uploads a file to a SharePoint Document Library and if file already exists then overwrite it rather than throwing error (Default is throw error)
SELECT * FROM upload_file WITH (DriveId='b!GtLN726LE0eY5F2BBNi14' ,DiskFilePath='C:\My files\Employees\List.xls' ,SharePointFilePath='List.xlsx' --Upload on Root (Create -or- Overwrite if ConflictBehavior = 'replace') --,SharePointFilePath='myfolder/List.xlsx' --Upload under some folder --,SharePointFilePath='01SUOJPKGJXIXXGXACFVDK3QH5JYARFOMB' --Overwrite Exising File Id ,ConflictBehavior = 'replace' -- fail, rename, replace (If File Exists Default=fail) --,UseSourceFileTimeStamp = 'true' --By default uploaded file set Current Date/Time for Creation/Modified date ) --DriveId can be retrieved by selecting from 'list_drives' endpoint.
Download a file to a local disk from a SharePoint document library [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 SharePoint 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"
List files in a folder path (Recursive) [Read more...]
Use list_files endpoint to list files recursively (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' --default --,SearchPath='/root:/myfolder:' --folder path ,SearchPath='/root:/myfolder/subfolder:' --folder path nested ,OrderBy='lastModifiedDateTime desc' ) --You can get DriveId by selecting from 'Drives' table.
List files in a folder Id (Non-Recursive) [Read more...]
This examplel shles under a specific FolderId (Available in Non-recursive mode only).
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' ,SearchType='children' --must use this type if you like to list items by FolderId ,SearchPath='/items/01SUOJPKBVT5ZC2KVSXJAYSTTMA4I3GMHX' ) --You can get DriveId by selecting from 'Drives' table.
Create / Update a CSV File from External Data Source (e.g. MSSQL / ODBC) [Read more...]
This example shows how to create / update a CSV file directly inside SharePoint Document Library using streaming approach. This example reads records from Microsoft SQL Server database and writes data to CSV file on SharePoint Document Library. If file does not exists then it creates a new one.
INSERT INTO FileReaderWriterCsv SOURCE( 'MSSQL'--OR 'ODBC' , 'Data Source=localhost;Initial Catalog=Northwind;Integrated Security=true' , 'select OrderId,CustomerId,OrderDate FROM Northwind.dbo.Orders' ) WITH( DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0' , FileId='root:/test_out.csv:' --, FileId='root:/subfolder/test_out.csv:' --, FileId='01N3NxxxxxxxWZYSDJ' --exising File ID --, ColumnDelimiter=',' --{LF}, {TAB}, | , \x0009 ... --, RowDelimiter='{NEWLINE}' --{LF}, {TAB}, | , \x0009 ... --, HasColumnHeaderRow=0 --set for header less file --, WriterDateTimeFormat='yyyy-MM-ddTHH:mm:ss.fff' --See Query Builder for more options )
Create / Update a JSON File in SharePoint Document Library from External Data Source (e.g. MSSQL / ODBC) [Read more...]
This example shows how to create / update a JSON file directly inside SharePoint Document Library using streaming approach. This example reads records from Microsoft SQL Server database and writes data to JSON file on SharePoint Document Library. If file does not exists then it creates a new one. It uses LayoutMap to generate JSON with custom layout.
INSERT INTO FileReaderWriterJson SOURCE( 'MSSQL'--OR 'ODBC' , 'Data Source=localhost;Initial Catalog=Northwind;Integrated Security=true' , 'select OrderId,CustomerId,OrderDate FROM Northwind.dbo.Orders' ) WITH( DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0' , FileId='root:/test_out.json:' --, FileId='root:/subfolder/test_out.json:' --, FileId='01N3NxxxxxxxWZYSDJ' --exising File ID , JsonOutputFormat='Multicontent' --Default , Array2D, ArrayLines ... --, DoNotOutputNullProperty='True' --, Encoding='UTF8' --UTF8WithoutBOM --, WriterDateTimeFormat='yyyy-MM-ddTHH:mm:ss.fff' --Example#1: Output all columns , LayoutMap='<?xml version="1.0" ?> <settings> <dataset id="root" main="True" readfrominput="True" /> <map src="*" /> </settings>' --Example#2: Nested JSON (Records under an array) /* , LayoutMap='<?xml version="1.0" ?> <settings singledataset="True"> <dataset id="root" main="True" readfrominput="True" /> <map name="MyArray" dataset="root" maptype="DocArray"> <map src="OrderID" name="OrderID" /> <map src="OrderDate" name="OrderDate" /> </map> </settings>' */ --Example#3: Nested JSON (Records under a sub document section) /* , LayoutMap='<?xml version="1.0" ?> <settings> <dataset id="dsRoot" main="True" readfrominput="True" /> <map name="NestedSection"> <map src="OrderID" name="OrderID_MyLabel" /> <map src="OrderDate" name="OrderDate_MyLabel" /> </map> </settings>' */ )
Read CSV File from SharePoint Document Library (Parse Rows and Columns without downloading) [Read more...]
This example shows how to read a CSV file from SharePoint Document Library without downloading on the Disk (Streaming approach).
SELECT * from get_csv_file WITH( DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0' , FileId='root:/MyFolder/dump.csv:' --, ColumnDelimiter=',' --{LF}, {TAB}, | , \x0009 ... default is comma (",") --, HasColumnHeaderRow=0 --set for header less file --, FileId='root:/MyFolder/test_out.csv.gz:' --, FileCompressionType='GZip' --None, GZip, Zip )
Read Zip/Gzip Compressed CSV File from SharePoint Document Library (Parse Rows and Columns without downloading) [Read more...]
This example shows how to read a compressed CSV file (Zip or Gzip) from SharePoint Document Library without downloading on the Disk (Streaming approach).
SELECT * from get_csv_file WITH( DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0' , FileId='root:/MyFolder/dump.csv.zip:' --, ColumnDelimiter=',' --{LF}, {TAB}, | , \x0009 ... default is comma (",") --, HasColumnHeaderRow=0 --set for header less file --, FileId='root:/MyFolder/dump.csv.gz:' , FileCompressionType='Zip' --None, GZip, Zip )
Read JSON File from SharePoint Document Library (Parse Rows and Columns without downloading) [Read more...]
This example shows how to read a JSON file from SharePoint Document Library without downloading on Disk (Streaming approach).
SELECT * from get_json_file WITH( DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0' , FileId='root:/MyFolder/dump.json:' , Filter='$.store.books[*]' --or just blank (see help file for more filter examples) --to read compressed file use below way --, FileId='root:/MyFolder/dump.json.gz:' --, FileCompressionType='GZip' --None, GZip, Zip )
Read Zip/Gzip Compressed JSON File from SharePoint Document Library (Parse Rows and Columns without downloading) [Read more...]
This example shows how to read a compressed JSON file (Zip or Gzip) from SharePoint Document Library without downloading on the Disk (Streaming approach).
SELECT * from get_json_file WITH( DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0' , FileId='root:/MyFolder/dump.json.zip:' , Filter='$.store.books[*]' --or just blank (see help file for more filter examples) , FileCompressionType='Zip' --None, GZip, Zip )
Generic API Call - Update MultiChoice / Multi Select Lookup field in SharePoint List [Read more...]
This example shows how to make generic API call to update fields which allow multiple value selection in either Lookup or MultiChoice datatype. This example shows 2 types of fields. One is Multi Select e.g. MyMultiSelectLookupCol / MyMultiChoiceCol and another is Single select MySingleSelectCol (i.e. Dropdown). You must supply odata.type for Field. If its MultiChoice you can supply string ID/Value but set odata.type as Edm.String rather than Edm.Int32
SELECT * from generic_request WITH( Url='https://graph.microsoft.com/v1.0/sites/root/lists/1d3126af-14ca-46c7-a82a-4865873756c6/items/1' , RequestMethod='PATCH' , Filter='$.fields' , Headers='Content-Type: application/json || x-header2: abcd' , Body='{ "fields": { "MyMultiSelectLookupColLookupId@odata.type": "Collection(Edm.Int32)" ,"MyMultiSelectLookupColLookupId": [ 1 , 2 ] ,"MyMultiChoiceColumn@odata.type": "Collection(Edm.String)" ,"MyMultiChoiceColumn": [ "AAA" , "BBB" ] ,"MySingleChoiceColumnLookupId":1 } }' )
Move a File or Folder in SharePoint Document Library [Read more...]
This example shows how to move a file or folder to a different location in SharePoint Document Library. It also shows how to use Placeholder Functions to name file daynamically. For example to add timestamp it uses <<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>
SELECT * FROM move_rename_item WITH( --Source Site (Leave blank for default) -- SiteId='abc.sharepoint.com,5304daff-xxxxxxxxxx' --Source Drive , DriveId='b!0zqxxxxxxxxxxxxxxxxxxxxxxxx' --Item Id (File or Folder) you like to move or rename , ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW' --Target Site Id (Optional): Only needed if moving file to a different Site --, TargetSiteId='xyz.sharepoint.com,5304daff-xxxxxxxxxx' --Target Drive Id (Optional): Only needed if moving file to a different Drive --, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx' --Target Folder Id , TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN' --OR (for moving to root) --, TargetFolderId='root' --Target Item Name after Move (Optional): If you do not wish to change name after Move then do not supply below --, TargetItemName='new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf' --Uncomment Below if you get error. Usually needed for large file or cross site operations --, Prefer='respond-async' )
Rename a File or Folder in SharePoint Document Library [Read more...]
This example shows how to rename a file or folder and you can also move to a different location in SharePoint Document Library. It also shows how to use Placeholder Functions to name file daynamically. For example to add timestamp it uses <<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>
SELECT * FROM move_rename_item WITH( --Source Site (Leave blank for default) -- SiteId='abc.sharepoint.com,5304daff-xxxxxxxxxx' --Source Drive , DriveId='b!0zqxxxxxxxxxxxxxxxxxxxxxxxx' --Source Item you like to rename (File or Folder) , ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW' --Target Site Id (Optional): Only needed if moving file to a different Site --, TargetSiteId='xyz.sharepoint.com,5304daff-xxxxxxxxxx' --Target Drive Id (Optional): Only needed if moving file to a different Drive --, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx' --Target Folder (Optional): If you are doing just rename and moving to different location then keep it keep blank --, TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN' --, TargetFolderId='root' --Target Item Name (Required for rename) , TargetItemName='new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf' --Uncomment Below if you get error. Usually needed for large file or cross site operations --, Prefer='respond-async' )
Copy a File or Folder in SharePoint Document Library [Read more...]
This example shows how to copy a file or folder to a different location in SharePoint Document Library (In same Drive or different SharePoint Document Library). It also shows how to use Placeholder Functions to name file daynamically. For example to add timestamp it uses <<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>
SELECT * FROM copy_item WITH( --Source Site (Leave blank for default) -- SiteId='xxxx' --Source Drive , DriveId='b!0zqxxxxxxxxxxxxxxxxxxxxxxxx' --Source Item you like to copy , ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW' --Target Site (Optional) -- SiteId='abc.sharepoint.com,5304daff-xxxxxxxxxx' --Target Drive Id (Optional): Only needed if copying file to a different Drive (e.g. another User's drive) --, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx' --Target Folder where item will be copied , TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN' --OR-- --, TargetFolderId='root' --Target item name (Optional) - Only needed if new name needed after copy , TargetItemName='new_file_or_folder_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf' --,ConflictBehavior='replace' --fail, rename (Ignored if TargetItemName is not supplied) --Uncomment Below if you get error. Usually needed for large file or cross site operations --, Prefer='respond-async' )
Conclusion
In this article we discussed how to connect to SharePoint Online in PowerShell and integrate data without any coding. Click here to Download SharePoint Online Connector for PowerShell 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 PowerShell Documentation
More integrations
Other application integration scenarios for SharePoint Online
Other connectors for PowerShell
Download SharePoint Online Connector for PowerShell DocumentationHow to connect SharePoint Online in PowerShell?
How to get SharePoint Online data in PowerShell?
How to read SharePoint Online data in PowerShell?
How to load SharePoint Online data in PowerShell?
How to import SharePoint Online data in PowerShell?
How to pull SharePoint Online data in PowerShell?
How to push data to SharePoint Online in PowerShell?
How to write data to SharePoint Online in PowerShell?
How to POST data to SharePoint Online in PowerShell?
Call SharePoint Online API in PowerShell
Consume SharePoint Online API in PowerShell
SharePoint Online PowerShell Automate
SharePoint Online PowerShell Integration
Integration SharePoint Online in PowerShell
Consume real-time SharePoint Online data in PowerShell
Consume real-time SharePoint Online API data in PowerShell
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 PowerShell
Load SharePoint Online in PowerShell
Load SharePoint Online data in PowerShell
Read SharePoint Online data in PowerShell
SharePoint Online API Call in PowerShell