SharePoint Online Connector
Documentation
Version: 14
Documentation
Home » API Integration Hub » SharePoint Online Connector » EndPoints > List Files

EndPoint List Files

Name

list_files

Description

No description available [API Help]

Parameters

Parameter Label Required Options Description
Filter Record Filter (Client Side) NO
Option Value
All Files $.value[?(@.file.mimeType != null)]
All Files Under a Specific Folder $.value[?(@.file.mimeType != null && @parentReference.id=='SOME-FOLDER-ID-GOES-HERE')]
All Folders $.value[?(@.folder.childCount != null)]
All Files and Folders $.value[*]
File Name Equals $.value[?(@.file.mimeType != null && @name=='somefile.txt')]
File Id Equals $.value[?(@.file.mimeType != null && @id=='SOME-FILE-ID-GOES-HERE')]
File Name Contains $.value[?(@.file.mimeType != null && @name=~/somename$/)]
File Name With Regex Pattern $.value[?(@.file.mimeType != null && @name=~/^somefile_\d\d\d.txt$/)]
File Name With Regex Pattern (Multiple) $.value[?(@.file.mimeType != null && @name=~/somefile.txt|somefile.json/)]
SiteId SiteId NO Specify a site
DriveId DriveId YES Specify a drive
SearchType Search Type (Default=Recursive) NO
Option Value
Recursive search(q='')
NonRecursive children
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) NO
Option Value
/root: /root:
/root:/somefolder/subfolder: /root:/somefolder/subfolder:
OrderBy Order By Field(s) - Only for Recursive SearchType NO
Option Value
id id
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 DataType Length Raw Description
id DT_WSTR 500 False
name DT_WSTR 150 False
size DT_I8 0 False
createdDateTime DT_DBTIMESTAMP 0 False
lastModifiedDateTime DT_DBTIMESTAMP 0 False
webUrl DT_WSTR 1500 False
createdBy_user_email DT_WSTR 150 False
createdBy_user_displayName DT_WSTR 100 False
lastModifiedBy_user_email DT_WSTR 150 False
lastModifiedBy_user_displayName DT_WSTR 150 False
parentReference_driveId DT_WSTR 400 False
parentReference_driveType DT_WSTR 100 False
parentReference_id DT_WSTR 200 False
fileSystemInfo_createdDateTime DT_DBTIMESTAMP 0 False
fileSystemInfo_lastModifiedDateTime DT_DBTIMESTAMP 0 False
folder_childCount DT_I8 0 False
file_mimeType DT_WSTR 300 False
shared_scope DT_WSTR 100 False

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.