Dropbox

Links

    Dropbox API

    Getting access, Developing, Testing

    Back to Dropbox

    Files - Copy Batch

    Copy multiple files or folders to different locations at once in the user's Dropbox. If :field:RelocationBatchArg.allow_shared_folder is false, this route is atomic. If on entry failes, the whole transaction will abort. If :field:RelocationBatchArg.allow_shared_folder is true, not atomicity is guaranteed, but you will be able to copy the contents of shared folders to new locations. This route will return job ID immediately and do the async copy job in background. Please use :route:copy_batch/check to check the job status.

    Input

    type: object properties: data: type: object description: > entries: List of entries to be moved or copied. Each entry is :type:`RelocationPath`. allow_shared_folder: If true, :route:`copy_batch` will copy contents in shared folder, otherwise :field:`RelocationError.cant_copy_shared_folder` will be returned if :field:`RelocationPath.from_path` contains shared folder. This field is always true for :route:`move_batch`. autorename: If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict. allow_ownership_transfer: Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies. properties: allow_ownership_transfer: type: boolean description: >- Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies. allow_shared_folder: type: boolean description: >- If true, :route:`copy_batch` will copy contents in shared folder, otherwise :field:`RelocationError.cant_copy_shared_folder` will be returned if :field:`RelocationPath.from_path` contains shared folder. This field is always true for :route:`move_batch`. autorename: type: boolean description: >- If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict. entries: type: array description: >- List of entries to be moved or copied. Each entry is :type:`RelocationPath`. items: type: object description: | from_path: Path in the user's Dropbox to be copied or moved. to_path: Path in the user's Dropbox that is the destination. properties: from_path: type: string description: Path in the user's Dropbox to be copied or moved. to_path: type: string description: Path in the user's Dropbox that is the destination. title: Data

    Output

    type: object description: > Result returned by :route:`copy_batch` or :route:`move_batch` that may either launch an asynchronous job or complete synchronously. async_job_id: This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job. complete: None other: None properties: .tag: title: Choice of RelocationBatchLaunch type: string enum: - async_job_id - complete - other async_job_id: type: string description: >- This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job. complete: type: object description: | entries: None properties: entries: type: array items: type: object description: | metadata: Metadata of the relocated object. properties: metadata: type: object description: > Metadata for a file or folder. name: The last component of the path (including extension). This never contains a slash. path_lower: The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. path_display: The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. parent_shared_folder_id: Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. properties: parent_shared_folder_id: type: string description: >- Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. name: type: string description: >- The last component of the path (including extension). This never contains a slash. path_display: type: string description: >- The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. path_lower: type: string description: >- The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.