EndPoint Move or rename item (File or Folder)

Name

move_rename_item

Description

Move or rename an item (File or Folder) to a different location in the same drive or another drive (e.g. different Document Library)

Parameters

Parameter

Label

Required

Options

Description

Operation

YES

Option	Value
Move	Move
Rename	Rename

DriveId

Source Drive Id

YES

Specify a drive

ItemId

Source File or Folder Id you like to move or rename

YES

Specify an item Id you like to move or rename

SiteId

Source Site Id (Optional - Select if different than default site)

Specify a site

TargetSiteId

Target Site Id (Optional - Select if different than source SiteId)

Specify a site

TargetDriveId

Target DriveId (Optional - Select if different than source DriveId)

Specify a drive

TargetFolderId

Target Folder Id (e.g. 01R65Qxxxxxxx123 -OR- root) - Max 200 items listed

Specify a target folder where item should move after move or rename operation. If you are doing inplace rename and not doing move after rename then keep it blank

TargetItemName

Target Item Name (Optional for Move - e.g. Myfile.pdf or MyFolder)

Specify target item name you like to give after move or rename operation. If its move operation and you like to keep same item name as source then keep this blank.

SearchType

Source 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

Source 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).

TargetSearchType

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

Option	Value
Recursive All Files (Keep Blank) - For User Creds Only
Non-Recursive / Children - All Files	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).

TargetSearchPath

Target 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).

Prefer

Prefer Async Operation (Enable if you get error)

Option	Value
None
Async (Needed for Large files, Cross Site)	respond-async

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 SharePoint Online Connector in API Source component to read data or in API Destination component to read/write data:

Move or rename item (File or Folder) using API Source

SharePoint Online

Move or rename item (File or Folder)

SSIS API Source - Read from table or endpoint

Move or rename item (File or Folder) using API Destination

SharePoint Online

Move or rename item (File or Folder)

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Move a File or Folder in SharePoint Document Library

This example shows how to move a file or folder to a different location in SharePoint Document Library. It also shows how to use Placeholder Functions to name file daynamically. For example to add timestamp it uses <<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>

SELECT * FROM move_rename_item
WITH(
	--Source Site (Leave blank for default)
	-- SiteId='abc.sharepoint.com,5304daff-xxxxxxxxxx'
	
	--Source Drive
	, DriveId='b!0zqxxxxxxxxxxxxxxxxxxxxxxxx'
	
	--Item Id (File or Folder) you like to move or rename
	, ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW'

	--Target Site Id (Optional): Only needed if moving file to a different Site
	--, TargetSiteId='xyz.sharepoint.com,5304daff-xxxxxxxxxx'      
		  
	--Target Drive Id (Optional): Only needed if moving file to a different Drive
	--, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx'
	
	--Target Folder Id
	, TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN'
	--OR (for moving to root)
	--, TargetFolderId='root'

	--Target Item Name after Move (Optional): If you do not wish to change name after Move then do not supply below
	--, TargetItemName='new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf'  

	--Uncomment Below if you get error. Usually needed for large file or cross site operations
	--, Prefer='respond-async'
)

Rename a File or Folder in SharePoint Document Library

This example shows how to rename a file or folder and you can also move to a different location in SharePoint Document Library. It also shows how to use Placeholder Functions to name file daynamically. For example to add timestamp it uses <<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>

SELECT * FROM move_rename_item
WITH(
	--Source Site (Leave blank for default)
	-- SiteId='abc.sharepoint.com,5304daff-xxxxxxxxxx'
	
	--Source Drive
	, DriveId='b!0zqxxxxxxxxxxxxxxxxxxxxxxxx'

	--Source Item you like to rename (File or Folder)
	, ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW'

	--Target Site Id (Optional): Only needed if moving file to a different Site
	--, TargetSiteId='xyz.sharepoint.com,5304daff-xxxxxxxxxx'      
		  
	--Target Drive Id (Optional): Only needed if moving file to a different Drive
	--, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx'

	--Target Folder (Optional): If you are doing just rename and moving to different location then keep it keep blank
	--, TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN'
	--, TargetFolderId='root'

	--Target Item Name (Required for rename)
	, TargetItemName='new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf' 
	
	--Uncomment Below if you get error. Usually needed for large file or cross site operations
	--, Prefer='respond-async'
)

SQL Server

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

Move a File or Folder in SharePoint Document Library

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM move_rename_item
WITH(
	--Source Site (Leave blank for default)
	-- SiteId=''abc.sharepoint.com,5304daff-xxxxxxxxxx''
	
	--Source Drive
	, DriveId=''b!0zqxxxxxxxxxxxxxxxxxxxxxxxx''
	
	--Item Id (File or Folder) you like to move or rename
	, ItemId=''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''

	--Target Site Id (Optional): Only needed if moving file to a different Site
	--, TargetSiteId=''xyz.sharepoint.com,5304daff-xxxxxxxxxx''      
		  
	--Target Drive Id (Optional): Only needed if moving file to a different Drive
	--, TargetDriveId=''b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx''
	
	--Target Folder Id
	, TargetFolderId=''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
	--OR (for moving to root)
	--, TargetFolderId=''root''

	--Target Item Name after Move (Optional): If you do not wish to change name after Move then do not supply below
	--, TargetItemName=''new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf''  

	--Uncomment Below if you get error. Usually needed for large file or cross site operations
	--, Prefer=''respond-async''
)';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_SHAREPOINT_ONLINE_IN_DATA_GATEWAY];

Rename a File or Folder in SharePoint Document Library

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM move_rename_item
WITH(
	--Source Site (Leave blank for default)
	-- SiteId=''abc.sharepoint.com,5304daff-xxxxxxxxxx''
	
	--Source Drive
	, DriveId=''b!0zqxxxxxxxxxxxxxxxxxxxxxxxx''

	--Source Item you like to rename (File or Folder)
	, ItemId=''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''

	--Target Site Id (Optional): Only needed if moving file to a different Site
	--, TargetSiteId=''xyz.sharepoint.com,5304daff-xxxxxxxxxx''      
		  
	--Target Drive Id (Optional): Only needed if moving file to a different Drive
	--, TargetDriveId=''b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx''

	--Target Folder (Optional): If you are doing just rename and moving to different location then keep it keep blank
	--, TargetFolderId=''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
	--, TargetFolderId=''root''

	--Target Item Name (Required for rename)
	, TargetItemName=''new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf'' 
	
	--Uncomment Below if you get error. Usually needed for large file or cross site operations
	--, Prefer=''respond-async''
)';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_SHAREPOINT_ONLINE_IN_DATA_GATEWAY];