Endpoint List Excel Worksheets of a File (i.e. List Tabs)
Name
list_excel_worksheets
Description
Parameters
Parameter | Required | Options | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name:
Label: Drive Id / Shared Folder Specify a drive |
YES | |||||||||||||||
Name:
Label: FileId -OR- Path Specify a file Id or Path. Syntax: [items/{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/myfile.xlsx: ) |
YES | |||||||||||||||
Name:
Label: Default Group or User Id (additional Scopes needed to list - If fails enter manually) 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} |
|
|||||||||||||||
Name:
Label: 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). |
|
|||||||||||||||
Name:
Label: 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). |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(50)
|
50 | |
Name |
DT_WSTR
|
nvarchar(120)
|
120 | |
Position |
DT_I4
|
int
|
||
visibility |
DT_WSTR
|
nvarchar(50)
|
50 | |
OdataId |
DT_WSTR
|
nvarchar(300)
|
300 |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
Examples
SSIS
Use OneDrive Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
Required Parameters | |
---|---|
Drive Id / Shared Folder | Fill-in the parameter... |
FileId -OR- Path | Fill-in the parameter... |
Optional Parameters | |
Default Group or User Id (additional Scopes needed to list - If fails enter manually) | |
Search Type (For UI Only - Default=Recursive - i.e. Blank) | search(q='.xls') |
Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed |

API Destination
Required Parameters | |
---|---|
Drive Id / Shared Folder | Fill-in the parameter... |
FileId -OR- Path | Fill-in the parameter... |
Optional Parameters | |
Default Group or User Id (additional Scopes needed to list - If fails enter manually) | |
Search Type (For UI Only - Default=Recursive - i.e. Blank) | search(q='.xls') |
Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed |

ODBC application
Use these SQL queries in your ODBC application data source:
List Excel file Worksheets
Enumerates Worksheets that are part of Excel file
SELECT * FROM list_excel_worksheets
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14'
,FileId='01SUOJPKECYDDVFZWXXXXXXXXXXXXXXXXX')
--DriveId can be retrieved by selecting from 'list_drives' endpoint.
--FileId can be retrieved by selecting from 'list_excel_files' endpoint.
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
List Excel file Worksheets
Enumerates Worksheets that are part of Excel file
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM list_excel_worksheets
WITH (DriveId=''b!GtLN726LE0eY5F2BBNi14''
,FileId=''01SUOJPKECYDDVFZWXXXXXXXXXXXXXXXXX'')
--DriveId can be retrieved by selecting from ''list_drives'' endpoint.
--FileId can be retrieved by selecting from ''list_excel_files'' endpoint.';
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];