EndPoint List Files

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

list_files

Description

No description available [API reference]

Parameters

Parameter

Label

Required

Options

Description

DriveId

YES

Specify a drive

Filter

Record Filter (Client Side)

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)]
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/)]

SearchType

Search Type (Default=Recursive)

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)

Option	Value
/root:	/root:
/root:/somefolder/subfolder:	/root:/somefolder/subfolder:

OrderBy

Order By Field(s) - Only for Recursive SearchType

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	Data Type (SSIS)	Data Type (SQL)	Length	Raw
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
createdBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	False
createdBy_user_displayName	`DT_WSTR`	`nvarchar(100)`	100	False
lastModifiedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	False
lastModifiedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	False
parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	False
parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	False
parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	False
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
shared_scope	`DT_WSTR`	`nvarchar(100)`	100	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.