Domain Model
Design Review
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 | Yes | — | ID of the associated workspace |
| projectId | string | No | — | ID of the associated project |
| workOrderId | string | No | — | ID of the associated work order |
| siteId | string | Yes | — | ID of the associated site |
| reviewType | enum(system_design, engineering_approval, bom_validation, as_built) | Yes | — | Review type |
| status | enum(pending, in_review, approved, revision_requested, rejected) | Yes | — | Status |
| title | string | Yes | — | Title |
| description | string | No | — | Description |
| checklist | unknown | No | — | Checklist |
| reviewerId | string | No | — | ID of the associated reviewer |
| reviewedAt | string.date-time | No | — | Reviewed at |
| revisionNotes | string | No | — | Revision notes |
| documentIds | unknown | No | — | Document ids |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| workspaceId | string | No | — | ID of the associated workspace |
| projectId | string | No | — | ID of the associated project |
| workOrderId | string | No | — | ID of the associated work order |
| siteId | string | Yes | — | ID of the associated site |
| reviewType | enum(system_design, engineering_approval, bom_validation, as_built) | Yes | — | Review type |
| status | enum(pending, in_review, approved, revision_requested, rejected) | Yes | "pending" | Status |
| title | string | Yes | — | Title |
| description | string | No | — | Description |
| checklist | unknown | No | — | Checklist |
| reviewerId | string | No | — | ID of the associated reviewer |
| reviewedAt | string.date-time | No | — | Reviewed at |
| revisionNotes | string | No | — | Revision notes |
| documentIds | unknown | No | — | Document ids |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| projectId | string | No | — | ID of the associated project |
| workOrderId | string | No | — | ID of the associated work order |
| siteId | string | No | — | ID of the associated site |
| reviewType | enum(system_design, engineering_approval, bom_validation, as_built) | No | — | Review type |
| status | enum(pending, in_review, approved, revision_requested, rejected) | No | — | Status |
| title | string | No | — | Title |
| description | string | No | — | Description |
| checklist | unknown | No | — | Checklist |
| reviewerId | string | No | — | ID of the associated reviewer |
| reviewedAt | string.date-time | No | — | Reviewed at |
| revisionNotes | string | No | — | Revision notes |
| documentIds | unknown | No | — | Document ids |