Endpoint

Get Item (File or Folder)

Name

get_item

Description

No description available

Parameters

Parameter

Label

Required

Options

Description

DriveId

Drive Id

YES

Specify a drive

ItemId

File/Folder Id or Path (e.g. root:/myfolder: -OR- root:/myfolder/file.xyz: ) - Max 1000 Listed

YES

Specify a File/Folder Id or Path (e.g. root:/myfolder/file.xyz: )

SiteId

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

Specify a site

SearchType

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

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 All - For User Creds Only	search(q='')
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 Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed

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`

If the column you are looking for is missing, consider customizing SharePoint Online Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use SharePoint Online Connector in API Source component to read data or in API Destination component to read/write data:

Get Item (File or Folder) using API Source

SharePoint Online

Get Item (File or Folder)

SSIS API Source - Read from table or endpoint

Get Item (File or Folder) using API Destination

SharePoint Online

Get Item (File or Folder)

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get item

SELECT * FROM get_item
WHERE Id = 'abcd-1234-itemid'
WITH
(
    "DriveId" = 'abcd-1234-driveid'
)

SQL Server

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

Get item

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_item
WHERE Id = ''abcd-1234-itemid''
WITH
(
    "DriveId" = ''abcd-1234-driveid''
)';

EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];