OneDrive Connector
Documentation
Version: 8
Documentation

EndPoint List Excel Worksheets of a File (i.e. List Tabs)


Name

list_excel_worksheets

Description

No description available

Parameters

Parameter Label Required Options Description
DriveId Drive Id / Shared Folder YES Specify a drive
FileId FileId -OR- Path YES Specify a file Id or Path. Syntax: [items/{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/myfile.xlsx: )
GroupOrUserId Default Group or User Id (additional Scopes needed to list - If fails enter manually) NO
Option Value
My self (Not Valid for Application Credentials)
For any group /groups/ENTER-GROUP-EMAIL-OR-ID
For any user /users/ENTER-USER-EMAIL-OR-ID
To list all users and groups from your organizations you need additional scopes. See connection UI - Choose User.Read.All and Group.Read.All Scopes and regenerate token. You can manually type value too if you know Group or User Id. Format is /users/{id} OR /groups/{id}
SearchType Search Type (For UI Only - Default=Recursive - i.e. Blank) NO
Option Value
Recursive All Files (Keep Blank) - For User Creds Only
Non-Recursive / Children - All Files 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')
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).

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(50) 50 False
Name DT_WSTR nvarchar(120) 120 False
Position DT_I4 int False
visibility DT_WSTR nvarchar(50) 50 False
OdataId DT_WSTR nvarchar(300) 300 False

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.