close anchor

File

The file data object.

Data Fields

Field Type Description
id string The UUID of the file object for data is being provided.
date_time object The init and edit date/time this entry was initially posted, and that of its latest known edit or update, both provided in ISO 8601 format.
name string The file name provided on initial upload. This is not identical to the optional title provided below.
type string The file type declared on initial upload, being a known IANA media type.
bytes integer The total bytes of the file on disk. The file object is initially prepared with a value of either 0 or -1 for this property, which is then updated in the background post-upload.
editable boolean Indicates whether the file is to be editable only by the primary user identified with it. In general, this will be the user who initially posted the file.
ip_verified boolean Indicates whether or not the user identified with this file declared permission is granted to use it.
ip_expiry string If known, the date until which license or permission to use this file is valid, provided in ISO 8601 format.
ip_common boolean Indicates whether or not the user identified with this file would like it to be usable by everyone in the project.
ip_note string Informational note on usage or license pertinent to this file.
locale string The locale identified with this file object, used to indicate whether the file itself is provided in a known language, for example if an image with text is presented in English only. This locale is independent of that used for other file object data fields, those being provided in the endpoint transaction locale, to facilitate translation of properties like the file title/description in locale(s) other than that of the file itself.
point string The geographic point location identified with this file, provided as a comma-delimited textual value indicating both longitude and latitude, in that order.
url string The URL of the file. This points directly to the file itself to provide for inline use or download, etc.
title string The desired title of this file, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).
description string The file description text, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).
ip_attribution string If known, this field identifies the producer (or intellectual property owner) of the file, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).
user object The primary user identified with this file, being the user who initially uploaded the file, if that user exists and is not deleted. Includes only the user id.
groups array The group(s) in which this file exists. If provided by the /content endpoint (in the data property of an element identified with a content entry), only the group id will be included for each.
Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*