Reference

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

Parameters

Parameter Required Options
Name: Operation

Label: Operation

 YES
Option Value
Move Move
Rename Rename
Name: DriveId

Label: Source Drive Id

Specify a drive 		YES
Name: ItemId

Label: Source File or Folder Id you like to move or rename

Specify an item Id you like to move or rename 		YES
Name: GroupOrUserId

Label: Default Group or User Id (additional Scopes needed to list - If fails enter manually)

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}
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
Name: TargetDriveId

Label: Target Drive Id (Select if different than source DriveId)

Specify a drive
Name: TargetFolderId

Label: 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
Name: TargetItemName

Label: 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.
Name: SearchType

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

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).
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')
Name: SearchPath

Label: 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).
Name: TargetSearchType

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

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

Label: 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).
Name: Prefer

Label: 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 Description
id DT_WSTR nvarchar(500) 500
name DT_WSTR nvarchar(150) 150
size DT_I8 bigint
createdDateTime DT_DBTIMESTAMP datetime
lastModifiedDateTime DT_DBTIMESTAMP datetime
webUrl DT_WSTR nvarchar(1500) 1500
webUrlPath DT_WSTR nvarchar(1500) 1500
createdBy_user_id DT_WSTR nvarchar(200) 200
createdBy_user_email DT_WSTR nvarchar(150) 150
createdBy_user_displayName DT_WSTR nvarchar(100) 100
createdBy_application_id DT_WSTR nvarchar(200) 200
createdBy_application_displayName DT_WSTR nvarchar(100) 100
lastModifiedBy_user_id DT_WSTR nvarchar(200) 200
lastModifiedBy_user_email DT_WSTR nvarchar(150) 150
lastModifiedBy_user_displayName DT_WSTR nvarchar(150) 150
lastModifiedBy_application_id DT_WSTR nvarchar(200) 200
lastModifiedBy_application_displayName DT_WSTR nvarchar(150) 150
parentReference_id DT_WSTR nvarchar(200) 200
parentReference_driveId DT_WSTR nvarchar(400) 400
parentReference_driveType DT_WSTR nvarchar(100) 100
parentReference_name DT_WSTR nvarchar(200) 200 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
parentReference_path DT_WSTR nvarchar(1000) 1000 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
fileSystemInfo_lastModifiedDateTime DT_DBTIMESTAMP datetime
folder_childCount DT_I8 bigint
file_mimeType DT_WSTR nvarchar(300) 300
file_quickXorHash DT_WSTR nvarchar(200) 200
file_sha1Hash DT_WSTR nvarchar(200) 200
file_sha256Hash DT_WSTR nvarchar(200) 200
shared_scope DT_WSTR nvarchar(100) 100
remoteItem_parentReference_id DT_WSTR nvarchar(200) 200
remoteItem_parentReference_driveId DT_WSTR nvarchar(400) 400
remoteItem_parentReference_driveType DT_WSTR nvarchar(100) 100
remoteItem_parentReference_name DT_WSTR nvarchar(200) 200
remoteItem_parentReference_siteId DT_WSTR nvarchar(200) 200
remoteItem_parentReference_path DT_WSTR nvarchar(1000) 1000
remoteItem_shared_scope DT_WSTR nvarchar(100) 100
remoteItem_shared_sharedDateTime DT_DBTIMESTAMP datetime
remoteItem_sharedBy_user_id DT_WSTR nvarchar(200) 200
remoteItem_sharedBy_user_email DT_WSTR nvarchar(150) 150
remoteItem_sharedBy_user_displayName DT_WSTR nvarchar(150) 150
remoteItem_sharepointIds_listId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_listItemId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_listItemUniqueId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_siteId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_siteUrl DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_tenantId DT_WSTR nvarchar(200) 200
remoteItem_sharepointIds_webId DT_WSTR nvarchar(200) 200
id_path DT_WSTR nvarchar(200) 200
If the column you are looking for is missing, consider customizing OneDrive Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - OneDrive
OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!
OneDrive
Move or rename item (File or Folder)
Required Parameters
Operation Fill-in the parameter...
Source Drive Id Fill-in the parameter...
Source File or Folder Id you like to move or rename Fill-in the parameter...
Optional Parameters
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Target Drive Id (Select if different than source DriveId)
Target Folder Id (e.g. 01R65Qxxxxxxx123 -OR- root) - Max 200 items listed
Target Item Name (Optional for Move - e.g. Myfile.pdf or MyFolder)
Source Search Type (For UI Only - Default=Recursive - i.e. Blank)
Source Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
Target Search Type (For UI Only - Default=Recursive - i.e. Blank)
Target Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
Prefer Async Operation (Enable if you get error)
SSIS API Source - Read from table or endpoint

