file

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.

Fields

Field	Format	Description
_id	int64	The _id is created when a file is uploaded into the fylr server.
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.
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 :.
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". More info can be found here here2 here3
user	object
_generated_displayname	string	The generated displayname of the user. This uses login and email.
_id	int64	The id of the user. It is automatically assigned.