GET /devices

<< Click to Display Table of Contents >>

Navigation:  The API > JSON API > REST Resources > Devices > GET >

GET /devices

Devices overview

Overview of known devices of the gateway

 

Client to Gateway:

Resource Path

HTTP method

/devices

GET

no additional call parameters are necessary

 

Response Gateway to Client:

parameter

datatype

value / formatting

description

header

object

{}

 

devices

array of objects

[{}]

 

 

deviceId

string

 

SenderID of Enocean device, EnOcean modules usually send telegrams with their unique 32-bit Chip ID. In the other case, these are the Base ID of the EnOcean device.

 

friendlyId

string

 

User-assigned name of EnOcean device. Must be unique.

 

physicalDevice
(optional)

string

 

User-assigned name to group actuators and sensors.

 

example:

Basic structure of gateway response:

http://hostname:api_port/devices
 
{
  "header" : {
    "httpStatus" : 200,
    "content" : "devices",
    "gateway" : "DC-GW/EO-IP v0.99.0",
    "timestamp" : "2016-05-03T16:56:43.399+0200"
  },
  "devices" : [ {
    "deviceId" : "0029CFC5",
    "friendlyId" : "RockerSwitchDBO",
    "physicalDevice" : "PTM200"
  }, {
    "deviceId" : "0190A078",
    "friendlyId" : "MultiSensorAlphaEos"
  } ]
}