Back to DropboxFiles - Get Metadata
Returns the metadata for a file or folder.
Note: Metadata for the root folder is unsupported.
Input
type: object
properties:
data:
type: object
description: >
path: The path of a file or folder on Dropbox.
include_media_info: If true, :field:`FileMetadata.media_info` is set for
photo and video.
include_deleted: If true, :type:`DeletedMetadata` will be returned for
deleted file or folder, otherwise :field:`LookupError.not_found` will be
returned.
include_has_explicit_shared_members: If true, the results will include a
flag for each file indicating whether or not that file has any explicit
members.
include_property_groups: If set to a valid list of template IDs,
:field:`FileMetadata.property_groups` is set if there exists property data
associated with the file and each of the listed templates.
properties:
path:
type: string
description: The path of a file or folder on Dropbox.
include_has_explicit_shared_members:
type: boolean
description: >-
If true, the results will include a flag for each file indicating
whether or not that file has any explicit members.
include_property_groups:
type: object
description: >
filter_some: Only templates with an ID in the supplied list will be
returned (a subset of templates will be returned).
other: None
properties:
filter_some:
type: array
description: >-
Only templates with an ID in the supplied list will be returned (a
subset of templates will be returned).
items:
type: string
.tag:
title: Choice of TemplateFilterBase
type: string
enum:
- filter_some
- other
include_deleted:
type: boolean
description: >-
If true, :type:`DeletedMetadata` will be returned for deleted file or
folder, otherwise :field:`LookupError.not_found` will be returned.
include_media_info:
type: boolean
description: If true, :field:`FileMetadata.media_info` is set for photo and video.
title: Data
Output
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.