file
Last updated
Last updated
The system data type file
stores all files used throughout the fylr system:
Objects
Plugins
Logo & Background, XSLT files in the base configuration
User picture and custom data
Pool watermark and custom data
Objecttype custom data
Files are generally uploaded to the endpoint /api/eas/put. fylr can also upload files by copying from remote URLs when using the endpoint /api/eas/rput. Files can also be uploaded via WebDAV or by the /api/plugin/manage for plugins with type url
.
Files are stored in configurable locations, like S3 or disk storage.
fylr can also manage purley remote stored files. In that case only the URL is stored for the file.
fylr runs programs to discover metadata for each file. Plugins can extend the list of programs run to find metadata.
Henk
Horst s3ioj osqjwo ijojsqwi
Field | Format | Description |
---|---|---|
_duplicates
array
If set, this attribute can hold an array of duplicates.
_id
int64
The _id
is created when a file is uploaded into the fylr server.
_linked_objects
array
When a file is uploaded and linked to a collection via /api/eas
, the attribute contains a list of objects created based on the upload settings of that collection.
_mapped_metadata
object
A rendered version of the object data retrived and mapped from this file's metadata. It can be used to create objects based on a pre-configured metadata mapping.
best_date
timestamp
Best date is a compiled UTC timestamp from the technical metadata. fylr uses the first set date from technical_metadata.date_time_original
, technical_metadata.create_date
, date_uploaded
.
children
array
For originals which use a pageable format, like PDF
, this attribute contains the pages available underneath the original. The format is string and the value is using the file's _id
and the page number (starting at 0
) separated by /
.
class
string
The compiled class of the file. The classes are set by the recipe. Standard recipes of fylr include image
, audio
, office
, video
. The fylr frontend uses the class to pick the general player to view the file. A class unknown
is assigned if no matching recipe was found but the upload accepts unknown types.
class_extension
string
A compiled concatenation of class
, version
, joined by .
. This is used for aggregations of files
class_version_status
string
A compiled concatenation of class
, version
and status
, joined by .
. This is used for aggregations of file status.
compiled
string
A compiled version of the metadata for this file. For images this looks like this: JPG, 1920 x 1285 px, 569.5 kB
.
compiled_props
object
A fielded version of compiled
. Frontends can use this to beatify the compiled output of the metadata.
. dimensions
string
The rendered dimensions for this file. This may include a unit. For page sizes European paper sizes like A4 will be recognised.
. duration
string
Runtime of the audio or video file.
extension
string
The upper cased version of the extension
.
pages
string
The number of pages followed by a p.
. Frontends may localize this manually.
date_uploaded
timestamp
The UTC timestamp when this file was uploaded.
eas_parent_id
int64
The eas_parent_id
is the id of the file this file is derived from. When using /api/produce, the newly produced files will get the parent id set to the file they are produced from.
extension
string
The compiled extension of the file. This is matched by parsing available recipes at the time of the metadata generation. Extensions are matched by longer length first. So for a file flower.webdvd.zip
the extension matched would be .webdvd.zip
and not .zip
if there is an available recipe.
filesize
int64
The file size in bytes.
frontend_prefs
object
Set only in relation to an object. This map can contain custom attributes and values.
hash
string
is_original
boolean
Set to true if the file is an original. It is false if the file is a generated or uploaded rendition. Produced files are registered as originals underneath the original they are produced from.
last_status_at
timestamp
The UTC timestamp when the last status change was last written to the database.
lookup:_id
object
reference
string
The reference
of the file to look up.
metadata
object
groupnames
array
Sorted list of metadata group names found in groups
.
groups
object
name
string
Custom name of the file. This is set in the relation to the object. When retrieving the file via /api/eas
.
original_filename
string
The filename as set by original_filepath
minus the path.
original_filename_basename
string
The filename as set by original_filepath
minus the path and the detected extension
.
original_filepath
string
Filename of the file as set during the upload. On Windows, this can contain drive letters and backslashes.
pages_allowed
boolean
Indicates that the file has pages.
preferred
boolean
This may be set if the file is in the context of an object. If set, preferred indicates that this version is the preferred one in a list of other versions.
reference
string
If set, this reference string is a unique string identifying the file. If the reference contains a sha244:<hash>
or sha256:<hash>
, the provided hash can be checked against the file's checksum using an action triggerable in /inspect/files. Other parts of the reference can be added but must be separated by :
.
status
string
The status of the file. Known states are: pending
, processing
, sync
, done
, failed
. Files and renditions can be accessed in status sync
and done
. Only files in state done
can be exported.
technical_metadata
object
An object to describe technical aspects of the file. See Technical Metadata for details.
upload_user
object
The user who uploaded this file into the system. If the upload happens via Hotfolder, the uploader is the owner of the upload collection.
_basetype
string
user
object
This will show a short representation of user.
versions
object
versions
contains a map with renditions for the file. Depending on the users permissions, not all versions might be accessible.
Field | Format | Description |
---|
Field | Format | Description |
---|