Endpoint Read Excel Worksheet (From Exact Range)
Name
get_excel_worksheet
Description
Parameters
| Parameter | Required | Options | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: Drive Id / Shared Folder Specify a drive |
YES | |||||||||||||||
|
Name:
Label: 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: ) |
YES | |||||||||||||||
|
Name:
Label: 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 |
YES | |||||||||||||||
|
Name:
Label: Range |
YES | |||||||||||||||
|
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
If the column you are looking for is missing, consider customizing OneDrive Connector.
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
API Source - OneDrive
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Read Excel Worksheet (From Exact Range)
| Required Parameters | |
|---|---|
| Drive Id / Shared Folder | Fill-in the parameter... |
| Excel File Id or Path (e.g. root:/somefolder/myfile.xlsx: ) - Max 200 Listed | Fill-in the parameter... |
| Sheet Id or Name (e.g. {00xx-xxx-xx123} -OR- Sheet1 ) | Fill-in the parameter... |
| Read Filter (i.e. get value OR text OR formula) | Fill-in the parameter... |
| Range | Fill-in the parameter... |
| First Row Has Column Names | Fill-in the parameter... |
| Optional Parameters | |
| 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 | |
| ArrayTransformType | TransformColumnslessArray |
API Destination
API Destination - OneDrive
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Read Excel Worksheet (From Exact Range)
| Required Parameters | |
|---|---|
| Drive Id / Shared Folder | Fill-in the parameter... |
| Excel File Id or Path (e.g. root:/somefolder/myfile.xlsx: ) - Max 200 Listed | Fill-in the parameter... |
| Sheet Id or Name (e.g. {00xx-xxx-xx123} -OR- Sheet1 ) | Fill-in the parameter... |
| Read Filter (i.e. get value OR text OR formula) | Fill-in the parameter... |
| Range | Fill-in the parameter... |
| First Row Has Column Names | Fill-in the parameter... |
| Optional Parameters | |
| 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 | |
| ArrayTransformType | TransformColumnslessArray |
ODBC application
Use these SQL queries in your ODBC application data source:
Read Excel worksheet data for a cell range
<p>Gets data from an Excel worksheet for a specified cell range. Supply the range (e.g. A1:D10). For auto-detect range use the get_excel_worksheet_autodetect endpoint.</p>
SELECT * FROM get_excel_worksheet
WITH (
DriveId='me'
--OR-- Use Shared Drive Id or other User's Drive Id
--,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'
,FileId='root:/MyFolder/Book1.xlsx:' --Path must end with colon
--OR Use File Id
--,FileId='01SUOJPFXXXXXXXXXXXXXXXXXX'
,SheetId='Sheet1'
--OR-- Use Sheet ID - Using ID is good idea if Sheet ever renamed (Id doesnt change)
--,SheetId='{00000000-0001-0000-0000-000000000000}'
,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.SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read Excel worksheet data for a cell range
<p>Gets data from an Excel worksheet for a specified cell range. Supply the range (e.g. A1:D10). For auto-detect range use the get_excel_worksheet_autodetect endpoint.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_excel_worksheet
WITH (
DriveId=''me''
--OR-- Use Shared Drive Id or other User''s Drive Id
--,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''
,FileId=''root:/MyFolder/Book1.xlsx:'' --Path must end with colon
--OR Use File Id
--,FileId=''01SUOJPFXXXXXXXXXXXXXXXXXX''
,SheetId=''Sheet1''
--OR-- Use Sheet ID - Using ID is good idea if Sheet ever renamed (Id doesnt change)
--,SheetId=''{00000000-0001-0000-0000-000000000000}''
,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.';
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];