Entities
Every entity the SDK lets you manipulate, grouped by domain. Click an
entity for the full surface — methods, model fields, examples.
Places
| Entity |
What it is |
CRUD |
Compound |
| Sites |
Top-level physical locations |
full |
— |
| Areas |
Sublocations inside a site |
full |
— |
| Floorplans |
Floorplan images attached to areas |
full + image upload |
— |
| Anchors |
Fixed WIN anchors |
full |
— |
| Zones |
Polygonal / circular geofences |
full |
dynamic-zone re-binding |
| Entity |
What it is |
CRUD |
Compound |
| Tags |
Tracked objects (people, equipment, vehicles) |
full |
create-with-zone-and-groups, bulk update, delete-cascade |
| Groups |
Tag groupings |
full |
delete-with-detach, add/remove tags |
| Nodes |
Hardware MAC-addressable devices |
full |
release-with-scope-switch, bulk import |
| Associations |
Anchor↔node and tag↔node bindings |
full |
bulk create continue-on-error |
People & organization
| Entity |
What it is |
CRUD |
Compound |
| Users |
User accounts |
full |
create-with-project-role, change-password-with-relogin |
| Projects |
Project scope containers |
full |
— |
| Companies |
Tenant boundary |
full |
— |
Telemetry
| Entity |
What it is |
Surface |
| Alarms |
Active and historical alarms |
read + clear |
| Events |
PWS / zone-event streams |
iter_pws, iter_zone_events, pages |
| Reports |
Heatmap, PWS aggregate, CSV downloads |
generate + read |
Streaming
| Entity |
What it is |
Methods |
| Streaming |
Live WebSocket subscription to server channels |
list_channels, subscribe; session add_channels / remove_channels / close |
Notifications
| Entity |
What it is |
CRUD |
| Notifications |
Notification profiles |
full |
| Subscribers |
Notification recipients |
full + system-subscribers helper |
System & session
| Entity |
What it is |
Methods |
| Auth |
The current session — whoami, capabilities, password change |
whoami, capabilities, change_password |
| System |
Server-side host, health, version, WS endpoint |
host, health, version, ws_host, … |
| Context |
Dashboard-bootstrap mega-fetch (20+ entities in one call) |
load() |
| Messaging |
Server messaging channel |
send |
| User messages |
Send a hex payload to a tag's badge over UDP |
send |
| Logger |
Server log-filter management |
get_filter, set_filter, clear_filter |
TDOA configuration
| Entity |
What it is |
CRUD |
| Schedules |
TDOA schedule definitions |
full |
| LSB |
Sync topology + active-schedule pointer |
get / create / update |
| Network |
Per-project service-mode toggle |
get / update |
Need to do something not entity-shaped?