Skip to main content

Pages Model

Overview​

The pages table is used to store details about pages in the system. This can include content such as titles, notes, objects, and diagrams. Pages can have hierarchical relationships (parent-child) and support different types of content, including text, math, diagrams, and checklists.

Fields​

FieldTypeDescriptionRequired
idstringA unique identifier for the page.❌
namestringThe title of the page. Used as the primary display name.❌
expandedbooleanIndicates if the page is expanded❌
descriptionstringA subtitle or additional description for the page.❌
typestringDescribes the type of page (text,diagram,draw,math,reminder).❌
childbooleanIndicates if the page is a child page❌
noteIdstringThe identifier of a note associated with this page❌
screenstringscreen field❌
objectIdstringThe identifier of the object related to this page.❌
drawanyDrawing or graphical data associated with the page.❌
checkListIdanyThe identifier of a checklist related to the page.❌
textanyText content stored within the page❌
mathanyMathematical content or formulas related to the page.❌
diagramanyDiagram data associated with the page.❌
subObjectIdstringThe identifier of a sub-object related to the page.❌
application_idstringIdentifies the application this page belongs to, useful in multi-app platforms.❌
parentstringThe identifier of the parent page if applicable.❌
created_atdateThe timestamp when the page was created.❌
modified_atdateThe timestamp when the page was last updated.❌
objectTypeanyDefines the type of the object associated with this page.❌
tagsarrayTags associated with the page for categorization.❌
childrenarrayChild elements or sub-pages related to this page.❌
editorTypestringThe type of editor used for editing this page.❌

Sample JSON​

{
"id": "example_value",
"name": "example_value",
"expanded": "example_value",
"description": "example_value",
"type": "example_value",
"child": "example_value",
"noteId": "example_value",
"screen": "example_value",
"objectId": "example_value",
"draw": "example_value",
"checkListId": "example_value",
"text": "example_value",
"math": "example_value",
"diagram": "example_value",
"subObjectId": "example_value",
"application_id": "example_value",
"parent": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"objectType": "example_value",
"tags": "example_value",
"children": "example_value",
"editorType": "example_value"
}