Domain Model
Asset
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 |
| siteId | string | Yes | — | ID of the associated site |
| name | string | Yes | — | Name |
| systemId | string | No | — | ID of the associated system |
| parentAssetId | string | No | — | ID of the associated parent asset |
| assetType | enum(controller, panel, camera, sensor, reader, lock, switch, server, nvr_dvr, workstation, ups, pdu, enclosure, module, cable_run, access_point, intercom_station, other) | Yes | — | Asset type |
| manufacturer | string | No | — | Manufacturer |
| model | string | No | — | Model |
| serialNumber | string | No | — | Serial number |
| firmwareVersion | string | No | — | Firmware version |
| configVersion | string | No | — | Config version |
| ipAddress | string | No | — | Ip address |
| macAddress | string | No | — | Mac address |
| networkSegment | string | No | — | Network segment |
| installDate | string.date-time | No | — | Install date |
| warrantyExpiration | string.date-time | No | — | Warranty expiration |
| supportContractId | string.uuid | No | — | ID of the associated support contract |
| lifecycleStatus | enum(planned, ordered, installed, active, maintenance, failed, decommissioned, disposed) | Yes | — | Lifecycle status |
| locationSpaceId | string | No | — | ID of the associated location space |
| qrCode | string | No | — | Qr code |
| externalIds | object | No | — | External ids |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | enum(global, workspace_local, shared) | Yes | — | Visibility mode |
| projectId | unknown | No | — | ID of the associated project |
| acquisitionMethod | unknown | No | — | Acquisition method |
| previousVendor | unknown | No | — | Previous vendor |
| originalInstallDate | unknown | No | — | Original install date |
| conditionAtAcquisition | unknown | No | — | Condition at acquisition |
| conditionNotes | unknown | No | — | Condition notes |
| lastServiceDate | unknown | No | — | Last service date |
| nextServiceDue | unknown | No | — | Next service due |
| totalServiceCount | unknown | No | — | Total service count |
| failureCount | unknown | No | — | Failure count |
| assetTag | unknown | No | — | Asset tag |
| notes | unknown | No | — | Notes |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| siteId | string | Yes | — | ID of the associated site |
| name | string | Yes | — | Name |
| systemId | string | No | — | ID of the associated system |
| parentAssetId | string | No | — | ID of the associated parent asset |
| assetType | enum(controller, panel, camera, sensor, reader, lock, switch, server, nvr_dvr, workstation, ups, pdu, enclosure, module, cable_run, access_point, intercom_station, other) | Yes | — | Asset type |
| manufacturer | string | No | — | Manufacturer |
| model | string | No | — | Model |
| serialNumber | string | No | — | Serial number |
| firmwareVersion | string | No | — | Firmware version |
| configVersion | string | No | — | Config version |
| ipAddress | string | No | — | Ip address |
| macAddress | string | No | — | Mac address |
| networkSegment | string | No | — | Network segment |
| installDate | string.date-time | No | — | Install date |
| warrantyExpiration | string.date-time | No | — | Warranty expiration |
| supportContractId | string.uuid | No | — | ID of the associated support contract |
| lifecycleStatus | enum(planned, ordered, installed, active, maintenance, failed, decommissioned, disposed) | Yes | "planned" | Lifecycle status |
| locationSpaceId | string | No | — | ID of the associated location space |
| qrCode | string | No | — | Qr code |
| externalIds | object | No | — | External ids |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | enum(global, workspace_local, shared) | Yes | "workspace_local" | Visibility mode |
| projectId | string.uuid | No | — | ID of the associated project |
| acquisitionMethod | enum(installed, takeover, purchased, transferred) | No | — | Acquisition method |
| previousVendor | string | No | — | Previous vendor |
| originalInstallDate | string.date-time | No | — | Original install date |
| conditionAtAcquisition | enum(excellent, good, fair, poor, unknown) | No | — | Condition at acquisition |
| conditionNotes | string | No | — | Condition notes |
| assetTag | string | No | — | Asset tag |
| notes | string | No | — | Notes |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| siteId | string | No | — | ID of the associated site |
| name | string | No | — | Name |
| systemId | string | No | — | ID of the associated system |
| parentAssetId | string | No | — | ID of the associated parent asset |
| assetType | enum(controller, panel, camera, sensor, reader, lock, switch, server, nvr_dvr, workstation, ups, pdu, enclosure, module, cable_run, access_point, intercom_station, other) | No | — | Asset type |
| manufacturer | string | No | — | Manufacturer |
| model | string | No | — | Model |
| serialNumber | string | No | — | Serial number |
| firmwareVersion | string | No | — | Firmware version |
| configVersion | string | No | — | Config version |
| ipAddress | string | No | — | Ip address |
| macAddress | string | No | — | Mac address |
| networkSegment | string | No | — | Network segment |
| installDate | string.date-time | No | — | Install date |
| warrantyExpiration | string.date-time | No | — | Warranty expiration |
| supportContractId | string.uuid | No | — | ID of the associated support contract |
| lifecycleStatus | enum(planned, ordered, installed, active, maintenance, failed, decommissioned, disposed) | No | "planned" | Lifecycle status |
| locationSpaceId | string | No | — | ID of the associated location space |
| qrCode | string | No | — | Qr code |
| externalIds | object | No | — | External ids |
| projectId | string.uuid | No | — | ID of the associated project |
| acquisitionMethod | enum(installed, takeover, purchased, transferred) | No | — | Acquisition method |
| previousVendor | string | No | — | Previous vendor |
| originalInstallDate | string.date-time | No | — | Original install date |
| conditionAtAcquisition | enum(excellent, good, fair, poor, unknown) | No | — | Condition at acquisition |
| conditionNotes | string | No | — | Condition notes |
| assetTag | string | No | — | Asset tag |
| notes | string | No | — | Notes |