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 | unknown | No | — | ID of the associated site |
| customerId | unknown | No | — | ID of the associated customer |
| 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 |
| categoryId | unknown | No | — | ID of the associated category |
| manufacturer | string | No | — | Manufacturer |
| manufacturerVendorId | unknown | No | — | ID of the associated manufacturer vendor |
| 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 | unknown | Yes | — | Visibility mode |
| projectId | unknown | No | — | ID of the associated project |
| owningOrganizationId | unknown | No | — | ID of the associated owning organization |
| acquisitionMethod | unknown | No | — | Acquisition method |
| previousVendor | string,null | No | — | Previous vendor |
| originalInstallDate | unknown | No | — | Original install date |
| conditionAtAcquisition | unknown | No | — | Condition at acquisition |
| conditionNotes | string,null | 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 | string,null | No | — | Asset tag |
| notes | string,null | No | — | Notes |
| archivedAt | unknown | No | — | Archived at |
| archivedByUserId | unknown | No | — | ID of the associated archived by user |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| siteId | unknown | No | — | ID of the associated site |
| customerId | unknown | No | — | ID of the associated customer |
| name | string | Yes | — | Name |
| systemId | unknown | No | — | ID of the associated system |
| parentAssetId | unknown | 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 |
| categoryId | string | No | — | ID of the associated category |
| manufacturer | string | No | — | Manufacturer |
| manufacturerVendorId | string | No | — | ID of the associated manufacturer vendor |
| model | unknown | No | — | Model |
| serialNumber | unknown | No | — | Serial number |
| firmwareVersion | unknown | No | — | Firmware version |
| configVersion | unknown | No | — | Config version |
| ipAddress | unknown | No | — | Ip address |
| macAddress | unknown | No | — | Mac address |
| networkSegment | unknown | No | — | Network segment |
| installDate | unknown | No | — | Install date |
| warrantyExpiration | unknown | 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 | unknown | No | — | ID of the associated location space |
| qrCode | unknown | No | — | Qr code |
| externalIds | object | No | — | External ids |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
| projectId | unknown | No | — | ID of the associated project |
| owningOrganizationId | string | No | — | ID of the associated owning organization |
| 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 |
| assetTag | unknown | No | — | Asset tag |
| notes | unknown | No | — | Notes |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| siteId | unknown | No | — | ID of the associated site |
| customerId | unknown | No | — | ID of the associated customer |
| name | string | No | — | Name |
| systemId | unknown | No | — | ID of the associated system |
| parentAssetId | unknown | 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 |
| categoryId | unknown | No | — | ID of the associated category |
| manufacturer | string | No | — | Manufacturer |
| manufacturerVendorId | unknown | No | — | ID of the associated manufacturer vendor |
| model | unknown | No | — | Model |
| serialNumber | unknown | No | — | Serial number |
| firmwareVersion | unknown | No | — | Firmware version |
| configVersion | unknown | No | — | Config version |
| ipAddress | unknown | No | — | Ip address |
| macAddress | unknown | No | — | Mac address |
| networkSegment | unknown | No | — | Network segment |
| installDate | unknown | No | — | Install date |
| warrantyExpiration | unknown | No | — | Warranty expiration |
| supportContractId | string.uuid | No | — | ID of the associated support contract |
| lifecycleStatus | enum(planned, ordered, installed, active, maintenance, failed, decommissioned, disposed) | No | — | Lifecycle status |
| locationSpaceId | unknown | No | — | ID of the associated location space |
| qrCode | unknown | No | — | Qr code |
| externalIds | object | No | — | External ids |
| projectId | unknown | No | — | ID of the associated project |
| owningOrganizationId | unknown | No | — | ID of the associated owning organization |
| 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 |
| assetTag | unknown | No | — | Asset tag |
| notes | unknown | No | — | Notes |