Skip to content

Fs Object

Objects act as containers for resources/blobs stored outside of File Service but made accessible through File Service.

  • Object Types - Each object is associated with an object type definition that is created and managed within File Service. Object types define the schema, actions, and display configuration for objects.
    • Schema - A JSON schema that defines the structure and data types of the content variables stored within the object.
    • Actions - Object types define available actions (e.g., download, view, custom menu items) that specify how users can interact with the object and its external resources.
  • Object Content - A freeform JSON field that stores variables defined by the object type schema. These variables hold references to external resources.
  • Object content is validated against the object type schema to ensure data integrity.
  • Objects are stored within the folder hierarchy and organized like files and folders.
  • Versioning is supported, with the version number incrementing for metadata changes.
  • Checkout/checkin operations are available to prevent concurrent modifications.
  • All metadata operations are supported, excluding copy.
  • Objects are excluded from folder copy and export operations.
  • Support files can be attached to objects, similar to files, and tracked via statistics.
  • Objects inherit permissions from their parent folders unless local permissions are explicitly set.

Objects enable integration with external storage systems and applications while maintaining File Service permission model and organizational structure. When an object is deleted in File Service, the source system is responsible for monitoring deletion events and handling cleanup of external resources.

To get more information on objects, Refer API Spec.

Note: Object Type definitions are managed by the File Service team. To request the creation of an object type definition, please contact the File Service team or raise a support ticket.