Dropbox

Links

    Dropbox API

    Getting access, Developing, Testing

    Back to Dropbox

    Files - Delete Batch - Check

    Returns the status of an asynchronous job for :route:delete_batch. If success, it returns list of result for each entry.

    Input

    type: object properties: data: type: object description: > Arguments for methods that poll the status of an asynchronous job. async_job_id: Id of the asynchronous job. This is the value of a response returned from the method that launched the job. properties: async_job_id: type: string description: >- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. title: Data

    Output

    type: object description: | in_progress: The asynchronous job is still in progress. complete: The batch delete has finished. failed: The batch delete has failed. other: None properties: failed: type: object description: > too_many_write_operations: Use :field:`DeleteError.too_many_write_operations`. :route:`delete_batch` now provides smaller granularity about which entry has failed because of this. other: None properties: .tag: title: Choice of DeleteBatchError type: string enum: - too_many_write_operations - other .tag: title: Choice of DeleteBatchJobStatus type: string enum: - in_progress - complete - failed - other complete: type: object description: | entries: None properties: entries: type: array items: type: object description: | success: None failure: None properties: failure: type: object description: > path_lookup: None path_write: None too_many_write_operations: There are too many write operations in user's Dropbox. Please retry this request. too_many_files: There are too many files in one request. Please retry with fewer files. other: None properties: path_lookup: type: object description: > malformed_path: None not_found: There is nothing at the given path. not_file: We were expecting a file, but the given path refers to something that isn't a file. not_folder: We were expecting a folder, but the given path refers to something that isn't a folder. restricted_content: The file cannot be transferred because the content is restricted. For example, sometimes there are legal restrictions due to copyright claims. other: None properties: malformed_path: type: string .tag: title: Choice of LookupError type: string enum: - malformed_path - not_found - not_file - not_folder - restricted_content - other .tag: title: Choice of DeleteError type: string enum: - path_lookup - path_write - too_many_write_operations - too_many_files - other path_write: type: object description: > malformed_path: None conflict: Couldn't write to the target path because there was something in the way. no_write_permission: The user doesn't have permissions to write to the target location. insufficient_space: The user doesn't have enough available space (bytes) to write more data. disallowed_name: Dropbox will not save the file or folder because of its name. team_folder: This endpoint cannot move or delete team folders. too_many_write_operations: There are too many write operations in user's Dropbox. Please retry this request. other: None properties: malformed_path: type: string .tag: title: Choice of WriteError type: string enum: - malformed_path - conflict - no_write_permission - insufficient_space - disallowed_name - team_folder - too_many_write_operations - other conflict: type: object description: > file: There's a file in the way. folder: There's a folder in the way. file_ancestor: There's a file at an ancestor path, so we couldn't create the required parent folders. other: None properties: .tag: title: Choice of WriteConflictError type: string enum: - file - folder - file_ancestor - other .tag: title: Choice of DeleteBatchResultEntry type: string enum: - success - failure success: type: object description: | metadata: Metadata of the deleted 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.