System Settings

Global system settings relating to the core functions of the platform. These are usually configured at the time of initial system setup.

Get the current system state and settings

SecurityOAuth2 or ApiKey

Responses

200

Response success

401

Unauthorized access, invalid credentials were used.

get/system

Request samples

curl
JavaScript

Response samples

application/json

{"settings": {"SiteID": 501,
"Name": "San Francisco distribution center"
},
"devices": [{"DeviceID": "00:AA:BB:CC:DD:EE",
"Position": [10.2112,
1.1234,
-5.3209
],
"Orientation": [-0.1234,
0.4312,
0,
0.5432
],
"DeviceFlags": 3,
"AlertState": "active",
"FirmwareHash": "ec95199c",
"FirmwareVersion": "0.10.0",
"DeviceType": "anchor",
"LastUpdateTime": "2019-08-24T14:15:22Z",
"BatteryLevel": 0.85,
"LastGatewaySource": "ZK://501::3F2504E0-4F89-11D3-9A0C-0305E82C3301::UDP::10.0.0.220:10000"
}
],
"modules": [{"ModuleID": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
"Name": "Process analytics engine",
"Version": "0.1.0",
"Description": "Monitors output data to provide real-time data analytics and insights.",
"ModuleFilename": "ZSIPAnalyticsModule.spi",
"Active": true,
"Running": true
}
],
"zones": [{"SiteID": 501,
"ZoneID": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
"Name": "Keep-out zone",
"GeometryType": "sphere",
"GeometryData": [[1.1234,
5.6789,
-0.1234
],
[-5.6789,
0.1234,
5.6789
]
],
"MobileOriginSource": "00:11:22:33:44:55",
"CollidingDevices": [{"CollisionID": "38f4d02c-7d71-4728-b60d-e4f77c66921b",
"MAC": "00:AA:BB:CC:DD:EE",
"EntryTime": "2019-08-24T14:15:22Z"
}
],
"AlertLevel": 3,
"Active": true,
"InclusionPolicy": "all",
"DeviceList": ["99:AA:BB:CC:DD:EE",
"FF:00:11:22:33:DD"
],
"ZoneActions": [{"type": "info-event",
"argument": "https://internalnoc.clientdomain.com/api/triggerAlarm?alarmID=10"
}
],
"IsGeometryLocked": false,
"IsTimed": false,
"StartTime": "2019-08-24T14:15:22Z",
"StopTime": "2019-08-24T14:15:22Z"
}
]
}

➔ Next to Quality of Service