ZRM Docs
API ReferenceSystem

system.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
siteIdstringYesID of the associated site
namestringYesName
systemTypeenum(access_control, video_surveillance, intrusion_alarm, fire_alarm, audio_video, networking, structured_cabling, iot, smart_parking, intercom, other)YesSystem type
vendorstringNoVendor
productFamilystringNoProduct family
deploymentModelenum(on_premise, cloud, hybrid)NoDeployment model
statusenum(planned, installing, active, degraded, decommissioned)Yes"planned"Status
commissioningDatestring.date-timeNoCommissioning date
supportStatusenum(under_warranty, under_contract, out_of_support, eol)NoSupport status
notesSummarystringNoNotes summary
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "systemType": "access_control",
  "vendor": "example",
  "productFamily": "example",
  "deploymentModel": "on_premise",
  "status": "planned",
  "visibilityMode": "global"
}

On this page