Overlays Model

Overview

The overlays table is designed to store overlay-related information for applications. An overlay refers to additional layers or content added to an existing interface, page, or map. This table tracks various overlay types, configurations, data, and related information for each application.

Fields

Field	Type	Description	Required
id	string	Unique identifier for the overlay	❌
overlayName	string	overlayName field	✅
overlayDescription	string	overlayDescription field	✅
applicationId	string	ID of the application this overlay belongs to. Enables multi-app usage.	✅
config	any	Serialized configuration settings (likely JSON) defining behavior, layout, rules, etc.	❌
overlayType	string	Category/type of overlay (e.g., map, UI, template, annotation). Used for filtering or behavior differentiation.	✅
overlayData	object	Data associated with the overlay.	❌
tags	array	JSON array of tags for filtering, searching, or grouping overlay	❌
hierarchyIds	array	Hierarchical ID references — could relate to organization structure, UI navigation, or content trees.	❌
coordinates	object	Spatial or logical coordinates. May be used for placing overlays on a map or canvas. Possibly in JSON or delimited format.	❌
userdefinedtemplates	array	User-defined templates associated with the overlay.	❌
created_at	date	Timestamp when the overlay record was created.	❌
modified_at	date	Timestamp when the overlay record was last modified.	❌

Sample JSON

{
  "id": "example_value",
  "overlayName": "example_value",
  "overlayDescription": "example_value",
  "applicationId": "example_value",
  "config": "example_value",
  "overlayType": "example_value",
  "overlayData": "example_value",
  "tags": "example_value",
  "hierarchyIds": "example_value",
  "coordinates": "example_value",
  "userdefinedtemplates": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value"
}