The API > JSON Adminstrator API > REST Resources > Devices > GET

Overview

Get detailed information of devices that has been fully learned-in.

In the Admin API, the call "GET /devices" delivers basically the same content as "GET /devices/{deviceId}" from the User API but with the following additional information:

•learnInProcedure

•version

•transmitModes

oKey

otransmitOnConnect

otransmitOnEvent

otransmitOnDuplicate

•operable

•supported

•secured

•softSmartAck

Client to Gateway:

Resource Path	HTTP method
/devices	GET

Response Gateway to Client:

parameter			datatype	value / formatting	description
header			object	{}
devices			array of objects	[{}]
	deviceId		string	4 byte hex value	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
	physicalDevice (optional)		string		User-assigned name to group actuators and sensors.
	learnInProcedure		string	manuallyConfigured \| UTE \| SmartAck \| UserInteractionRequired \| receivedRps \| received1Bs \| received4Bs \| incompleteEep \| internetOfThings	Type of Learn-In Procedure
	eeps		array of objects	[{}]
		eep	string	xx-xx-xx	EnOcean Equipment Profiles, definition of Enocean radio telegram structure
		version	float		Version of the API Commands
		direction	string	from \| to \| both	"from", "to" or "both"
		variation (optional)	string	manufacturer _ productname	Manufacturer specific variation
	manufacturer (optional)		string		Manufacturer of the device
	firstSeen		string	yyyy-mm-ddT hh:mm:ss.sss+ hhmm	timestamp on which the device has been detected for the first time
	lastSeen (optional)		string	yyyy-mm-ddT hh:mm:ss.sss+ hhmm	timestamp on which the device has been detected for the last time
	secured		boolean	false	Device using Security over air (Not supported at the moment)
	version		float		Version of the API Commands
	softSmartAck		boolean		Device using Soft Smart-Ack
	transmitModes		array of objects	[{}]
		key	string		Key of the profile
		transmitOnConnect	boolean	true \| false
		transmitOnEvent	boolean	true \| false
		transmitOnDuplicate	boolean	true \| false
	states		array of objects	[{}]
		key	string		Technical key of function.
		channel (optional)	integer		Channel if supported by this device.
		value	float		Value of the function.
		unit (optional)	string	[unit]	Unit ISO.
		meaning (optional)	string		Description of value in English.
		timestamp	string	yyyy-mm-ddT hh:mm:ss.sss+ hhmm	Timestamp function value was received in case of last state functions.
		age	integer		Age of function value in case of last state functions in milli seconds.
	operable		boolean		Shows if the device is operable respectively the learn in procedure has been completed.
	supported		boolean		Shows if the device is supported or not.

example:

Basic structure of gateway response:

http://hostname:api_port/devices/

{
  "header" : {
    "httpStatus" : 200,
    "content" : "devices",
    "gateway" : "DC-GW/EO-IP v0.99.1",
    "timestamp" : "2016-05-11T16:02:19.174+0200"
  },
  "devices" : [ {
    "deviceId" : "0195DA34",
    "friendlyId" : "WaterEco",
    "learnInProcedure" : "receivedRps",
    "eeps" : [ {
      "eep" : "F6-05-01",
      "version" : 1.0,
      "direction" : "from"
    } ],
    "firstSeen" : "2016-04-27T16:22:58.802+0200",
    "secured" : false,
    "softSmartAck" : false,
    "transmitModes" : [ {
      "key" : "liquidDetected",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    } ],
    "states" : [ ],
    "operable" : true,
    "supported" : true
  }, {
    "deviceId" : "FEFCB98F",
    "friendlyId" : "ButtonMarion",
    "learnInProcedure" : "receivedRps",
    "eeps" : [ {
      "eep" : "F6-02-01",
      "version" : 1.0,
      "direction" : "from"
    } ],
    "firstSeen" : "2016-05-04T10:45:25.259+0200",
    "secured" : false,
    "softSmartAck" : false,
    "transmitModes" : [ {
      "key" : "buttonA0",
      "transmitOnConnect" : false,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "buttonBI",
      "transmitOnConnect" : false,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "buttonB0",
      "transmitOnConnect" : false,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "buttonAI",
      "transmitOnConnect" : false,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "multipleButtons",
      "transmitOnConnect" : false,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    } ],
    "states" : [ ],
    "operable" : true,
    "supported" : true
  }

(...)