|
<< Click to Display Table of Contents >> Navigation: The API > JSON API > REST Resources > JSON Resource endpoint |
Overview
A full listing of all available endpoint URI’s with their used HTTP methods.
Object class |
REST path and query |
resource |
1 |
systemInfo |
|
|
|
|
GET |
/system/info |
systemInfo |
|
Get the version of gateway with EnOcean base information |
2 |
profiles |
|
|
|
|
GET |
/profiles |
profiles (overview) |
|
Overview of all supported EEP profiles and manufacturer variations |
|
GET |
/profiles/{eepId} [?variation={manufacturer}_{product}] |
profiles (detailed) |
|
Get detailed information of a single EEP functionality. To query a specific variation of an EEP is not mandatory. |
|
GET |
/devices/{deviceId}/profile |
|
|
Get detailed information of device functionality / functions |
3 |
devices |
|
|
|
|
GET |
/devices |
devices (overview) |
|
List of learned-in devices of the gateway |
|
GET |
/devices/{deviceId} |
devices (detailed) |
|
Get detailed information of a single device |
4 |
telegrams |
|
|
|
|
GET |
/devices/telegrams?=from|to|both |
telegrams |
|
Show last available / historic telegrams of all devices in receiving order, depending on the direction of transport |
|
GET |
/devices/{deviceId}/telegrams?direction=from|to|both |
|
|
Show last available / historic telegrams of a single device in receiving order, depending on the direction of transport |
5 |
states |
|
|
|
|
GET |
/devices/states |
states |
|
Get last states of all learned-in devices. notice depending on transmit settings in webinterface |
|
GET |
/devices/{deviceId}/state |
|
|
Get last state of a single device. notice depending on transmit settings in webinterface |
4 + 5 |
telegram-streams (states + telegrams) |
|
|
|
|
GET |
/devices/stream?direction=from|to|both |
states + telegrams |
|
Get the actual state of all devices and continue directly with streaming of device events all devices, depending on the direction of transport |
|
GET |
/devices/{deviceId}/stream?direction=from|to|both |
|
|
Get the actual state of a single device and continue directly with streaming of device events from a single device, depending on the direction of transport |
5 |
Setting state |
|
|
|
|
PUT |
/devices/{deviceId}/state |
state (update) |
|
With this resource, device state can be changed. |