Skip to content

Fs File

A file is a binary object that resides within a folder. To create a file, the user initiates an upload, which returns a URL for uploading the file. The file is created by uploading its content to the provided URL.

Additional information about the file can be added as custom metadata during creation. Any valid JSON-formatted key-value pairs are accepted, with a maximum size limit of 64KB.

Files can have access control lists (ACLs) that define who can access them and what operations they can perform. To get more information on the ACL click here

Fileset

Filesets allow users to group a collection of files within a single resource, simplifying file management. This way, users do not need to create unique file IDs or access links for each file. Access management for these files can be performed collectively. The same base download URL can be used to access all file objects within the fileset.

Filesets are uploaded in a compressed format (zip, tar, or gzip) and uncompressed within the File Service. Users can then use the download URL to access content from within the archive.

Example use cases:

  • Displaying content within a map: Manage a collection of files accessed using a URL template to simplify the display of map tiles within a browser
  • Storing a collection of files that make up a website

File versioning

File versioning follows a major.minor versioning scheme. The major version is incremented when the binary content is updated using a new upload with the same name and parentId. The minor version is incremented whenever a mutation operation is performed, such as rename, move, delete, or metadata update.

Restricted File

When creating a new file upload, if the “restrictedAccess” attribute is set to true, the file is considered restricted and download URL will be expired. By default, the download URL for a restricted file will expire in one hour. If the “restrictedAccess” attribute is set to false, the download URL will be available to the public and will not expire.