DeviceApi Resource

Stellt Funktionen für die gerätespezifische Konfiguration zur Verfügung

GET /api/v1/device/config

Die gerätespezifische Konfiguration ermitteln

Request Parameters
name type description
devicecnr query die eindeutige Gerätenummer
devicetag query eine optionale zusätzliche Kennung des Gerätes
devicetype query der Gerätetyp
userid query des bei HELIUM V angemeldeten API Benutzer
Response Body
media type data type description
application/json DeviceConfigEntry (JSON) die Konfiguration sofern deviceCnr vorhanden, ansonsten NOT FOUND
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/device/config
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "systemConfig" : "...",
  "userConfig" : "...",
  "deviceType" : "...",
  "deviceTag" : "...",
  "cnr" : "..."
}

PUT /api/v1/device/config

Abändern der benutzerdefinierten Gerätekonfiguration

Request Parameters
name type description
userid query des bei HELIUM V angemeldeten API Benutzer
Request Body
media type data type description
application/json DeviceConfigEntry (JSON) die Daten der neuen Konfiguration
application/xml;charset=UTF-8 object

Example

Request
PUT /api/v1/device/config
Content-Type: application/json

                
{
  "systemConfig" : "...",
  "userConfig" : "...",
  "deviceType" : "...",
  "deviceTag" : "...",
  "cnr" : "..."
}
Response
HTTP/1.1 204 No Content