EndPoint Download File

Name

download_file_to_disk

Description

No description available

Parameters

Parameter

Label

Required

Options

Description

DriveId

Drive Id

YES

Specify a drive

FileId

File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed

YES

Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: )

SiteId

Site Id (Re-Select Drive Id after you change this)

Specify a site

SearchType

Search Type - For UI Only (i.e. Recursive -OR- Non-Recursive) - Default=Recursive)

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 All - For User Creds Only	search(q='')
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

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
Status	`DT_WSTR`	`nvarchar(4000)`	4000	`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.

Examples

SSIS

Use SharePoint Online Connector in API Source component to read data or in API Destination component to read/write data:

Download File using API Source

SharePoint Online

Download File

SSIS API Source - Read from table or endpoint

Download File using API Destination

SharePoint Online

Download File

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Download a file to a local disk from a SharePoint document library

SELECT * FROM download_file_to_disk
    WITH(
      DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMxxxxxxxxxxxxx'
    , FileId='01SUOJPKDXTQL2XI2EIFDYZxxxxxxxxxxxxx'
    , TargetFilePath='C:\temp\List.xlsx'
    --, FileOverwriteMode='FailIfExists' //change default overwrite mode from AlwaysOverwrite to FailIfExists
    )
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.

SQL Server

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

Download a file to a local disk from a SharePoint document library

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM download_file_to_disk
    WITH(
      DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMxxxxxxxxxxxxx''
    , FileId=''01SUOJPKDXTQL2XI2EIFDYZxxxxxxxxxxxxx''
    , TargetFilePath=''C:\temp\List.xlsx''
    --, FileOverwriteMode=''FailIfExists'' //change default overwrite mode from AlwaysOverwrite to FailIfExists
    )
--DriveId can be retrieved by selecting from ''Drives'' table.
--FileId can be retrieved by selecting from ''list_files'' endpoint.';

EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];