SharePoint Online Connector
Documentation
Version: 17
Documentation
Home » API Integration Hub » SharePoint Online Connector » EndPoints > Read Excel Worksheet (Auto Detect Range)

EndPoint Read Excel Worksheet (Auto Detect Range)

Name

get_excel_worksheet_autodetect

Description

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. [API reference]

Parameters

Parameter Label Required Options Description
DriveId Drive Id YES Specify a drive
FileId Excel File Id or Path (e.g. root:/somefolder/myfile.xlsx: ) - Max 200 Listed YES Specify a file Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xlsx: )
SheetId Sheet Id or Name (e.g. {00xx-xxx-xx123} -OR- Sheet1 ) YES Specify a sheet id or name (e.g. {00000000-0001-0000-0000-000000000000} -OR- Sheet1
SiteId Site Id (Re-Select Drive Id after you change this) NO Specify a site
SearchType Search Type (For UI Only - Default=Recursive - i.e. Blank) NO
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')
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).
SearchPath Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed NO 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).
AutoDetectByValue AutoDetectByValue NO
Option Value
true true
false false
Auto detect cell range based on values only and do not consider cell formatting (for empty values) to detect the range.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.