Document Model

Overview

The document table serves as a centralized document/file metadata registry within a platform — enabling storage, organization, versioning, and access control for uploaded or generated files.It integrates with bundles, users, orgs, applications, menus, and even custom screen-object-subobject combinations — making it highly extensible.

Fields

Field	Type	Description	Required
id	string	A universally unique identifier (UUID) used as the primary key for the model. It ensures global uniqueness of each record, supports secure and collision-resistant identification across distributed systems, and avoids the predictability of sequential IDs.	❌
doc_name	string	doc_name field	❌
foldername	string	Name of the folder name if folder is uploaded	❌
properties	object	Duplicated	❌
bundle_id	any	Links the document to a logical or application-level bundle of resources/features.	❌
type	string	Type or category of the document. file/folder	❌
authKey	string	not in use	❌
storageType	string	Type of storage used for the document	❌
doc_type	string	doc_type field	❌
version	string	Version number of the document	❌
file_info	object	FIle Properties	❌
path	any	File path where the document is stored.	❌
override	any	didnt understand filed	❌
is_revised	boolean	is_revised field	❌
archive_folder_path	string	Path where archived versions of the document are stored at the time of update file	❌
delete_folder_path	string	Path where deleted documents are stored	❌
sites_id	string	Identifier linking to a site where the document is used.	❌
org_id	string	Identifier linking to an organization.	❌
application_id	string	Identifier linking to an associated application.	❌
parent	string	parent field	❌
user_id	string	Identifier of the user who created or modified the document.	❌
orggroup_id	string	Identifier for the organization group.	❌
screen_id	string	Primary Table ID Object associated with the document	❌
menuitem_id	string	Identifier linking to a menu item associated with the document.	❌
object_id	string	Identifier for an object associated with the document.	❌
sub_object_id	string	Identifier for a sub-object associated with the document.	❌
participants_id	any	Identifier for participants associated with the document.	❌
category	string	Category to which the document belongs.(unclear on the filed )	❌
category_type	string	Type of category of file doc type	❌
download_url	string	URL for downloading the document.	❌
conversion_url	string	not in use	❌
compression_url	string	not in use	❌
compressed	boolean	not in use	❌
isDeleted	boolean	Boolean flag indicating whether the document has been deleted.	❌
created_at	date	Timestamp when the document was created	❌
modified_at	date	Timestamp when the document was last modified	❌
link	array	link field	❌

Sample JSON

{
  "id": "example_value",
  "doc_name": "example_value",
  "foldername": "example_value",
  "properties": "example_value",
  "bundle_id": "example_value",
  "type": "example_value",
  "authKey": "example_value",
  "storageType": "example_value",
  "doc_type": "example_value",
  "version": "example_value",
  "file_info": "example_value",
  "path": "example_value",
  "override": "example_value",
  "is_revised": "example_value",
  "archive_folder_path": "example_value",
  "delete_folder_path": "example_value",
  "sites_id": "example_value",
  "org_id": "example_value",
  "application_id": "example_value",
  "parent": "example_value",
  "user_id": "example_value",
  "orggroup_id": "example_value",
  "screen_id": "example_value",
  "menuitem_id": "example_value",
  "object_id": "example_value",
  "sub_object_id": "example_value",
  "participants_id": "example_value",
  "category": "example_value",
  "category_type": "example_value",
  "download_url": "example_value",
  "conversion_url": "example_value",
  "compression_url": "example_value",
  "compressed": "example_value",
  "isDeleted": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "link": "example_value"
}