Reference

Endpoint List Files

Name

list_files

Description

No description available [API reference]

Related Tables

Files , FilesFolders , Folders , SharedWithMe (***DEPRECATED*** Not valid for Application Creds or other user)

Parameters

Parameter Required Options
Name: DriveId

Label: Drive Id / Shared Folder

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

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 (Blank) - For User Creds Only search(q='')
Non-Recursive / Children - All Files - For Non-Shared Items Only children
Shared With Me (For DriveId 'me') ***DEPRECATED*** - 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')
Name: SearchPath

Label: Search Path (Default=Root Folder) - Max 200 listed
Name: OrderBy

Label: Order By Field(s) - Only for Recursive SearchType

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
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

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
id DT_WSTR nvarchar(500) 500
name DT_WSTR nvarchar(150) 150
size DT_I8 bigint
createdDateTime DT_DBTIMESTAMP datetime
lastModifiedDateTime DT_DBTIMESTAMP datetime
webUrl DT_WSTR nvarchar(1500) 1500
webUrlPath DT_WSTR nvarchar(1500) 1500
createdBy_user_id DT_WSTR nvarchar(200) 200
createdBy_user_email DT_WSTR nvarchar(150) 150
createdBy_user_displayName DT_WSTR nvarchar(100) 100
createdBy_application_id DT_WSTR nvarchar(200) 200
createdBy_application_displayName DT_WSTR nvarchar(100) 100
lastModifiedBy_user_id DT_WSTR nvarchar(200) 200
lastModifiedBy_user_email DT_WSTR nvarchar(150) 150
lastModifiedBy_user_displayName DT_WSTR nvarchar(150) 150
lastModifiedBy_application_id DT_WSTR nvarchar(200) 200
lastModifiedBy_application_displayName DT_WSTR nvarchar(150) 150
parentReference_id DT_WSTR nvarchar(200) 200
parentReference_driveId DT_WSTR nvarchar(400) 400
parentReference_driveType DT_WSTR nvarchar(100) 100
parentReference_name DT_WSTR nvarchar(200) 200 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
parentReference_path DT_WSTR nvarchar(1000) 1000 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
fileSystemInfo_lastModifiedDateTime DT_DBTIMESTAMP datetime
folder_childCount DT_I8 bigint
file_mimeType DT_WSTR nvarchar(300) 300
file_quickXorHash DT_WSTR nvarchar(200) 200
file_sha1Hash DT_WSTR nvarchar(200) 200
file_sha256Hash DT_WSTR nvarchar(200) 200
shared_scope DT_WSTR nvarchar(100) 100
remoteItem_parentReference_id DT_WSTR nvarchar(200) 200
remoteItem_parentReference_driveId DT_WSTR nvarchar(400) 400
remoteItem_parentReference_driveType DT_WSTR nvarchar(100) 100
remoteItem_parentReference_name DT_WSTR nvarchar(200) 200
remoteItem_parentReference_siteId DT_WSTR nvarchar(200) 200
remoteItem_parentReference_path DT_WSTR nvarchar(1000) 1000
remoteItem_shared_scope DT_WSTR nvarchar(100) 100
remoteItem_shared_sharedDateTime DT_DBTIMESTAMP datetime
remoteItem_sharedBy_user_id DT_WSTR nvarchar(200) 200
remoteItem_sharedBy_user_email DT_WSTR nvarchar(150) 150
remoteItem_sharedBy_user_displayName DT_WSTR nvarchar(150) 150
remoteItem_sharepointIds_listId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_listItemId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_listItemUniqueId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_siteId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_siteUrl DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_tenantId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_webId DT_WSTR nvarchar(200) 200
id_path DT_WSTR nvarchar(500) 500
folder_path DT_WSTR nvarchar(500) 500
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

This Endpoint belongs to the Files table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - OneDrive
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Files
Required Parameters
Record Filter (Client Side) Fill-in the parameter...
Drive Id / Shared Folder Fill-in the parameter...
Optional Parameters
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Search Type (Default=Recursive) search(q='')
Search Path (Default=Root Folder) - Max 200 listed /root
Order By Field(s) - Only for Recursive SearchType
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Files table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to list files:

API Destination - OneDrive
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Files
Select
Required Parameters
Record Filter (Client Side) Fill-in the parameter...
Drive Id / Shared Folder Fill-in the parameter...
Optional Parameters
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Search Type (Default=Recursive) search(q='')
Search Path (Default=Root Folder) - Max 200 listed /root
Order By Field(s) - Only for Recursive SearchType
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read files in a folder path (recursive)

<p>Gets files in a folder and its subfolders. Use <code>list_files</code> with <code>DriveId</code>, <code>SearchPath</code> (e.g. /root:/myfolder/subfolder:), and optional <code>Filter</code> and <code>OrderBy</code>. New or non-indexed files may not appear immediately.</p> 

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='me'
  --OR-- Use Shared Drive Id or other User's Drive Id
  --,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'
  --,SearchPath='/root'	--folder path
  --,SearchPath='/root:/myfolder:'	--folder path (make sure to start with slash and end with colon)
	,SearchPath='/root:/myfolder/subfolder:' --folder path nested (make sure to start with slash and end with colon)
    ,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'.

