Authentication Result [application/vnd.hobson.authResult]
An authentication result is a response returned by an attempt to authenticate with the Hobson hub.
| Field Name | Type | Description |
|---|---|---|
| token | STRING | The bearer token to use for subsequent API calls. |
| user | application/vnd.hobson.person | The user that was authenticated. |
Device [application/vnd.hobson.device]
A device represents any smart device that Hobson knows how to monitor and control.
| Field Name | Type | Description |
|---|---|---|
| available | BOOLEAN | Indicates whether the device is currently reachable. |
| cclass | application/vnd.hobson.propertyContainerClass | The device's configuration class. This describes the supported configuration properties for the device. |
| configuration | application/vnd.hobson.propertyContainer | The device's configuration property values. |
| lastCheckIn | NUMBER | The last time the device was heard from. |
| name | STRING | The device name. |
| preferredVariable | application/vnd.hobson.variable | The device's preferred variable. For example, this is the variable that will be rendered to a dashboard tile. |
| telemetry | application/vnd.hobson.deviceTelemetry | The device's telemetry data. |
| type | STRING | The device type. |
| variables | application/vnd.hobson.itemList | The variables the device has published. |
Hub [application/vnd.hobson.hub]
A hub represents the specific device that is running the Hobson Hub software.
| Field Name | Type | Description |
|---|---|---|
| actionClasses | application/vnd.hobson.itemList | The list of action classes that have been published to the hub. |
| cclass | application/vnd.hobson.propertyContainerClass | The hub's configuration class. This describes the supported configuration properties for the hub. |
| conditionClasses | application/vnd.hobson.itemList | The list of condition classes that have been published to the hub. |
| configuration | application/vnd.hobson.propertyContainer | The hubs' configuration property values. |
| devices | application/vnd.hobson.itemList | The list of devices that have been published to the hub. |
| globalVariables | application/vnd.hobson.itemList | The list of global variables that have been published to the hub. |
| links | JSON Object | A map of link relations to corresponding URI. |
| localPlugins | application/vnd.hobson.itemList | The list of plugins that have been installed on the hub. |
| log | application/vnd.hobson.itemList | The list of hub log entries. |
| name | STRING | The hub's configured name. |
| presenceEntities | application/vnd.hobson.itemList | The list presence entities associated with the hub. |
| presenceLocations | application/vnd.hobson.itemList | The list of presence locations associated with the hub. |
| remotePlugins | application/vnd.hobson.itemList | The list of plugins that are available from hub's configured remote repositories. |
| tasks | application/vnd.hobson.itemList | The list of tasks that have been created on the hub. |
| version | STRING | The current hub version. |
...