Reference

Endpoint Copy item (File or Folder)

Name

copy_item

Description

Copy an item (File or Folder) to a different location in the same drive or another drive (e.g. different User's drive)

Parameters

Parameter Required Options
Name: DriveId

Label: Source Drive Id

Specify a drive 		YES
Name: ItemId

Label: Source File or Folder Id you like to copy

Specify an item Id you like to copy 		YES
Name: TargetType

Label: Target Type (i.e. Path or Id)

Specify how you like to supply Target Folder (i.e. By Id or Path). Default is by Id 		YES
Option Value
Id Id
Path Path
Name: TargetFolderId

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

Specify a target folder where item should be copied 		YES
Name: TargetFolderPath

Label: Target Folder Path (e.g. /myfolder -OR- /myfolder/subfolder) - Max 200 items listed

Specify a target folder path where item should be copied. Keep it blank for root target 		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 DriveId (Optional - Select if different than source DriveId)

Specify a drive
Name: TargetItemName

Label: Target Item Name (Optional)

Specify target item name you like to give after copy operation. Keep it blank if you like to keep same name as source.
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
Name: ConflictBehavior

Label: Conflict Behavior (What to do if file exists at target location)

Default ConflictBehavior is fail if file exists. The conflictBehavior is not supported for OneDrive Consumer. Also it will not fail if TargetItemName same as source file name
Option Value
fail fail
replace replace
rename rename

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Status DT_WSTR nvarchar(4000) 4000
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
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Copy item (File or Folder)
Required Parameters
Source Drive Id Fill-in the parameter...
Source File or Folder Id you like to copy Fill-in the parameter...
Target Type (i.e. Path or Id) Fill-in the parameter...
Target Folder Id (e.g. 01R65Qxxxxxxx123 -OR- root) - Max 200 items listed Fill-in the parameter...
Target Folder Path (e.g. /myfolder -OR- /myfolder/subfolder) - Max 200 items listed Fill-in the parameter...
Optional Parameters
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Target DriveId (Optional - Select if different than source DriveId)
Target Item Name (Optional)
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)
Conflict Behavior (What to do if file exists at target location)
RawOutputDataRowTemplate {Status:'Done'}
EnableRawOutputModeSingleRow True
SSIS API Source - Read from table or endpoint

API Destination

API Destination - OneDrive
Read and write Microsoft OneDrive data effortlessly. Integrate, manage, and automate files and folders — almost no coding required.
OneDrive
Copy item (File or Folder)
Required Parameters
Source Drive Id Fill-in the parameter...
Source File or Folder Id you like to copy Fill-in the parameter...
Target Type (i.e. Path or Id) Fill-in the parameter...
Target Folder Id (e.g. 01R65Qxxxxxxx123 -OR- root) - Max 200 items listed Fill-in the parameter...
Target Folder Path (e.g. /myfolder -OR- /myfolder/subfolder) - Max 200 items listed Fill-in the parameter...
Optional Parameters
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Target DriveId (Optional - Select if different than source DriveId)
Target Item Name (Optional)
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)
Conflict Behavior (What to do if file exists at target location)
RawOutputDataRowTemplate {Status:'Done'}
EnableRawOutputModeSingleRow True
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Copy a file or folder

<p>Copies a file or folder to another location, either within the same drive or to another drive. You can give the copy a new name; placeholder functions (e.g. <code>&lt;&lt;FUN_NOW&gt;&gt;</code>) are supported for dynamic target names. If the target already exists, use <code>ConflictBehavior</code> to replace or rename.</p> 

SELECT *
FROM copy_item
WITH
(
    -- ##### SOURCE #####
    -- Source Drive
    , DriveId = 'me'
    -- OR use another user's / shared drive
    -- , DriveId = 'b!0zqXXXXXXXXXXXXXXXXXXXXXXXX'

    -- Item to copy (choose ONE)
    -- Path format: root:/path/to/item:
    , ItemId  = 'root:/myfile.pdf:'
	-- , ItemId  = 'root:/myfolder/myfile.pdf:'
    -- , ItemId = '01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW'  -- by ID (preferred)

    -- ##### TARGET #####
    -- Target Drive (only required when copying across drives)
    -- , TargetDriveId = 'me'
    -- , TargetDriveId = 'b!0zqXLXXJh0uXXXXXXXXXXXXxxxxxxxxx'

    -- ##### TARGET FOLDER #####
    -- Choose ONE format: Path OR Id

    , TargetType       = 'Path'
     , TargetFolderPath = '/myfolder/subfolder'	
    -- , TargetFolderPath = '/myfolder/export_<<yyyy-MM-dd,FUN_NOW>>'  -- folder must exist

    -- , TargetType     = 'Id'
    -- , TargetFolderId = '01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN'
    -- , TargetFolderId = 'root'

    -- ##### OPTIONS #####
    -- New name for copied item (omit to keep source name)
    , TargetItemName =
        'new_file_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf'

    -- What to do if target item already exists
    -- Ignored if TargetItemName is supplied
    -- , ConflictBehavior = 'replace'    -- fail | rename | replace

    -- Required for large items or cross-drive copies (async)
    -- , Prefer = 'respond-async'
);

SQL Server

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

Copy a file or folder

<p>Copies a file or folder to another location, either within the same drive or to another drive. You can give the copy a new name; placeholder functions (e.g. <code>&lt;&lt;FUN_NOW&gt;&gt;</code>) are supported for dynamic target names. If the target already exists, use <code>ConflictBehavior</code> to replace or rename.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM copy_item
WITH
(
    -- ##### SOURCE #####
    -- Source Drive
    , DriveId = ''me''
    -- OR use another user''s / shared drive
    -- , DriveId = ''b!0zqXXXXXXXXXXXXXXXXXXXXXXXX''

    -- Item to copy (choose ONE)
    -- Path format: root:/path/to/item:
    , ItemId  = ''root:/myfile.pdf:''
	-- , ItemId  = ''root:/myfolder/myfile.pdf:''
    -- , ItemId = ''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''  -- by ID (preferred)

    -- ##### TARGET #####
    -- Target Drive (only required when copying across drives)
    -- , TargetDriveId = ''me''
    -- , TargetDriveId = ''b!0zqXLXXJh0uXXXXXXXXXXXXxxxxxxxxx''

    -- ##### TARGET FOLDER #####
    -- Choose ONE format: Path OR Id

    , TargetType       = ''Path''
     , TargetFolderPath = ''/myfolder/subfolder''	
    -- , TargetFolderPath = ''/myfolder/export_<<yyyy-MM-dd,FUN_NOW>>''  -- folder must exist

    -- , TargetType     = ''Id''
    -- , TargetFolderId = ''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
    -- , TargetFolderId = ''root''

    -- ##### OPTIONS #####
    -- New name for copied item (omit to keep source name)
    , TargetItemName =
        ''new_file_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf''

    -- What to do if target item already exists
    -- Ignored if TargetItemName is supplied
    -- , ConflictBehavior = ''replace''    -- fail | rename | replace

    -- Required for large items or cross-drive copies (async)
    -- , Prefer = ''respond-async''
);';

EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];