EndPoint List Folders

Contents

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

Name

list_folders

Description

No description available

Parameters

Parameter

Label

Required

Options

Description

DriveId

Drive Id

YES

Specify a drive

Filter

Record Filter (Client Side)

Option	Value
All Folders	$.value[?(@.folder.childCount !=null)]
All Folders Under a Specific Folder	$.value[?(@.folder.childCount !=null && @parentReference.id=='SOME-FOLDER-ID-GOES-HERE')]
Folder Name Equals	$.value[?(@.folder.childCount !=null && @name=='SOME-FOLDER-NAME-HERE')]
Folder Id Equals	$.value[?(@.folder.childCount !=null && @id=='SOME-FOLDER-ID-GOES-HERE')]
Folder Name Contains	$.value[?(@.folder.childCount !=null && @name=~/somename$/)]
Folder Name With Regex Pattern	$.value[?(@.folder.childCount !=null && @name=~/^somefolder_\d\d\d.txt$/)]
Folder Name With Regex Pattern (Multiple)	$.value[?(@.folder.childCount !=null && @name=~/somefolderAAA\|somefolderBBB/)]

SiteId

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

Specify a site

SearchType

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

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 *.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 Path (Default=Root Folder) - Max 200 items 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.