Back to DropboxFiles - Copy Reference - Get
Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to :route:copy_reference/save
.
Input
type: object
properties:
data:
type: object
description: |
path: The path to the file or folder you want to get a copy reference to.
properties:
path:
type: string
description: The path to the file or folder you want to get a copy reference to.
title: Data
Output
type: object
description: >
metadata: Metadata of the file or folder.
copy_reference: A copy reference to the file or folder.
expires: The expiration date of the copy reference. This value is currently
set to be far enough in the future so that expiration is effectively not an
issue.
properties:
expires:
type: string
description: >-
The expiration date of the copy reference. This value is currently set to
be far enough in the future so that expiration is effectively not an
issue.
copy_reference:
type: string
description: A copy reference to the file or folder.
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.