Back to DropboxFiles - Save Url - Check Job Status
Check the status of a :route:save_url
job.
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: Metadata of the file where the URL is saved to.
failed: None
properties:
failed:
type: object
description: |
path: None
download_failed: Failed downloading the given URL.
invalid_url: The given URL is invalid.
not_found: The file where the URL is saved to no longer exists.
other: None
properties:
path:
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 SaveUrlError
type: string
enum:
- path
- download_failed
- invalid_url
- not_found
- other
.tag:
title: Choice of SaveUrlJobStatus
type: string
enum:
- in_progress
- complete
- failed
complete:
type: object
description: >
name: The last component of the path (including extension). This never
contains a slash.
id: A unique identifier for the file.
client_modified: For files, this is the modification time set by the
desktop client when the file was added to Dropbox. Since this time is not
verified (the Dropbox server stores whatever the desktop client sends up),
this should only be used for display purposes (such as sorting) and not,
for example, to determine if a file has changed or not.
server_modified: The last time the file was modified on Dropbox.
rev: A unique identifier for the current revision of a file. This field is
the same rev as elsewhere in the API and can be used to detect changes and
avoid conflicts.
size: The file size in bytes.
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.
media_info: Additional information if the file is a photo or video.
symlink_info: Set if this file is a symlink.
sharing_info: Set if this file is contained in a shared folder.
property_groups: Additional information if the file has custom properties
with the property template specified.
has_explicit_shared_members: This flag will only be present if
include_has_explicit_shared_members is true in :route:`list_folder` or
:route:`get_metadata`. If this flag is present, it will be true if this
file has any explicit shared members. This is different from sharing_info
in that this could be true in the case where a file has explicit members
but is not contained within a shared folder.
content_hash: A hash of the file content. This field can be used to verify
data integrity. For more information see our :link:`Content hash
/developers/reference/content-hash` page.
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.
property_groups:
type: array
description: >-
Additional information if the file has custom properties with the
property template specified.
items:
type: object
description: >
A subset of the property fields described by the corresponding
:type:`PropertyGroupTemplate`. Properties are always added to a
Dropbox file as a :type:`PropertyGroup`. The possible key names and
value types in this group are defined by the corresponding
:type:`PropertyGroupTemplate`.
template_id: A unique identifier for the associated template.
fields: The actual properties associated with the template. There
can be up to 32 property types per template.
properties:
fields:
type: array
description: >-
The actual properties associated with the template. There can be
up to 32 property types per template.
items:
type: object
description: >
Raw key/value data to be associated with a Dropbox file.
Property fields are added to Dropbox files as a
:type:`PropertyGroup`.
name: Key of the property field associated with a file and
template. Keys can be up to 256 bytes.
value: Value of the property field associated with a file and
template. Values can be up to 1024 bytes.
properties:
name:
type: string
description: >-
Key of the property field associated with a file and
template. Keys can be up to 256 bytes.
value:
type: string
description: >-
Value of the property field associated with a file and
template. Values can be up to 1024 bytes.
template_id:
type: string
description: A unique identifier for the associated template.
rev:
type: string
description: >-
A unique identifier for the current revision of a file. This field is
the same rev as elsewhere in the API and can be used to detect changes
and avoid conflicts.
client_modified:
type: string
description: >-
For files, this is the modification time set by the desktop client
when the file was added to Dropbox. Since this time is not verified
(the Dropbox server stores whatever the desktop client sends up), this
should only be used for display purposes (such as sorting) and not,
for example, to determine if a file has changed or not.
symlink_info:
type: object
description: |
target: The target this symlink points to.
properties:
target:
type: string
description: The target this symlink points to.
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.
has_explicit_shared_members:
type: boolean
description: >-
This flag will only be present if include_has_explicit_shared_members
is true in :route:`list_folder` or :route:`get_metadata`. If this
flag is present, it will be true if this file has any explicit shared
members. This is different from sharing_info in that this could be
true in the case where a file has explicit members but is not
contained within a shared folder.
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.
server_modified:
type: string
description: The last time the file was modified on Dropbox.
sharing_info:
type: object
description: >
Sharing info for a file which is contained by a shared folder.
read_only: True if the file or folder is inside a read-only shared
folder.
parent_shared_folder_id: ID of shared folder that holds this file.
modified_by: The last user who modified the file. This field will be
null if the user's account has been deleted.
properties:
read_only:
type: boolean
description: True if the file or folder is inside a read-only shared folder.
parent_shared_folder_id:
type: string
description: ID of shared folder that holds this file.
modified_by:
type: string
description: >-
The last user who modified the file. This field will be null if
the user's account has been deleted.
media_info:
type: object
description: >
pending: Indicate the photo/video is still under processing and
metadata is not available yet.
metadata: The metadata for the photo/video.
properties:
.tag:
title: Choice of MediaInfo
type: string
enum:
- pending
- metadata
metadata:
type: object
description: |
Metadata for a photo or video.
dimensions: Dimension of the photo/video.
location: The GPS coordinate of the photo/video.
time_taken: The timestamp when the photo/video is taken.
properties:
dimensions:
type: object
description: |
Dimensions for a photo or video.
height: Height of the photo/video.
width: Width of the photo/video.
properties:
width:
type: number
description: Width of the photo/video.
height:
type: number
description: Height of the photo/video.
location:
type: object
description: |
GPS coordinates for a photo or video.
latitude: Latitude of the GPS coordinates.
longitude: Longitude of the GPS coordinates.
properties:
latitude:
type: number
description: Latitude of the GPS coordinates.
longitude:
type: number
description: Longitude of the GPS coordinates.
time_taken:
type: string
description: The timestamp when the photo/video is taken.
content_hash:
type: string
description: >-
A hash of the file content. This field can be used to verify data
integrity. For more information see our :link:`Content hash
/developers/reference/content-hash` page.
id:
type: string
description: A unique identifier for the file.
size:
type: number
description: The file size in bytes.