EndPoint List Files

Name

list_files

Description

No description available [API reference]

Parameters

Parameter

Label

Required

Options

Description

DriveId

Drive Id / Shared Folder

YES

Specify a drive

GroupOrUserId

Default Group or User Id (additional Scopes needed to list - If fails enter manually)

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 (Default=Recursive)

Option	Value
Recursive - All Files (Blank) - For User Creds Only	search(q='')
Non-Recursive / Children - All Files - For Non-Shared Items Only	children
Shared With Me (For DriveId 'me') - For User Creds Only	sharedWithMe
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 Path (Default=Root Folder) - Max 200 listed

OrderBy

Order By Field(s) - Only for Recursive SearchType

Option	Value
name	name
name desc	name desc
size	size
size desc	size desc
createdDateTime	createdDateTime
createdDateTime desc	createdDateTime desc
lastModifiedDateTime	lastModifiedDateTime
lastModifiedDateTime desc	lastModifiedDateTime desc

Order by Field(s) for output. You can order by single or multiple fields and use filed suffix asc for ascending and desc for descending order. For example to order by lastModifiedDateTime in descending order use lastModifiedDateTime desc. To order by nested field you can supply lastModifiedBy/user/email asc

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
id	`DT_WSTR`	`nvarchar(500)`	500	`False`
name	`DT_WSTR`	`nvarchar(150)`	150	`False`
size	`DT_I8`	`bigint`		`False`
createdDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
lastModifiedDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
webUrl	`DT_WSTR`	`nvarchar(1500)`	1500	`False`
webUrlPath	`DT_WSTR`	`nvarchar(1500)`	1500	`False`
createdBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
createdBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	`False`
createdBy_user_displayName	`DT_WSTR`	`nvarchar(100)`	100	`False`
createdBy_application_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
createdBy_application_displayName	`DT_WSTR`	`nvarchar(100)`	100	`False`
lastModifiedBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
lastModifiedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	`False`
lastModifiedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	`False`
lastModifiedBy_application_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
lastModifiedBy_application_displayName	`DT_WSTR`	`nvarchar(150)`	150	`False`
parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	`False`
parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	`False`
parentReference_name	`DT_WSTR`	`nvarchar(200)`	200	`False`	This is only returned when calling lookup or /children call (e.g. /items/root:/[folder-name] OR /items/[item-id] )
parentReference_siteId	`DT_WSTR`	`nvarchar(200)`	200	`False`
parentReference_path	`DT_WSTR`	`nvarchar(1000)`	1000	`False`	This is only returned when calling lookup or /children call (e.g. /items/root:/[folder-name] OR /items/[item-id] )
fileSystemInfo_createdDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
fileSystemInfo_lastModifiedDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
folder_childCount	`DT_I8`	`bigint`		`False`
file_mimeType	`DT_WSTR`	`nvarchar(300)`	300	`False`
file_quickXorHash	`DT_WSTR`	`nvarchar(200)`	200	`False`
file_sha1Hash	`DT_WSTR`	`nvarchar(200)`	200	`False`
file_sha256Hash	`DT_WSTR`	`nvarchar(200)`	200	`False`
shared_scope	`DT_WSTR`	`nvarchar(100)`	100	`False`
remoteItem_parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	`False`
remoteItem_parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	`False`
remoteItem_parentReference_name	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_parentReference_siteId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_parentReference_path	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
remoteItem_shared_scope	`DT_WSTR`	`nvarchar(100)`	100	`False`
remoteItem_shared_sharedDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
remoteItem_sharedBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	`False`
remoteItem_sharedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	`False`
remoteItem_sharepointIds_listId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_listItemId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_listItemUniqueId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_siteId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_siteUrl	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_tenantId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_webId	`DT_WSTR`	`nvarchar(200)`	200	`False`
id_path	`DT_WSTR`	`nvarchar(200)`	200	`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 OneDrive Connector in API Source component to read data or in API Destination component to read/write data:

List Files using API Source

OneDrive

List Files

SSIS API Source - Read from table or endpoint

List Files using API Destination

OneDrive

List Files

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

List files in a folder path (Recursive)

Use list_files endpoint to list files recursivly (list from child folder). However there are some limitations to list recursively, such as some new files may not appear right away or files not indexed wont show up.

SELECT * FROM list_files
WITH(
     Filter='$.value[*]' --list both files and folders
   --Filter='$.value[?(@.file.mimeType != null)]' --list only files
   --Filter='$.value[?(@.folder.childCount != null)]' --list only folders
	,DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-Sa5UzSpkaY9E'
  --,SearchPath='/root'	--folder path
  --,SearchPath='/root:/myfolder:'	--folder path
	,SearchPath='/root:/myfolder/subfolder:' --folder path nested
    ,OrderBy='lastModifiedDateTime desc'
)		
--You can get DriveId by selecting from 'Drives' table.
--You can get SearchPath by selecting from 'list_root' table OR selection from 'list_folder'.

List files from Group / other User's drive

This example shows how to read files from Group or other User's drive. You must use SearchType='children' for this purpose (known issue: recursive option may not work correctly in some cases).

SELECT * FROM list_files
WITH(
	  GroupOrUserId='/groups/138eb458-84f0-4928-bbe6-df663bd1fcea'
	, DriveId='b!VxnFPrt3C0GQnQ70Skx-p9_Eqvvac5pGhvqzoRdUpnZb-G5HVC0WTbLU3a89b4LJ'
	, SearchType='children'
	, SearchPath='/root:/folder/subfolder:'
	--, Filter='$.value[*]' --list both files and folders
	--, Filter='$.value[?(@.folder.childCount != null)]' --list only folders
)

SQL Server

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

List files in a folder path (Recursive)

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM list_files
WITH(
     Filter=''$.value[*]'' --list both files and folders
   --Filter=''$.value[?(@.file.mimeType != null)]'' --list only files
   --Filter=''$.value[?(@.folder.childCount != null)]'' --list only folders
	,DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-Sa5UzSpkaY9E''
  --,SearchPath=''/root''	--folder path
  --,SearchPath=''/root:/myfolder:''	--folder path
	,SearchPath=''/root:/myfolder/subfolder:'' --folder path nested
    ,OrderBy=''lastModifiedDateTime desc''
)		
--You can get DriveId by selecting from ''Drives'' table.
--You can get SearchPath by selecting from ''list_root'' table OR selection from ''list_folder''.';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_GATEWAY];

List files from Group / other User's drive

This example shows how to read files from Group or other User's drive. You must use SearchType='children' for this purpose (known issue: recursive option may not work correctly in some cases).

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM list_files
WITH(
	  GroupOrUserId=''/groups/138eb458-84f0-4928-bbe6-df663bd1fcea''
	, DriveId=''b!VxnFPrt3C0GQnQ70Skx-p9_Eqvvac5pGhvqzoRdUpnZb-G5HVC0WTbLU3a89b4LJ''
	, SearchType=''children''
	, SearchPath=''/root:/folder/subfolder:''
	--, Filter=''$.value[*]'' --list both files and folders
	--, Filter=''$.value[?(@.folder.childCount != null)]'' --list only folders
)';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_GATEWAY];