Files

Last Updated: July 27, 2018

Following is a list of the properties that belong to a file object, and a description of each.

id:
Integer. Read-only. Id of this file.
file_name:
String. Name of this file.
file_data:
String. Base64 encoded string of this file. May only be set when adding a file. Not displayed in response to a request to list files or in supplemental_data.
uploaded_by_user_id:
Integer. Read-only. Id of the user that uploaded this file.
active:
Boolean. Read-only. If false, this file is considered deleted.
size:
Integer. Read-only. Size of this file in bytes.
created:
String (ISO8601 format). Read-only. Date/time when this object was created (i.e. 2017-08-14T15:19:21+00:00).
last_modified:
String (ISO8601 format). Read-only. Date/time when this object was last modified (i.e. 2017-08-14T15:19:21+00:00).
linked_objects:
JSON object. Read-only. This is a key / value map of all the objects linked to this file and the corresponding object ids.
meta_data:
JSON object. This is a key / value map of any additional data associated with this file. List of allowed keys:
  • file_description: String. Description of this file.
  • image_rotation: Integer. Original image orientation in degrees. Accepted values are: 0 (top), 90 (right), 180 (bottom), 270 (left)