Domain Model
Note
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| workspaceId | string.uuid | Yes | — | ID of the associated workspace |
| entityType | enum(customer, vendor, contact, opportunity, quote, estimate, site, asset, system, ticket, work_order, project, incident, alert, invoice, payment, purchase_order, knowledge_article, deficiency_report, design_review, inspection_result, maintenance_plan, pm_schedule, space, document, media_artifact, credential, workspace, product, monitoring_account, warehouse, rfq, schedule_visit, user) | Yes | — | Entity type |
| entityId | string | Yes | — | ID of the associated entity |
| authorId | string.uuid | Yes | — | ID of the associated author |
| body | string | Yes | — | Body |
| isPinned | boolean | Yes | — | Is pinned |
| source | enum(user, system, agent) | Yes | — | Source |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| entityType | enum(customer, vendor, contact, opportunity, quote, estimate, site, asset, system, ticket, work_order, project, incident, alert, invoice, payment, purchase_order, knowledge_article, deficiency_report, design_review, inspection_result, maintenance_plan, pm_schedule, space, document, media_artifact, credential, workspace, product, monitoring_account, warehouse, rfq, schedule_visit, user) | Yes | — | Entity type |
| entityId | string | Yes | — | ID of the associated entity |
| body | string | Yes | — | Body |
| isPinned | boolean | No | — | Is pinned |
| visibility | enum(internal, customer) | No | — | Visibility |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| body | string | No | — | Body |
| isPinned | boolean | No | — | Is pinned |