Domain Model
System
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 |
| customerId | string | Yes | — | ID of the associated customer |
| name | string | Yes | — | Name |
| systemType | enum(access_control, video_surveillance, intrusion_alarm, fire_alarm, audio_video, networking, structured_cabling, iot, smart_parking, intercom, other) | Yes | — | System type |
| vendor | string | No | — | Vendor |
| productFamily | string | No | — | Product family |
| deploymentModel | enum(on_premise, cloud, hybrid) | No | — | Deployment model |
| status | enum(planned, installing, active, degraded, decommissioned) | Yes | — | Status |
| commissioningDate | string.date-time | No | — | Commissioning date |
| supportStatus | enum(under_warranty, under_contract, out_of_support, eol) | No | — | Support status |
| notesSummary | string | No | — | Notes summary |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
| siteIds | string[] | No | — | Site ids |
| spaceIds | string[] | No | — | Space ids |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| customerId | string | Yes | — | ID of the associated customer |
| siteIds | string[] | Yes | [] | Site ids |
| name | string | Yes | — | Name |
| systemType | enum(access_control, video_surveillance, intrusion_alarm, fire_alarm, audio_video, networking, structured_cabling, iot, smart_parking, intercom, other) | Yes | — | System type |
| vendor | string | No | — | Vendor |
| productFamily | string | No | — | Product family |
| deploymentModel | enum(on_premise, cloud, hybrid) | No | — | Deployment model |
| status | enum(planned, installing, active, degraded, decommissioned) | Yes | "planned" | Status |
| commissioningDate | string.date-time | No | — | Commissioning date |
| supportStatus | enum(under_warranty, under_contract, out_of_support, eol) | No | — | Support status |
| notesSummary | string | No | — | Notes summary |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| customerId | string | No | — | ID of the associated customer |
| siteIds | string[] | No | — | Site ids |
| name | string | No | — | Name |
| systemType | enum(access_control, video_surveillance, intrusion_alarm, fire_alarm, audio_video, networking, structured_cabling, iot, smart_parking, intercom, other) | No | — | System type |
| vendor | string | No | — | Vendor |
| productFamily | string | No | — | Product family |
| deploymentModel | enum(on_premise, cloud, hybrid) | No | — | Deployment model |
| status | enum(planned, installing, active, degraded, decommissioned) | No | — | Status |
| commissioningDate | string.date-time | No | — | Commissioning date |
| supportStatus | enum(under_warranty, under_contract, out_of_support, eol) | No | — | Support status |
| notesSummary | string | No | — | Notes summary |