OneDrive Connector
Documentation
Version: 8
Documentation
Home » API Integration Hub » OneDrive Connector » EndPoints » Lists Folder Items (Non-Recursive Children)

EndPoint Lists Folder Items (Non-Recursive Children)

Name

list_folder

Description

No description available

Parameters

Parameter Label Required Options Description
DriveId Drive Id / Shared Folder YES Specify a drive
FolderId Folder Id or Path (e.g. root: -OR- root:/myfolder: ) - Max 200 items listed YES Specify a Folder Id -OR- Path. Syntax: [{folder-id}] -OR- [root:/{folder-path}:] (Example: root:/myfolder/subfolder: )
GroupOrUserId Default Group or User Id (additional Scopes needed to list - If fails enter manually) NO
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 (For UI Only - Default=Recursive - i.e. Blank) NO
Option Value
Recursive All Files (Keep Blank) - For User Creds Only
Non-Recursive / Children - All Files 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')
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 Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed NO This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder).

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:

Lists Folder Items (Non-Recursive Children) using API Source

OneDrive
Lists Folder Items (Non-Recursive Children)
SSIS API Source - Read from table or endpoint

Lists Folder Items (Non-Recursive Children) using API Destination

OneDrive
Lists Folder Items (Non-Recursive Children)
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

List items in a folder (Non-Recursive)

Lists items in a folder 

SELECT *
FROM list_folder
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!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0'
	--,FolderId='01R65QTTUIVFJ6HVJ2WBC37KCAOQRKX7PP' --exact Id of Folder
	--,FolderId='root' --default is root if FolderId is not passed
	--,FolderId='root:/Documents/My Projects:'
	--,FolderId='root:/Documents/My Projects/Sample Project:'
)		
--You can get DriveId by selecting from 'Drives' table.
--You can get FolderId by selecting from 'list_root' table OR selection from 'list_folder'.

List folders in a folder

Lists folders in a folder 

SELECT * FROM list_folder
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wa',
      FolderId='atLNa26LE0eYFa2BeNi1awa',
      Filter='$.value[?(@.folder)]')
--You can get DriveId by selecting from 'Drives' table.
--You can get FolderId by selecting from 'list_root' table OR selection from 'list_folder'.

List files in a folder

Lists files in a folder 

SELECT * FROM list_folder
WITH (DriveId='b!GtLN726LE0eY5F2BBNi14wa',
      FolderId='atLNa26LE0eYFa2BeNi1awa',
      Filter='$.value[?(@.file)]')
--You can get DriveId by selecting from 'Drives' table.
--You can get FolderId by selecting from 'list_root' table OR selection from 'list_folder'.

SQL Server

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

List items in a folder (Non-Recursive)

Lists items in a folder 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM list_folder
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!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0''
	--,FolderId=''01R65QTTUIVFJ6HVJ2WBC37KCAOQRKX7PP'' --exact Id of Folder
	--,FolderId=''root'' --default is root if FolderId is not passed
	--,FolderId=''root:/Documents/My Projects:''
	--,FolderId=''root:/Documents/My Projects/Sample Project:''
)		
--You can get DriveId by selecting from ''Drives'' table.
--You can get FolderId by selecting from ''list_root'' table OR selection from ''list_folder''.';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_GATEWAY];

List folders in a folder

Lists folders in a folder 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM list_folder
WITH (DriveId=''b!GtLN726LE0eY5F2BBNi14wa'',
      FolderId=''atLNa26LE0eYFa2BeNi1awa'',
      Filter=''$.value[?(@.folder)]'')
--You can get DriveId by selecting from ''Drives'' table.
--You can get FolderId by selecting from ''list_root'' table OR selection from ''list_folder''.';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_GATEWAY];

List files in a folder

Lists files in a folder 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM list_folder
WITH (DriveId=''b!GtLN726LE0eY5F2BBNi14wa'',
      FolderId=''atLNa26LE0eYFa2BeNi1awa'',
      Filter=''$.value[?(@.file)]'')
--You can get DriveId by selecting from ''Drives'' table.
--You can get FolderId by selecting from ''list_root'' table OR selection from ''list_folder''.';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_GATEWAY];