Systems

The /systems endpoint provides methods for discovering, creating and interacting with systems. For more on the role that systems play, see:
Systems
All systems provide a base set of metadata that helps to describe their role and capabilities, as well as provide references to the modules they contain, and the zones they exist in.
Model
Attribute
Type
Description
id
string
The system's unique ID.
edge_id
string
ID of the preferred engine node to run on.
name
string
The system's primary identifier.
zones
array
Zone IDs that this system is a member of.
modules
array
Module ID's that this system contains.
description
string
Markdown formatted text that describes the system.
email
string
Calendar email that represents this system. Typically used for room scheduling / bookings.
capacity
integer
Number of people this space can accommodate.
features
string
List of features in the room for searching and filtering spaces.
bookable
boolean
Flag for signifying the space is bookable.
installed_ui_devices
integer
Expected number of fixed installation touch panels.
settings
object
JSON object representing the system's configuration.
created_at
integer
Timestamp of creation.
support_url
string
A URL linking to the primary interface for controlling this system.
version
integer
Incremental counter for handling stale updates.
Discovery
get
https://example.com
/api/control/systems
Search
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Operator
Action
​
+
Matches both terms.
​
`
`
Matches either terms.
-
Negates a single token.
​
"
Wraps tokens to form a phrase.
​
( and )
Provide precedence.
​
~N
Specifies edit distance (fuzziness) after a word.
​
~N
Specifies slop amount (deviation) after a phrase.
​
Management
post
https://example.com
/api/control/systems
Create
get
https://example.com
/api/control/systems/{id}
Retrieve
put
https://example.com
/api/control/systems/{id}
Update
delete
https://example.com
/api/control/systems/{id}
Delete
Interaction
post
https://example.com
/api/control/systems/{id}/start
Start
post
https://example.com
/api/control/systems/{id}/stop
Stop
post
https://example.com
/api/control/systems/{id}/exec
Exec
get
https://example.com
/api/control/systems/{id}/state
State
get
https://example.com
/api/control/systems/{id}/funcs
Funcs
get
https://example.com
/api/control/systems/{id}/count
Count
get
https://example.com
/api/control/systems/{id}/types
Types