Reference

Endpoint Download File

Name

download_file

Description

No description available

Parameters

Parameter Required Options
Name: DriveId

Label: Drive Id / Shared Folder

Specify a drive 		YES
Name: FileId

Label: 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: ) 		YES
Name: GroupOrUserId

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}
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
Name: SearchType

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).
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')
Name: SearchPath

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).
Name: ConvertTo

Label: Convert to new format (e.g. pdf or html)

Use this option to download file and convert to another format (e.g. download excel file as pdf). See https://learn.microsoft.com/en-us/graph/api/driveitem-get-content-format?view=graph-rest-1.0 for more information. Supported Options are Convert to PDF from [csv, doc, docx, odp, ods, odt, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, rtf, xls, xlsx]. Convert to HTML from supported formats are [loop, fluid, wbtx]
Option Value
Do not convert
Convert To PDF pdf
Convert To HTML (source file must be *.loop, *.fluid, *.wbtx) html

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Status DT_WSTR nvarchar(4000) 4000
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
Download File
Required Parameters
Drive Id / Shared Folder Fill-in the parameter...
File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Fill-in the parameter...
SaveContentAsBinary Fill-in the parameter...
FileOverwriteMode Fill-in the parameter...
Target File Path (e.g. c:\somefolder\file.xlsx) 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 Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
Convert to new format (e.g. pdf or html)
RequestTimeoutMs 7200000
RawOutputDataRowTemplate {Status:'Downloaded'}
EnableRawOutputModeSingleRow True
SSIS API Source - Read from table or endpoint

API Destination

API Destination - OneDrive
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Download File
Required Parameters
Drive Id / Shared Folder Fill-in the parameter...
File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Fill-in the parameter...
SaveContentAsBinary Fill-in the parameter...
FileOverwriteMode Fill-in the parameter...
Target File Path (e.g. c:\somefolder\file.xlsx) 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 Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
Convert to new format (e.g. pdf or html)
RequestTimeoutMs 7200000
RawOutputDataRowTemplate {Status:'Downloaded'}
EnableRawOutputModeSingleRow True
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Download a file

<p>Downloads a file. Identify the file by ID or path and specify the local target path in the <code>WITH</code> clause. To convert to PDF or HTML, use the <code>download_file</code> endpoint with <code>ConvertTo</code> and <code>TargetFilePath</code>.</p> 

SELECT * FROM download_file
WITH (
      DriveId='me'
   --OR-- Use Shared Drive Id or other User's Drive Id
   --,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'

   --Enter file path (on root or under subfolder)
   --,FileId='root:/dump.pdf:'	--Path must end with colon
   --,FileId='root:/myfolder/dump.pdf:'
   --OR-- 
   --,FileId='01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX'
   
   ,TargetFilePath='C:\My files\Employees\List.xlsx'
   )
   --DriveId can be retrieved by selecting from 'list_drives' endpoint.
   --FileId can be retrieved by selecting from 'list_files' endpoint.

Download a file by path

<p>Downloads a file using its path (root or child folder). Supply <code>DriveId</code> and the path in the <code>WITH</code> clause.</p> 

SELECT * FROM download_file
WITH (
      DriveId='me'
   --OR-- Use Shared Drive Id or other User's Drive Id
   --,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'
   
   ,FileId='root:/dump.pdf:'   	--Path must end with colon

   --OR-- File from some child folder
   --,FileId='root:/myfolder/dump.pdf:'
   
   --OR-- use File Id
   --,FileId='01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX'
   
   ,TargetFilePath='C:\My files\Employees\List.xlsx'
)
--DriveId can be retrieved by selecting from 'list_drives' endpoint.
--FileId can be retrieved by selecting from 'list_files' endpoint.

Download file and convert to PDF or HTML

<p>Downloads a file and converts it to another format (e.g. PDF or HTML). Supply <code>DriveId</code>, <code>FileId</code>, <code>ConvertTo</code> (e.g. <code>pdf</code>, <code>html</code>), and <code>TargetFilePath</code>. Supported source formats include xlsx, docx, pptx, and others; unsupported conversion returns an error.</p> 

SELECT "Status"
FROM download_file
WITH(
     DriveId='me'
     --OR--
     --DriveId='b!7HBaTtrbekqMYJQ-OqV5Q3hrcOIQoyhGiAoWjqWFenIlIJ-Us7DMQ6jvyrsWMJPx'

	, FileId='01R65QTTTF7H7WMCHCKRFJGEJTXAEC7RGX'
	
	--Supported Source Formats: csv, doc, docx, odp, ods, odt, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, rtf, xls, xlsx
	, ConvertTo='pdf'
	, TargetFilePath='C:\temp\converted.pdf'
	
	--OR--
	--Supported Source Formats: loop, fluid, wbtx
	--, ConvertTo='html'
	--, TargetFilePath='C:\temp\converted.html'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Download a file

<p>Downloads a file. Identify the file by ID or path and specify the local target path in the <code>WITH</code> clause. To convert to PDF or HTML, use the <code>download_file</code> endpoint with <code>ConvertTo</code> and <code>TargetFilePath</code>.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM download_file
WITH (
      DriveId=''me''
   --OR-- Use Shared Drive Id or other User''s Drive Id
   --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''

   --Enter file path (on root or under subfolder)
   --,FileId=''root:/dump.pdf:''	--Path must end with colon
   --,FileId=''root:/myfolder/dump.pdf:''
   --OR-- 
   --,FileId=''01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX''
   
   ,TargetFilePath=''C:\My files\Employees\List.xlsx''
   )
   --DriveId can be retrieved by selecting from ''list_drives'' endpoint.
   --FileId can be retrieved by selecting from ''list_files'' endpoint.';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

Download a file by path

<p>Downloads a file using its path (root or child folder). Supply <code>DriveId</code> and the path in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM download_file
WITH (
      DriveId=''me''
   --OR-- Use Shared Drive Id or other User''s Drive Id
   --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''
   
   ,FileId=''root:/dump.pdf:''   	--Path must end with colon

   --OR-- File from some child folder
   --,FileId=''root:/myfolder/dump.pdf:''
   
   --OR-- use File Id
   --,FileId=''01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX''
   
   ,TargetFilePath=''C:\My files\Employees\List.xlsx''
)
--DriveId can be retrieved by selecting from ''list_drives'' endpoint.
--FileId can be retrieved by selecting from ''list_files'' endpoint.';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

Download file and convert to PDF or HTML

<p>Downloads a file and converts it to another format (e.g. PDF or HTML). Supply <code>DriveId</code>, <code>FileId</code>, <code>ConvertTo</code> (e.g. <code>pdf</code>, <code>html</code>), and <code>TargetFilePath</code>. Supported source formats include xlsx, docx, pptx, and others; unsupported conversion returns an error.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT "Status"
FROM download_file
WITH(
     DriveId=''me''
     --OR--
     --DriveId=''b!7HBaTtrbekqMYJQ-OqV5Q3hrcOIQoyhGiAoWjqWFenIlIJ-Us7DMQ6jvyrsWMJPx''

	, FileId=''01R65QTTTF7H7WMCHCKRFJGEJTXAEC7RGX''
	
	--Supported Source Formats: csv, doc, docx, odp, ods, odt, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, rtf, xls, xlsx
	, ConvertTo=''pdf''
	, TargetFilePath=''C:\temp\converted.pdf''
	
	--OR--
	--Supported Source Formats: loop, fluid, wbtx
	--, ConvertTo=''html''
	--, TargetFilePath=''C:\temp\converted.html''
)';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];