Skip to content
File Service

Fs Support File

A support file is a type of file that is associated with a parent file or object, serving to store supplementary information related to the parent file or object. For example, a thumbnail image.

Example Use Cases:

  • Files generated by the processing framework, such as converted TRB, PDF, or thumbnails, from the user’s uploaded main file. These converted files are saved as support files and stored under the user’s main file as the parent. For example, when a user uploads an image, the system generates thumbnails and a PDF version, which are stored as support files linked to the original image file
  • Support files that users upload themselves as part of a package upload. This option allows users to add related documents, images, or other relevant files to the main file, with these additional files automatically linked to it as support files. For example, a user uploads a design file and includes various versions and supplementary images as part of a package, all of which are linked to the design file as support files.

Uploading a support file

Support files are stored as children of their parent file or object. The process for uploading a support file is identical to that of uploading a regular file. However, the key difference is that the parentId must be set to the ID of the parent file or object, and the parentType should be specified as FILE or OBJECT (case-sensitive) as appropriate.

Linking a support file to a parent

  • FILES ONLY: A support file may be linked to any major version of a parent file by specifying the desired version with the parentMajorVersion attribute. If not specified, the support file will be linked to the latest version of the file.
  • OBJECTS ONLY: All object modifications increment the major version of the object. As a result, support file links apply to all versions of the object. They cannot be tied to a specific version.
  • A unique key may be assigned to a support file when creating a link by specifying the supportFileKey attribute. If not specified, the support file’s name will serving as the key.
  • The support file key is case-sensitive, for example THUMB is different from thumb.
  • ACL permissions are inherited from the parent resource, ensuring that the support file has the same ACL settings as the parent.
  • Updates to the support file link increment the parent’s metadata version (minor version in case of files and major version in case of objects).

Support file constraints

  • Move, delete, and restore operations are not permitted on a support file. However, you can perform custom metadata updates, copy, and rename operations on a support file.
  • ACL permissions cannot be set or updated for a support file.
  • When the parent is deleted, its support files are automatically deleted. Similarly, when the main file or object is restored, its support files are also restored.
  • Support files can be discovered by listing the resources of the parent file or object.
  • A maximum of 10 support files can be linked to a single parent.
  • A parent can have a maximum of 50 active support files (linked or unlinked).
  • When the parent file’s major version is updated, the links to support files are not carried over to the new version by default. To retain the links, set the copyLinks field to true.
  • If a linked support file is renamed, the support file key remains unchanged.
  • The support file key is unique within the context of the parent file. If a support file with the same key is linked to the same parent file, the previous link will be overridden by the new support file.
  • Links can only be established on the parent file or object.

Versioning and linking

  • Any change in the link between the parent file and the support file increments the parent file’s minor (metadata) version.
  • Support files and links operate only on the main content version, although the metadata version is incremented. To retrieve the latest links for a specific major version, use the version-specific endpoints with <major_version>.* as the version ID.
  • When a new major version of the main file is created with the copyLinks query parameter set to true, the links are carried over to the new version. This results in a single version of the support file being linked to multiple versions of the main file.