API Destination

API Destination - OneDrive
OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!
OneDrive
Move or rename item (File or Folder)
Required Parameters
Operation Fill-in the parameter...
Source Drive Id Fill-in the parameter...
Source File or Folder Id you like to move or rename Fill-in the parameter...
Optional Parameters
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Target Drive Id (Select if different than source DriveId)
Target Folder Id (e.g. 01R65Qxxxxxxx123 -OR- root) - Max 200 items listed
Target Item Name (Optional for Move - e.g. Myfile.pdf or MyFolder)
Source Search Type (For UI Only - Default=Recursive - i.e. Blank)
Source Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
Target Search Type (For UI Only - Default=Recursive - i.e. Blank)
Target Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
Prefer Async Operation (Enable if you get error)
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 OneDrive

This example shows how to move a file or folder to a different location in OneDrive. 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 Drive
	  DriveId='me'
	--OR--
	--DriveId='b!7HBaTtrbekqMYJQ-OqV5Q3hrcOIQoyhGiAoWjqWFenIlIJ-Us7DMQ6jvyrsWMJPx'
	
	--Source Item
	--Item Id (File or Folder) you like to move or rename
	, ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW'

	--Target Drive Id (Optional): Only needed if moving file to a different Drive (e.g. another User's drive)
	--, TargetDriveId='me'
	--OR
	--, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx'

	--Target Folder
	, TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN'
	--OR (for moving to root)
	--, TargetFolderId='root'
	
	--Target Item Name (New 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 OneDrive

This example shows how to rename a file or folder and you can also move to a different location in OneDrive.. 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 Drive
	DriveId='me'
	--OR--
	--DriveId='b!7HBaTtrbekqMYJQ-OqV5Q3hrcOIQoyhGiAoWjqWFenIlIJ-Us7DMQ6jvyrsWMJPx'

	--Source Item you like to rename or move
	, ItemId='01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW'

	--Target Drive Id (Optional): Only needed if moving file to a different Drive (e.g. another User's drive)
    --, TargetDriveId='me'
	--OR
	--, TargetDriveId='b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx'
	
	--Target Folder (Optional): If you are doing Rename and Move both in one action then supply new Folder Id too else keep it blank for just rename
	--, TargetFolderId='01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN'
	--, TargetFolderId='root'
	
	--Target Item Name (New name)
	, 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 OneDrive

This example shows how to move a file or folder to a different location in OneDrive. 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>> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM move_rename_item
WITH(
    --Source Drive
	  DriveId=''me''
	--OR--
	--DriveId=''b!7HBaTtrbekqMYJQ-OqV5Q3hrcOIQoyhGiAoWjqWFenIlIJ-Us7DMQ6jvyrsWMJPx''
	
	--Source Item
	--Item Id (File or Folder) you like to move or rename
	, ItemId=''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''

	--Target Drive Id (Optional): Only needed if moving file to a different Drive (e.g. another User''s drive)
	--, TargetDriveId=''me''
	--OR
	--, TargetDriveId=''b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx''

	--Target Folder
	, TargetFolderId=''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
	--OR (for moving to root)
	--, TargetFolderId=''root''
	
	--Target Item Name (New 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 [LS_TO_ONEDRIVE_IN_GATEWAY];

Rename a File or Folder in OneDrive

This example shows how to rename a file or folder and you can also move to a different location in OneDrive.. 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>> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM move_rename_item
WITH(
    --Source Drive
	DriveId=''me''
	--OR--
	--DriveId=''b!7HBaTtrbekqMYJQ-OqV5Q3hrcOIQoyhGiAoWjqWFenIlIJ-Us7DMQ6jvyrsWMJPx''

	--Source Item you like to rename or move
	, ItemId=''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''

	--Target Drive Id (Optional): Only needed if moving file to a different Drive (e.g. another User''s drive)
    --, TargetDriveId=''me''
	--OR
	--, TargetDriveId=''b!0zqXLXXJh0uxxxxxxxxxxxxxxxxxxxxx''
	
	--Target Folder (Optional): If you are doing Rename and Move both in one action then supply new Folder Id too else keep it blank for just rename
	--, TargetFolderId=''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
	--, TargetFolderId=''root''
	
	--Target Item Name (New name)
	, 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 [LS_TO_ONEDRIVE_IN_GATEWAY];