Read files from group or other user's drive

<p>Gets files from a group or another user's drive. Use <code>SearchType='children'</code> (recursive may not work in all cases). Supply <code>GroupOrUserId</code>, <code>DriveId</code>, and <code>SearchPath</code>.</p> 

SELECT * FROM list_files
WITH(
	  GroupOrUserId='/groups/138eb458-84f0-4928-bbe6-df663bd1fcea'
	, DriveId='me'
  --OR-- Use Shared Drive Id or other User's Drive Id
  --,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'
  
	, SearchType='children'
	, SearchPath='/root:/folder/subfolder:'
  --, Filter='$.value[*]' --list both files and folders
  --, Filter='$.value[?(@.folder.childCount != null)]' --list only folders
)

Read all files (recursive)

<p>Gets all files recursively from the default drive. Use this when you need a flat list of every file under a drive. For a single folder (non-recursive) or to filter by path, use the <code>list_root</code> or <code>list_files</code> table with <code>DriveId</code> and <code>SearchPath</code>.</p> 

SELECT * FROM Files

Read all files and folders (recursive)

<p>Gets all files and folders recursively in a single result set. Use when you need both file and folder items from the whole drive. To limit by path or drive, supply <code>DriveId</code> and <code>SearchPath</code> with the <code>list_root</code> or <code>list_files</code> table.</p> 

SELECT * FROM FilesFolders

Read all folders (recursive)

<p>Gets all folders recursively (no files). Use this when you need only folder metadata or the folder tree. For files and folders together use Read all files and folders.</p> 

SELECT * FROM Folders

Read files and folders shared with me

<p>Gets files and folders shared with the current user. To list items inside a shared folder use the <code>FilesFolders</code> table with <code>DriverId</code> (from <code>SharedWithMe</code>) and optional <code>SearchPath</code> (e.g. /root:/folder/subfolder:).</p> 

SELECT * FROM SharedWithMe

list_files endpoint belongs to Files , FilesFolders , Folders , SharedWithMe table(s), and can therefore be used via those table(s).

SQL Server

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

Read files in a folder path (recursive)

<p>Gets files in a folder and its subfolders. Use <code>list_files</code> with <code>DriveId</code>, <code>SearchPath</code> (e.g. /root:/myfolder/subfolder:), and optional <code>Filter</code> and <code>OrderBy</code>. New or non-indexed files may not appear immediately.</p> 

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=''me''
  --OR-- Use Shared Drive Id or other User''s Drive Id
  --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''
  --,SearchPath=''/root''	--folder path
  --,SearchPath=''/root:/myfolder:''	--folder path (make sure to start with slash and end with colon)
	,SearchPath=''/root:/myfolder/subfolder:'' --folder path nested (make sure to start with slash and end with colon)
    ,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 [LS_TO_ONEDRIVE_IN_GATEWAY];

Read files from group or other user's drive

<p>Gets files from a group or another user's drive. Use <code>SearchType='children'</code> (recursive may not work in all cases). Supply <code>GroupOrUserId</code>, <code>DriveId</code>, and <code>SearchPath</code>.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM list_files
WITH(
	  GroupOrUserId=''/groups/138eb458-84f0-4928-bbe6-df663bd1fcea''
	, DriveId=''me''
  --OR-- Use Shared Drive Id or other User''s Drive Id
  --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''
  
	, SearchType=''children''
	, SearchPath=''/root:/folder/subfolder:''
  --, Filter=''$.value[*]'' --list both files and folders
  --, Filter=''$.value[?(@.folder.childCount != null)]'' --list only folders
)';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

Read all files (recursive)

<p>Gets all files recursively from the default drive. Use this when you need a flat list of every file under a drive. For a single folder (non-recursive) or to filter by path, use the <code>list_root</code> or <code>list_files</code> table with <code>DriveId</code> and <code>SearchPath</code>.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Files';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

Read all files and folders (recursive)

<p>Gets all files and folders recursively in a single result set. Use when you need both file and folder items from the whole drive. To limit by path or drive, supply <code>DriveId</code> and <code>SearchPath</code> with the <code>list_root</code> or <code>list_files</code> table.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM FilesFolders';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

Read all folders (recursive)

<p>Gets all folders recursively (no files). Use this when you need only folder metadata or the folder tree. For files and folders together use Read all files and folders.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Folders';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

Read files and folders shared with me

<p>Gets files and folders shared with the current user. To list items inside a shared folder use the <code>FilesFolders</code> table with <code>DriverId</code> (from <code>SharedWithMe</code>) and optional <code>SearchPath</code> (e.g. /root:/folder/subfolder:).</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM SharedWithMe';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];

list_files endpoint belongs to Files , FilesFolders , Folders , SharedWithMe table(s), and can therefore be used via those table(s).