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
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:
Move or rename item (File or Folder) using API Source

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

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 [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_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 [LINKED_SERVER_TO_ONEDRIVE_IN_DATA_GATEWAY];