core-metadata API documentation version 1.1.x

http://localhost:48081/api

Welcome

Welcome to the EdgeX Foundry Core Metadata Microservice API Documentation.

Ping Resource

Example - http://localhost:48081/api/v1/ping

get

get

ping

Config Resource

Example - http://localhost:48081/api/v1/config

get

get

Fetch the current state of the service's configuration.

Device Resource (by id)

Example - http://localhost:48081/api/v1/device/id/c4094ab7-a0dc-4721-aee3-a28b967a5801

delete

delete

Remove the Device designated by database generated id. This does not remove associated objects (addressable, service, profile, etc.). Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Remove the Device designated by database generated id. This does not remove associated objects (addressable, service, profile, etc.). Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • id: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the id provided.

Device Resource by name (preferred) or id

Example - http://localhost:48081/api/v1/device/check/ohmmeter

get

get

Obtain a device by either name (preferred) or id. Id must be a valid UUID identifier.

Obtain a device by either name (preferred) or id. Id must be a valid UUID identifier.

URI Parameters

  • token: required (string)

HTTP status code 200

JSON payload representing the device

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

device was not found

Device Resource (set last reported by name)

Example - http://localhost:48081/api/v1/device/name/livingroomthermostat/lastreported/1471966597000 (where livingroomthermostat is the device name)

put

put

Update the last reported time of the device by unique name of the device. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Update the last reported time of the device by unique name of the device. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

URI Parameters

  • time: (string)
  • name: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last reported by name)

Example - http://localhost:48081/api/v1/device/name/livingroomthermostat/lastreported/1471966597000/true (where livingroomthermostat is the device name)

put

put

Update the last reported time of the device by unique name of the device. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Update the last reported time of the device by unique name of the device. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

URI Parameters

  • time: (string)
  • name: (string)
  • notify: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last connected by name)

Example - http://localhost:48081/api/v1/device/name/livingroomthermostat/lastconnected/1471966597000 (where livingroomthermostat is the device name)

put

put

Update the last connected time of the device by unique name of the device. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Update the last connected time of the device by unique name of the device. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

URI Parameters

  • time: (string)
  • name: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last connected by name)

Example - http://localhost:48081/api/v1/device/name/livingroomthermostat/lastconnected/1471966597000/true (where livingroomthermostat is the device name)

put

put

Update the last connected time of the device by unique name of the device. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Update the last connected time of the device by unique name of the device. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

URI Parameters

  • time: (string)
  • name: (string)
  • notify: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (by name)

Example - http://localhost:48081/api/v1/device/name/livingroomthermostat (where livingroomthermostat is the device name)

delete put get

delete

Remove the Device designated by unique name. This does not remove associated objects (addressable, service, profile, etc.). Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

put

Set the admin or operating state of the device by unique name of the device. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

get

Return Device matching given name (device names should be unique). May be null if no device matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Remove the Device designated by unique name. This does not remove associated objects (addressable, service, profile, etc.). Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

Set the admin or operating state of the device by unique name of the device. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

URI Parameters

  • name: (string)

Body

Type: application/json

Example:

{"adminState":"unlocked"} or {"operatingState":"enabled"}

HTTP status code 200

indicating success of the operation

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Return Device matching given name (device names should be unique). May be null if no device matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • name: (string)

HTTP status code 200

device matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last reported by id)

Example - http://localhost:48081/api/v1/device/c4094ab7-a0dc-4721-aee3-a28b967a5801/lastreported/1471966597000

put

put

Update the last reported time of the device by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Update the last reported time of the device by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • time: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last reported by id)

Example - http://localhost:48081/api/v1/device/c4094ab7-a0dc-4721-aee3-a28b967a5801/lastreported/1471966597000/true

put

put

Update the last reported time of the device by database generated identifier. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Update the last reported time of the device by database generated identifier. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • time: (string)
  • notify: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last connected by id)

Example - http://localhost:48081/api/v1/device/c4094ab7-a0dc-4721-aee3-a28b967a5801/lastconnected/1471966597000

put

put

Update the last connected time of the device by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Update the last connected time of the device by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • time: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (set last connected by id)

Example - http://localhost:48081/api/v1/device/c4094ab7-a0dc-4721-aee3-a28b967a5801/lastconnected/1471966597000/true

put

put

Update the last connected time of the device by database generated identifier. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Update the last connected time of the device by database generated identifier. The notify boolean indicates whether the owning device service should be notified of the change. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • time: (string)
  • notify: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (by id)

Example - http://localhost:48081/api/v1/device/c4094ab7-a0dc-4721-aee3-a28b967a5801

get put

get

Fetch a specific device by database generated id. May return null if no device with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

put

Set the admin or operating state of the device (as referenced by the database generated id of the device) to the state provided (either enabled or disabled). ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided.

Fetch a specific device by database generated id. May return null if no device with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

URI Parameters

  • id: (string)

HTTP status code 200

device matching on the id

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Set the admin or operating state of the device (as referenced by the database generated id of the device) to the state provided (either enabled or disabled). ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided.

URI Parameters

  • id: (string)

Body

Type: application/json

Example:

{"adminState":"unlocked"} or {"operatingState":"enabled"}

HTTP status code 200

status code indicating success

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if no device exists by the id provided.

HTTP status code 500

for unanticipated or unknown issues encountered.

Device Resource (by label)

Example - http://localhost:48081/api/v1/device/label/hvac (where hvac is a device label)

get

get

Find all Devices having at least one label matching the label provided. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find all Devices having at least one label matching the label provided. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • label: (string)

HTTP status code 200

List of Device matching on specified label

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}]

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (by profile)

Example - http://localhost:48081/api/v1/device/profile/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6 (where the id is a device profile id)

get

get

Find all devices associated to the DeviceProfile with the specified profile database generated identifier. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the id provided.

Find all devices associated to the DeviceProfile with the specified profile database generated identifier. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the id provided.

URI Parameters

  • profileId: (string)

HTTP status code 200

List of Devices associated to the device profile

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}]

HTTP status code 404

if no device profile match on the id provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (by service)

Example - http://localhost:48081/api/v1/device/service/5f79f674-a25e-44e6-bab0-1cc687420e40 (where the id is the associated device service id)

get

get

Find all devices associated to the DeviceService with the specified DeviceService database generated identifier. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the id provided.

Find all devices associated to the DeviceService with the specified DeviceService database generated identifier. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the id provided.

URI Parameters

  • serviceId: (string)

HTTP status code 200

List of Devices associated to the device service

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}]

HTTP status code 404

if no device service match on the id provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (by service name)

Example - http://localhost:48081/api/v1/device/servicename/home thermostat device service (where home thermostat device service is the name of the device service)

get

get

Find all devices associated to the DeviceService with the specified service name (DeviceService names must be unique). List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the name provided.

Find all devices associated to the DeviceService with the specified service name (DeviceService names must be unique). List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the name provided.

URI Parameters

  • servicename: (string)

HTTP status code 200

List of Devices associated to the device service

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}]

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the name provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource (by profile name)

Example - http://localhost:48081/api/v1/device/profilename/thermostat profile (where 'thermostat profile' is the name of a device profile)

get

get

Find all devices associated to the DeviceProfile with the specified profile name. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the name provided.

Find all devices associated to the DeviceProfile with the specified profile name. List may be empty if no device match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the name provided.

URI Parameters

  • profilename: (string)

HTTP status code 200

List of Devices associated to the profile

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"c4094ab7-a0dc-4721-aee3-a28b967a5801","created":1471966592240,"modified":1471966592240,"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":null,"operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},"lastConnected":0,"lastReported":0,"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"id":"5f79f674-a25e-44e6-bab0-1cc687420e40","created":1471966570667,"modified":1471966570667,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"12da905b-97d2-4a58-b9ab-84a71980b363","created":1471966557670,"modified":1471966557670,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}},"profile":{"id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","created":1471966587727,"modified":1471966587727,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471966587724,"modified":1471966587724,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}]

HTTP status code 400

for incorrect or unparsable requests

HTTP status code 404

if the device cannot be found by the identifier provided.

HTTP status code 500

for unknown or unanticipated issues.

Device Resource

Example - http://localhost:48081/api/v1/device

post put get

post

Add a new Device - name must be unique. Embedded objects (device, service, profile, addressable) are all referenced in the new Device object by id or name to associated objects. All other data in the embedded objects will be ignored. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated object (Addressable, Profile, Service) cannot be found with the id or name provided.

put

Update the Device identified by the id or name stored in the object provided. Id is used first, name is used second for identification purposes. New device services & profiles cannot be created with a PUT, but the service and profile can replaced by referring to a new device service or profile id or name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

get

Return all devices sorted by id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new Device - name must be unique. Embedded objects (device, service, profile, addressable) are all referenced in the new Device object by id or name to associated objects. All other data in the embedded objects will be ignored. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated object (Addressable, Profile, Service) cannot be found with the id or name provided.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"device or sensor supplying data and taking actuation commands", "title":"device","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

{"origin":1471806386919,"name":"livingroomthermostat","description":"living room HVAC thermostat","adminState":"unlocked","operatingState":"enabled","protocols":{"example":{"host":"localhost","port":"1234","unitID":"1"}},"labels":["home","hvac","thermostat"],"location":"{lat:45.45,long:47.80}","service":{"name":"home thermostat device service"},"profile":{"name":"thermostat profile"},"autoEvents":[{"frequency":123,"onChange":true,"resource":"TestDevice"}]}

HTTP status code 200

database generated identifier for the new device

HTTP status code 400

if the request is malformed or unparsable or if an associated object (Addressable, Profile, Service) cannot be found with the id or name provided

HTTP status code 409

if the name is determined to not be unique with regard to others.

HTTP status code 500

for unknown or unanticipated issues.

DeviceProfile Resource (by id)

Example - http://localhost:48081/api/v1/deviceprofile/id/dd5de4ff-ae3b-44b1-997d-5d410cd22e1c

delete

delete

Remove the DeviceProfile designated by database generated id. This does not remove associated commands. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the identifier provided. Returns DataValidationException (HTTP 413) if devices still reference the profile.

Remove the DeviceProfile designated by database generated id. This does not remove associated commands. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the identifier provided. Returns DataValidationException (HTTP 413) if devices still reference the profile.

URI Parameters

  • id: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if the device profile cannot be found with the identifier provided

HTTP status code 409

if devices or provision watchers still reference the profile

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by manufacturer or model)

Example - http://localhost:48081/api/v1/deviceprofile/manufacturer/Honeywell/model/ABC123 (where Honeywell is the manufacturer associated to profiles and ABC123 is the model associated to profiles)

get

get

Find all DeviceProfiles with a manufacture or model attribute matching that provided (either matching provides a hit). List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find all DeviceProfiles with a manufacture or model attribute matching that provided (either matching provides a hit). List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • model: (string)
  • manufacturer: (string)

HTTP status code 200

List of DeviceProfile matching on specified manufacturer and/or model.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "description of values (value descriptors) that should be collected per device on a interval action", "title":"devicereport","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"device":{"type":"string","required":false,"title":"device"},"action":{"type":"string","required":false,"title":"action"},"expected":{"type":"array","required":false,"title":"expected","items":{"type":"string","title":"expected"},"uniqueItems":false}}}

Example:

[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471902095821,"modified":1471902095821,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471902095810,"modified":1471902095810,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by manufacturer)

Example - http://localhost:48081/api/v1/deviceprofile/manufacturer/Honeywell (where Honeywell is the manufacturer associated to profiles)

get

get

Find all DeviceProfiles with a manufacture attribute matching that provided. List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find all DeviceProfiles with a manufacture attribute matching that provided. List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • manufacturer: (string)

HTTP status code 200

List of DeviceProfile matching on specified manufacturer.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

Example:

[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471902095821,"modified":1471902095821,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471902095810,"modified":1471902095810,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by name)

Example - http://localhost:48081/api/v1/deviceprofile/name/thermostat profile (where thermostat profile is the name of a profile)

delete get

delete

Remove the DeviceProfile designated by unique name. This does not remove associated commands. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided. Returns DataValidationException (HTTP 409) if devices still reference the profile.

get

Return the DeviceProfile matching given name (profile names should be unique). May be null if no profiles matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

Remove the DeviceProfile designated by unique name. This does not remove associated commands. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided. Returns DataValidationException (HTTP 409) if devices still reference the profile.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if the device profile cannot be found by the name provided

HTTP status code 409

if devices or provision watchers still reference the profile

HTTP status code 500

for unknown or unanticipated issues

Return the DeviceProfile matching given name (profile names should be unique). May be null if no profiles matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

URI Parameters

  • name: (string)

HTTP status code 200

device profile matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

Example:

{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471902095821,"modified":1471902095821,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471902095810,"modified":1471902095810,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if the device profile cannot be found by the name provided

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (upload YAML file)

Example - http://localhost:48081/api/v1/deviceprofile/uploadfile

post

post

Add a new DeviceProfile (and associated Command objects) via YAML profile file - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated command's name is a duplicate for the profile. Returns ClientException (HTTP 400) if the YAML file is empty.

Add a new DeviceProfile (and associated Command objects) via YAML profile file - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated command's name is a duplicate for the profile. Returns ClientException (HTTP 400) if the YAML file is empty.

HTTP status code 200

database generated identifier for the new device profile

HTTP status code 400

if the YAML file is empty

HTTP status code 409

if an associated command's name is a duplicate for the profile or if the name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by id)

Example - http://localhost:48081/api/v1/deviceprofile/dd5de4ff-ae3b-44b1-997d-5d410cd22e1c

get

get

Fetch a specific profile by database generated id. May return null if no profile with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the id provided.

Fetch a specific profile by database generated id. May return null if no profile with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the id provided.

URI Parameters

  • id: (string)

HTTP status code 200

device profile matching on id

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

Example:

{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471902095821,"modified":1471902095821,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471902095810,"modified":1471902095810,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}

HTTP status code 404

if the device profile cannot be found by the id provided

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (upload YAML)

Example - http://localhost:48081/api/v1/deviceprofile/upload

post

post

Add a new DeviceProfile (and associated Command objects) via YAML content - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated command's name is a duplicate for the profile.

Add a new DeviceProfile (and associated Command objects) via YAML content - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated command's name is a duplicate for the profile.

HTTP status code 200

database generated identifier for the new device profile

HTTP status code 400

if the YAML file is empty

HTTP status code 409

if an associated command's name is a duplicate for the profile or if the name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by name)

Example - http://localhost:48081/api/v1/deviceprofile/yaml/name/thermostat profile (where thermostat profile is the name of a profile)

get

get

Return, in yaml form, the DeviceProfiles matching given name (profile names should be unique). May be null if no profiles matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

Return, in yaml form, the DeviceProfiles matching given name (profile names should be unique). May be null if no profiles matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

URI Parameters

  • name: (string)

HTTP status code 200

device profile in YAML matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if the device profile cannot be found by the name provided

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by id)

Example - http://localhost:48081/api/v1/deviceprofile/yaml/dd5de4ff-ae3b-44b1-997d-5d410cd22e1c

get

get

Fetch the profile identified by database generated id and return as a YAML string. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. eturns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

Fetch the profile identified by database generated id and return as a YAML string. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. eturns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

URI Parameters

  • id: (string)

HTTP status code 200

device profile in YAML format

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

HTTP status code 404

if the device profile cannot be found by the id provided

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by model)

Example - http://localhost:48081/api/v1/deviceprofile/model/ABC123 (where ABC123 is a model associated to a profile)

get

get

Find all DeviceProfiles with a model attribute matching that provided. List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find all DeviceProfiles with a model attribute matching that provided. List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • model: (string)

HTTP status code 200

List of DeviceProfile matching on specified model.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

Example:

[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471902095821,"modified":1471902095821,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471902095810,"modified":1471902095810,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource (by label)

Example - http://localhost:48081/api/v1/deviceprofile/label/bacnet (where bacnet is a label associated to profiles)

get

get

Find all DeviceProfiles having at least one label matching the label provided. List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find all DeviceProfiles having at least one label matching the label provided. List may be empty if no profiles match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • label: (string)

HTTP status code 200

List of DeviceProfile matching on specified label

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

Example:

[{"id":"dd5de4ff-ae3b-44b1-997d-5d410cd22e1c","created":1471902095821,"modified":1471902095821,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471902095810,"modified":1471902095810,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

DeviceProfile Resource

Example - http://localhost:48081/api/v1/deviceprofile

post put get

post

Add a new DeviceProfile (and associated Command objects) - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated command's name is a duplicate for the profile.

put

Update the DeviceProfile identified by the id or name stored in the object provided. Id is used first, name is used second for identification purposes. Associated commands must be updated directly. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the profile cannot be found by the identifier provided.

get

Return all profiles sorted by id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new DeviceProfile (and associated Command objects) - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated command's name is a duplicate for the profile.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "template describing devices and sensors of the same nature in reporting the same data and offering the same commands", "title":"deviceprofile","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"manufacturer":{"type":"string","required":false,"title":"manufacturer"},"model":{"type":"string","required":false,"title":"model"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"description":{"type":"string","required":false,"title":"description"}, "resources":{"type":"array","required":false,"title":"resources","items":{"type":"string","title":"resources"},"uniqueItems":false}}}

Example:

{"origin":1471806386919,"name":"thermostat profile","description":"BACnet Honeywell thermostats","manufacturer":"Honeywell","model":"ABC123", "labels":["bacnet","thermostat","Honeywell"],"commands":[{"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling", "responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}], "parameterNames":["coolingpoint"]}}],"resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}]}

HTTP status code 200

database generated identifier for the new device profile

HTTP status code 400

for malformed or unparsable requests

HTTP status code 409

if an associated command's name is a duplicate for the profile or if the name is determined to not be unique with regard to others.

HTTP status code 500

for unknown or unanticipated issues

DeviceReport Resource (by id)

Example - http://localhost:48081/api/v1/devicereport/id/eb5771d3-93f6-4b14-b285-9ed836ed5e35

delete

delete

Remove the DevicReport designated by database generated id. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided id.

Remove the DevicReport designated by database generated id. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided id.

URI Parameters

  • id: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if no DeviceReport is found with the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceReport Resource (by name)

Example - http://localhost:48081/api/v1/devicereport/name/livingroom collection report (where livingroom collection report is the name of a device report)

delete get

delete

Remove the DevicReport designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided name.

get

Return DeviceReport matching given name (device report names should be unique). May be null if no report matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided name.

Remove the DevicReport designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no DeviceReport is found with the provided name

HTTP status code 500

for unknown or unanticipated issues

Return DeviceReport matching given name (device report names should be unique). May be null if no report matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

device report matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "description of values (value descriptors) that should be collected per device on a interval action", "title":"devicereport","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"device":{"type":"string","required":false,"title":"device"},"action":{"type":"string","required":false,"title":"action"},"expected":{"type":"array","required":false,"title":"expected","items":{"type":"string","title":"expected"},"uniqueItems":false}}}

Example:

{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471973592027,"modified":1471973592027,"origin":1471806386919,"name":"livingroom collection report","device":"livingroomthermostat","event":"temperature collection","expected":["temperature"]}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no DeviceReport is found with the provided name

HTTP status code 500

for unknown or unanticipated issues

DeviceReport Resource (by id)

Example - http://localhost:48081/api/v1/devicereport/eb5771d3-93f6-4b14-b285-9ed836ed5e35

get

get

Fetch a specific DeviceReport by database generated id. May return null if no report with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided id.

Fetch a specific DeviceReport by database generated id. May return null if no report with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided id.

URI Parameters

  • id: (string)

HTTP status code 200

device report matching on the id

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "description of values (value descriptors) that should be collected per device on a interval action", "title":"devicereport","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"device":{"type":"string","required":false,"title":"device"},"action":{"type":"string","required":false,"title":"action"},"expected":{"type":"array","required":false,"title":"expected","items":{"type":"string","title":"expected"},"uniqueItems":false}}}

Example:

{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471973592027,"modified":1471973592027,"origin":1471806386919,"name":"livingroom collection report","device":"livingroomthermostat","event":"temperature collection","expected":["temperature"]}

HTTP status code 404

if no DeviceReport is found with the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceReport Resources (by device name)

Example - http://localhost:48081/api/v1/devicereport/devicename/livingroomthermostat (where livingroomthermostat is the name of a device )

get

get

Return DeviceReports with associated device matching given name (device names should be unique). May be an empty list if no device matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return DeviceReports with associated device matching given name (device names should be unique). May be an empty list if no device matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • devicename: (string)

HTTP status code 200

device reports matching on device name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "description of values (value descriptors) that should be collected per device on a interval action", "title":"devicereport","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"device":{"type":"string","required":false,"title":"device"},"action":{"type":"string","required":false,"title":"action"},"expected":{"type":"array","required":false,"title":"expected","items":{"type":"string","title":"expected"},"uniqueItems":false}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471973592027,"modified":1471973592027,"origin":1471806386919,"name":"livingroom collection report","device":"livingroomthermostat","event":"temperature collection","expected":["temperature"]}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

Value Descriptor names (associated to device reports for given device name)

Example - http://localhost:48081/api/v1/devicereport/valueDescriptorsFor/livingroomthermostat (where livingroomthermostat is the name of a device )

get

get

Return list of value descriptor names associated to device reports associated to name of the device provided. May be an empty list if no device matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return list of value descriptor names associated to device reports associated to name of the device provided. May be an empty list if no device matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • devicename: (string)

HTTP status code 200

value descriptor names

Body

Type: application/json

Example:

["temperature", "rpm"]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

DeviceReport Resource

Example - http://localhost:48081/api/v1/devicereport

post put get

post

Add a new DeviceReport - name must be unique. Referenced objects (device, interval action) are all referenced in the new DeviceReport by name and must already be persisted. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if any referenced object cannot be found by its provided name.

put

Update the DeviceReport identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if any referenced object cannot be found by its provided name.

get

Return all device reports sorted by id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new DeviceReport - name must be unique. Referenced objects (device, interval action) are all referenced in the new DeviceReport by name and must already be persisted. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if any referenced object cannot be found by its provided name.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description": "description of values (value descriptors) that should be collected per device on a interval action", "title":"devicereport","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"device":{"type":"string","required":false,"title":"device"},"action":{"type":"string","required":false,"title":"action"},"expected":{"type":"array","required":false,"title":"expected","items":{"type":"string","title":"expected"},"uniqueItems":false}}}

Example:

{"origin":1471806386919,"name":"livingroom collection report","device":"livingroomthermostat","action":"temperature collection","expected":["temperature"]}

HTTP status code 200

database generated identifier for the new device report

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if any referenced object cannot be found by its provided name

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (by id)

Example - http://localhost:48081/api/v1/deviceservice/id/eb5771d3-93f6-4b14-b285-9ed836ed5e35

delete

delete

Remove the DeviceService designated by database generated id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Remove the DeviceService designated by database generated id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • id: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (by addressable name)

Example - http://localhost:48081/api/v1/deviceservice/addressablename/hvac thermo address (where hvac thermo address is the name of an addressable)

get

get

Find all device serices associated to the Addressable with the specified addressable name. List may be empty if no device services match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the name provided.

Find all device serices associated to the Addressable with the specified addressable name. List may be empty if no device services match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the name provided.

URI Parameters

  • addressablename: (string)

HTTP status code 200

List of DeviceServices associated to the addressable

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"manages devices and interfaces with core data","title":"deviceservice","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471922052444,"modified":1471922478043,"origin":1471806386919,"name":"home thermostat device service","description":"manager service for home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat","home"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471917059552,"modified":1471917059552,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}]

HTTP status code 404

if no addressable is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update op state by name)

Example - http://localhost:48081/api/v1/deviceservice/name/home thermostat device service/opstate/enabled (where home thermostat device service is the name of a device service)

put

put

Update the op status time of the device service by unique name of the device service. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

Update the op status time of the device service by unique name of the device service. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

URI Parameters

  • opState: (string)
  • name: (string)

HTTP status code 200

boolean indicating success of the operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update admin state by name)

Example - http://localhost:48081/api/v1/deviceservice/name/home thermostat device service/adminstate/unlocked (where home thermostat device service is the name of a device service)

put

put

Update the admin state of the device service by device service name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Update the admin state of the device service by device service name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • name: (string)
  • adminState: (string)

HTTP status code 200

boolean indicating success of the operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update last reported by name)

Example - http://localhost:48081/api/v1/deviceservice/name/home thermostat device service/lastreported/1471922060000 (where home thermostat device service is the name of a device service)

put

put

Update the last reported time of the device service by unique name of the device service. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

Update the last reported time of the device service by unique name of the device service. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

URI Parameters

  • time: (string)
  • name: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update last connected by name)

Example - http://localhost:48081/api/v1/deviceservice/name/home thermostat device service/lastconnected/1471922060000 (where home thermostat device service is the name of a device service)

put

put

Update the last connected time of the device service by unique name of the device service. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

Update the last connected time of the device service by unique name of the device service. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

URI Parameters

  • time: (string)
  • name: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 503

for unknown or unanticipated issues

DeviceService Resource (by name)

Example - http://localhost:48081/api/v1/deviceservice/name/home thermostat device service (where home thermostat device service is the name of a device service)

delete get

delete

Remove the DeviceService designated by name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

get

Return the DeviceService matching given name (service names should be unique). May be null if no services matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

Remove the DeviceService designated by name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 503

for unknown or unanticipated issues

Return the DeviceService matching given name (service names should be unique). May be null if no services matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

URI Parameters

  • name: (string)

HTTP status code 200

device service matching on name

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update op state)

Example - http://localhost:48081/api/v1/deviceservice/eb5771d3-93f6-4b14-b285-9ed836ed5e35/opstate/disabled

put

put

Update the op state of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Update the op state of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • opState: (string)

HTTP status code 200

boolean indicating success of the operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update admin state)

Example - http://localhost:48081/api/v1/deviceservice/eb5771d3-93f6-4b14-b285-9ed836ed5e35/adminstate/locked

put

put

Update the admin state of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Update the admin state of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • adminState: (string)

HTTP status code 200

boolean indicating success of the operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (update last reported)

Example - http://localhost:48081/api/v1/deviceservice/eb5771d3-93f6-4b14-b285-9ed836ed5e35/lastreported/1471922060100

put

put

Update the last reported time of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Update the last reported time of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • time: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 503

for unknown or unanticipated issues

DeviceService Resource (update last connected)

Example - http://localhost:48081/api/v1/deviceservice/eb5771d3-93f6-4b14-b285-9ed836ed5e35/lastconnected/1471922060000

put

put

Update the last connected time of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Update the last connected time of the device service by database generated identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • id: (string)
  • time: (string)

HTTP status code 200

boolean indicating success of update

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (by id)

Example - http://localhost:48081/api/v1/deviceservice/eb5771d3-93f6-4b14-b285-9ed836ed5e35

get

get

Fetch a specific device service by database generated id. May return null if no service with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

Fetch a specific device service by database generated id. May return null if no service with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

URI Parameters

  • id: (string)

HTTP status code 200

device service matching on id

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"manages devices and interfaces with core data","title":"deviceservice","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471922052444,"modified":1471922478043,"origin":1471806386919,"name":"home thermostat device service","description":"manager service for home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat","home"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471917059552,"modified":1471917059552,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}

HTTP status code 404

if no device service is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (by addressable)

Example - http://localhost:48081/api/v1/deviceservice/addressable/47237c46-3f03-4dc5-a3c1-84d7420d9903 (the id is an addressable id)

get

get

Find all device servicess associated to the Addressable with the specified addressable database generated identifier. List may be empty if no device service match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the id provided.

Find all device servicess associated to the Addressable with the specified addressable database generated identifier. List may be empty if no device service match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the id provided.

URI Parameters

  • addressableId: (string)

HTTP status code 200

List of DeviceServices associated to the addressable

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"manages devices and interfaces with core data","title":"deviceservice","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471922052444,"modified":1471922478043,"origin":1471806386919,"name":"home thermostat device service","description":"manager service for home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat","home"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471917059552,"modified":1471917059552,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}]

HTTP status code 404

if no addressablee is found for the provided id

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource (by label)

Example - http://localhost:48081/api/v1/deviceservice/label/hvac (where hvac is a label associated to device services)

get

get

Find all DeviceServices having at least one label matching the label provided. List may be empty if no device services match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find all DeviceServices having at least one label matching the label provided. List may be empty if no device services match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • label: (string)

HTTP status code 200

List of DeviceService matching on specified label

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"manages devices and interfaces with core data","title":"deviceservice","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1471922052444,"modified":1471922478043,"origin":1471806386919,"name":"home thermostat device service","description":"manager service for home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat","home"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471917059552,"modified":1471917059552,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

DeviceService Resource

Example - http://localhost:48081/api/v1/deviceservice

post put get

post

Add a new DeviceService - name must be unique. The Addressable must already exist and can be referenced by an included Addressable object containing the Addressable's id or name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated addressable (by id or name) is not found.

put

Update the DeviceServcie identified by the id or name stored in the object provided. Id is used first, name is used second for identification purposes. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the identifier provided.

get

Return all device services sorted by id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new DeviceService - name must be unique. The Addressable must already exist and can be referenced by an included Addressable object containing the Addressable's id or name. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if an associated addressable (by id or name) is not found.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"manages devices and interfaces with core data","title":"deviceservice","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"description":{"type":"string","required":false,"title":"description"},"lastConnected":{"type":"integer","required":false,"title":"lastConnected"},"lastReported":{"type":"integer","required":false,"title":"lastReported"},"labels":{"type":"array","required":false,"title":"labels","items":{"type":"string","title":"labels"},"uniqueItems":false},"adminState":{"type":"string","required":false,"title":"adminState"},"operatingState":{"type":"string","required":false,"title":"operatingState"},"addressable":{"type":"object","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"}}}}}

Example:

{"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"name":"hvac thermo address"}}

HTTP status code 200

database generated identifier for the new device service

HTTP status code 400

no addressable was provided for the new device service

HTTP status code 404

if an associated addressable (by id or name) is not found

HTTP status code 409

if the addressable name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues

ProvisionWatcher Resource (by id)

Example - http://localhost:48081/api/v1/provisionwatcher/id/47237c46-3f03-4dc5-a3c1-84d7420d9903

delete

delete

Remove the ProvisionWatcher designated by the database generated id for the ProvisionWatcher. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided id is found.

Remove the ProvisionWatcher designated by the database generated id for the ProvisionWatcher. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided id is found.

URI Parameters

  • id: (string)

    database generated id

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if no provision watcher with the provided id is found.

HTTP status code 500

for unknown or unanticipated issues

ProvisionWatcher Resource (by id)

Example - http://localhost:48081/api/v1/provisionwatcher/47237c46-3f03-4dc5-a3c1-84d7420d9903

get

get

Fetch a specific provision watcher by database generated id. May return null if no provision watcher matches on id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided id is found.

Fetch a specific provision watcher by database generated id. May return null if no provision watcher matches on id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided id is found.

URI Parameters

  • id: (string)

    database generated id

HTTP status code 200

provision watcher

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1473198611772,"modified":1473198611772,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"7076339c-77bb-4247-8cd3-d33fec29f296","created":1473198153474,"modified":1473198153474,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"f0cdf789-e40f-4d72-b35b-75528b605ac9","created":1473198153434,"modified":1473198153434,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]},"service":{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1473198210365,"modified":1473198210365,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473198197783,"modified":1473198197783,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}}

HTTP status code 404

if no provision watcher with the provided id is found.

HTTP status code 500

for unknown or unanticipated issues

ProvisionWatcher Resource (by name)

Example - http://localhost:48081/api/v1/provisionwatcher/name/bacnet watcher (where bacnet watcher is the unique name of an ProvisionWatcher)

delete get

delete

Remove the ProvisionWatcher designated by unique name identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided name is found.

get

Return ProvisionWatcher with matching name (name should be unique). May be null if none match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided name is found.

Remove the ProvisionWatcher designated by unique name identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided name is found.

URI Parameters

  • name: (string)

    unique name of provision watcher

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no provision watcher with the provided name is found.

HTTP status code 500

for unknown or unanticipated issues.

Return ProvisionWatcher with matching name (name should be unique). May be null if none match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided name is found.

URI Parameters

  • name: (string)

    unique name of provision watcher

HTTP status code 200

provision watcher matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1473198611772,"modified":1473198611772,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"7076339c-77bb-4247-8cd3-d33fec29f296","created":1473198153474,"modified":1473198153474,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"f0cdf789-e40f-4d72-b35b-75528b605ac9","created":1473198153434,"modified":1473198153434,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]},"service":{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1473198210365,"modified":1473198210365,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473198197783,"modified":1473198197783,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no provision watcher with the provided name is found.

HTTP status code 500

for unknown or unanticipated issues.

ProvisionWatcher Resource (by profile)

Example - http://localhost:48081/api/v1/provisionwatcher/profile/47237c46-3f03-4dc5-a3c1-84d7420d9903 (where the id is a device profile id)

get

get

Find all provision watchers associated to the DeviceProfile with the specified profile database generated identifier. List may be empty if no provision watchers match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the id provided.

Find all provision watchers associated to the DeviceProfile with the specified profile database generated identifier. List may be empty if no provision watchers match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the id provided.

URI Parameters

  • profileId: (string)

HTTP status code 200

List of ProvisionWatchers associated to the device profile

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

[{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473119523238,"modified":1473119523238,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473119034719,"modified":1473119034719,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"57ce033aadd4b99e5d020531","created":1473119034697,"modified":1473119034697,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]}}]

HTTP status code 404

if no device profile match on the id provided.

HTTP status code 500

for unknown or unanticipated issues.

ProvisionWatcher Resource (by profile name)

Example - http://localhost:48081/api/v1/provisionwatcher/profilename/thermostat profile (where 'thermostat profile' is the name of a device profile)

get

get

Find all provision watchers associated to the DeviceProfile with the specified profile name. List may be empty if no provision watcher match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the name provided.

Find all provision watchers associated to the DeviceProfile with the specified profile name. List may be empty if no provision watcher match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the name provided.

URI Parameters

  • profilename: (string)

HTTP status code 200

List of ProvisionWatcher associated to the profile

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1473198611772,"modified":1473198611772,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"7076339c-77bb-4247-8cd3-d33fec29f296","created":1473198153474,"modified":1473198153474,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"f0cdf789-e40f-4d72-b35b-75528b605ac9","created":1473198153434,"modified":1473198153434,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]},"service":{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1473198210365,"modified":1473198210365,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473198197783,"modified":1473198197783,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no DeviceProfile match on the id provided.

HTTP status code 500

for unknown or unanticipated issues.

ProvisionWatcher Resource (by service)

Example - http://localhost:48081/api/v1/provisionwatcher/service/47237c46-3f03-4dc5-a3c1-84d7420d9903 (where the id is a device service id)

get

get

Find the provision watchers associated to the DeviceService with the specified service database generated identifier. List may be empty if no provision watchers match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the id provided.

Find the provision watchers associated to the DeviceService with the specified service database generated identifier. List may be empty if no provision watchers match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the id provided.

URI Parameters

  • serviceId: (string)

HTTP status code 200

List of ProvisionWatchers associated to the device service

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1473198611772,"modified":1473198611772,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"7076339c-77bb-4247-8cd3-d33fec29f296","created":1473198153474,"modified":1473198153474,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"f0cdf789-e40f-4d72-b35b-75528b605ac9","created":1473198153434,"modified":1473198153434,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]},"service":{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1473198210365,"modified":1473198210365,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473198197783,"modified":1473198197783,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}}]

HTTP status code 404

if no device service match on the id provided.

HTTP status code 500

for unknown or unanticipated issues.

ProvisionWatcher Resource (by service name)

Example - http://localhost:48081/api/v1/provisionwatcher/servicename/home thermostat device service (where 'home thermostat device service' is the name of a device service)

get

get

Find the provision watchers associated to the DeviceService with the specified service name. List may be none if no provision watcher match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the name provided.

Find the provision watchers associated to the DeviceService with the specified service name. List may be none if no provision watcher match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the name provided.

URI Parameters

  • servicename: (string)

HTTP status code 200

List of ProvisionWatcher associated to the device service

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1473198611772,"modified":1473198611772,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"7076339c-77bb-4247-8cd3-d33fec29f296","created":1473198153474,"modified":1473198153474,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"f0cdf789-e40f-4d72-b35b-75528b605ac9","created":1473198153434,"modified":1473198153434,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]},"service":{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1473198210365,"modified":1473198210365,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473198197783,"modified":1473198197783,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no DeviceService match on the id provided.

HTTP status code 500

for unknown or unanticipated issues.

ProvisionWatcher Resource (by identifier key value pair)

Example - http://localhost:48081/api/v1/provisionwatcher/identifier/HTTP/10.0.1.1 (where HTTP and 10.0.1.1 are the key value pair of the provision watcher identifier to be searched for )

get

get

Find the provision watchers associated to the identifier key/value pair. The identifier key/value pair identify a protocol and address of the protocol to watch for by the Device Service. List may be none if no provision watcher match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Find the provision watchers associated to the identifier key/value pair. The identifier key/value pair identify a protocol and address of the protocol to watch for by the Device Service. List may be none if no provision watcher match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • key: (string)
  • value: (string)

HTTP status code 200

List of ProvisionWatcher associated to the device service

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

[{"id":"eb5771d3-93f6-4b14-b285-9ed836ed5e35","created":1473198611772,"modified":1473198611772,"origin":1471806386919,"name":"bacnet watcher","identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.1.1"},"profile":{"id":"7076339c-77bb-4247-8cd3-d33fec29f296","created":1473198153474,"modified":1473198153474,"origin":1471806386919,"name":"thermostat profile","manufacturer":"Honeywell","model":"ABC123","labels":["bacnet","thermostat","Honeywell"],"description":"BACnet Honeywell thermostats","resources":[{"CurrentHumidity":{"get":[{"parameter":"CurrentHumidity","operation":"get","object":"AnalogValue_22"}]}}],"commands":[{"id":"f0cdf789-e40f-4d72-b35b-75528b605ac9","created":1473198153434,"modified":1473198153434,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]},"service":{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1473198210365,"modified":1473198210365,"origin":1471806386919,"name":"home thermostat device service","description":"manage home thermostats","lastConnected":0,"lastReported":0,"labels":["hvac","thermostat"],"adminState":"unlocked","operatingState":"enabled","addressable":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1473198197783,"modified":1473198197783,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}}}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues.

ProvisionWatcher Resource

Example - http://localhost:48081/api/v1/provisionwatcher

post put get

post

Add a new ProvisionWatcher - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if profile service are unknown

put

Update the ProvisionWatcher identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided id is found.

get

Return all provision watcher objects sorted by database generated id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new ProvisionWatcher - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns DataValidationException (HTTP 409) if profile service are unknown

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"provisionwatcher","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

{"name":"bacnet watcher", "origin":1471806386919, "identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903"},"service":{"id":"57ce033aadd4b99e5d020538"}} or {"name":"bacnet watcher", "origin":1471806386919, "identifiers":{"MAC":"00-05-1B-A1-99-99","HTTP":"10.0.0.1"},"profile":{"name":"thermostat profile"},"service":{"name":"home thermostat device service"}}

HTTP status code 200

new database generated id for the new ProvisionWatcher

HTTP status code 400

for malformed or unparsable requests

HTTP status code 409

if an associated object (Profile, Service) cannot be found with the id or name provided or if the watcher name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues or for any duplicate name (key) error.

Addressable Resource (by id)

Example - http://localhost:48081/api/v1/addressable/id/47237c46-3f03-4dc5-a3c1-84d7420d9903

delete

delete

Remove the Addressable designated by the database generated id for the Addressable. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no addressable with the provided id is found.

Remove the Addressable designated by the database generated id for the Addressable. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no addressable with the provided id is found.

URI Parameters

  • id: (string)

    database generated id

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if no addressable with the provided id is found.

HTTP status code 409

if the adressable is still in use

HTTP status code 500

for unknown or unanticipated issues

Addressable Resource (by id)

Example - http://localhost:48081/api/v1/addressable/47237c46-3f03-4dc5-a3c1-84d7420d9903

get

get

Fetch a specific addressable by database generated id. May return null if no addressable matches on id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if not found by the id.

Fetch a specific addressable by database generated id. May return null if no addressable matches on id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if not found by the id.

URI Parameters

  • id: (string)

    database generated id

HTTP status code 200

addressable

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471883118326,"modified":1471883691145,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomhvac","publisher":"none","user":"none","password":"none","topic":"none","method":"GET"}

HTTP status code 404

if no addressable with the provided id is found

HTTP status code 500

for unknown or unanticipated issues

Addressable Resource (by name)

Example - http://localhost:48081/api/v1/addressable/name/hvac thermo address (where hvac thermo address is the unique name of an Addressable)

delete get

delete

Remove the Addressable designated by unique name identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no addressable with the provided name is found.

get

Return Addressable with matching name (name should be unique). May be null if none match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if not found by name.

Remove the Addressable designated by unique name identifier. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no addressable with the provided name is found.

URI Parameters

  • name: (string)

    unique name of addressable

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no addressable with the provided name is found.

HTTP status code 500

for unknown or unanticipated issues.

Return Addressable with matching name (name should be unique). May be null if none match. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if not found by name.

URI Parameters

  • name: (string)

    unique name of addressable

HTTP status code 200

addressable matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471883825676,"modified":1471883825676,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none","method":"GET"}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no addressable with the provided name is found

HTTP status code 500

for unknown or unanticipated issues.

Addressable Resource (by topic)

Example - http://localhost:48081/api/v1/addressable/topic/thermodata (where thermodata is the name of Addressables' topic)

get

get

Return Addressable objects with given topic. List may be empty if none are associated to the topic. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return Addressable objects with given topic. List may be empty if none are associated to the topic. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • topic: (string)

    topic name (as in MQTT topic name)

HTTP status code 200

list of addressable matching topic

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

[{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471884234787,"modified":1471884234787,"origin":1471806386919,"name":"hvac thermo address2","protocol":"TCP","address":"172.17.0.1","port":60601,"path":"none","publisher":"DELLPUB","user":"dell","password":"abc123","topic":"thermodata","method":"GET"}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues.

Addressable Resource (by port)

Example - http://localhost:48081/api/v1/addressable/port/48089 (where 48089 is the name of Addressables' topic)

get

get

Return Addressable objects with given port. List may be empty if none are associated to the port. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return Addressable objects with given port. List may be empty if none are associated to the port. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • port: (string)

HTTP status code 200

list of addressable matching port

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

[{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471884040857,"modified":1471884040857,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none","method":"GET"}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues

Addressable Resource (by publisher)

Example - http://localhost:48081/api/v1/addressable/publisher/DELLPUB (where DELLPUB is an Addressable publisher)

get

get

Return Addressable objects with given publisher. List may be empty if none are associated to the publisher. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return Addressable objects with given publisher. List may be empty if none are associated to the publisher. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • publisher: (string)

    publisher name (as in MQTT publisher)

HTTP status code 200

list of addressable matching publisher

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

[{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471884234787,"modified":1471884234787,"origin":1471806386919,"name":"hvac thermo address2","protocol":"TCP","address":"172.17.0.1","port":60601,"path":"none","publisher":"DELLPUB","user":"dell","password":"abc123","topic":"thermodata","method":"GET"}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues.

Addressable Resource (by address)

Example - http://localhost:48081/api/v1/addressable/address/172.17.0.1

get

get

Return Addressable objects with given address. List may be empty if none are associated to the address. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return Addressable objects with given address. List may be empty if none are associated to the address. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • address: (string)

    address (as in URL address)

HTTP status code 200

list of addressable matching address

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

[{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471884040857,"modified":1471884040857,"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"},{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471884234787,"modified":1471884234787,"origin":1471806386919,"name":"hvac thermo address2","protocol":"TCP","address":"172.17.0.1","port":60601,"path":"none","publisher":"DELLPUB","user":"dell","password":"abc123","topic":"thermodata","method":"GET"}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues.

Addressable Resource

Example - http://localhost:48081/api/v1/addressable

post put get

post

Add a new Addressable - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

put

Update the Addressable identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no addressable with the provided id is found.

get

Return all addressable objects sorted by database generated id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new Addressable - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"addressable","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"protocol":{"type":"string","required":false,"title":"protocol"},"address":{"type":"string","required":false,"title":"address"},"port":{"type":"integer","required":false,"title":"port"},"path":{"type":"string","required":false,"title":"path"},"publisher":{"type":"string","required":false,"title":"publisher"},"user":{"type":"string","required":false,"title":"user"},"password":{"type":"string","required":false,"title":"password"},"topic":{"type":"string","required":false,"title":"topic"},"method":{"type":"string","required":true,"title":"method"}}}

Example:

{"origin":1471806386919,"name":"hvac thermo address","protocol":"HTTP","address":"172.17.0.1","port":48089,"path":"/livingroomthermostat","publisher":"none","user":"none","password":"none","topic":"none"}

HTTP status code 200

new database generated id for the new Addressable

HTTP status code 400

for malformed or unparsable requests

HTTP status code 409

if the name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues or for any duplicate name (key) error.

Command Resource (by id)

Example - http://localhost:48081/api/v1/command/47237c46-3f03-4dc5-a3c1-84d7420d9903

get

get

Fetch a specific command by database generated id. May return null if no commands with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no command with the provided id is found.

Fetch a specific command by database generated id. May return null if no commands with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no command with the provided id is found.

URI Parameters

  • id: (string)

HTTP status code 200

Successful Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"command","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"get":{"type":"object","properties":{"path":{"type":"string","required":false,"title":"path"},"responses":{"type":"object","properties":{"code":{"type":"string","required":false,"title":"code"},"description":{"type":"string","required":false,"title":"description"},"expectedValues":{"type":"string","required":false,"title":"expectedValues"}}}}},"put":{"type":"object","properties":{"path":{"type":"string","required":false,"title":"path"}}}}}

Example:

{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471885717486,"modified":1471885944737,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}

HTTP status code 404

if no command with the provided id is found.

HTTP status code 500

for unknown or unanticipated issues.

Command Resource

Example - http://localhost:48081/api/v1/command/name/cooling point (where cooling point is the name of a command)

get

get

Return Command objects with given name. Name is not unique for all of EdgeX but is unique per any associated Device Profile. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

Return Command objects with given name. Name is not unique for all of EdgeX but is unique per any associated Device Profile. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues.

URI Parameters

  • name: (string)

HTTP status code 200

Successful Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"command","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"get":{"type":"object","properties":{"path":{"type":"string","required":false,"title":"path"},"responses":{"type":"object","properties":{"code":{"type":"string","required":false,"title":"code"},"description":{"type":"string","required":false,"title":"description"},"expectedValues":{"type":"string","required":false,"title":"expectedValues"}}}}},"put":{"type":"object","properties":{"path":{"type":"string","required":false,"title":"path"}}}}}

Example:

[{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471885717486,"modified":1471885944737,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}]

HTTP status code 400

for malformed or unparsable requests

HTTP status code 500

for unknown or unanticipated issues.

Command Resource

Example - http://localhost:48081/api/v1/command

get

get

Return all command objects. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Command Resource (by device id)

Example - http://localhost:48081/api/v1/command/device/47237c46-3f03-4dc5-a3c1-84d7420d9903

get

get

Fetch commands by device id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no command with the provided id is found.

Fetch commands by device id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no command with the provided id is found.

URI Parameters

  • id: required (string)

HTTP status code 200

Successful Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"command","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"get":{"type":"object","properties":{"path":{"type":"string","required":false,"title":"path"},"responses":{"type":"object","properties":{"code":{"type":"string","required":false,"title":"code"},"description":{"type":"string","required":false,"title":"description"},"expectedValues":{"type":"string","required":false,"title":"expectedValues"}}}}},"put":{"type":"object","properties":{"path":{"type":"string","required":false,"title":"path"}}}}}

Example:

{"id":"47237c46-3f03-4dc5-a3c1-84d7420d9903","created":1471885717486,"modified":1471885944737,"origin":1471806386919,"name":"cooling point","get":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]},"put":{"path":"/cooling","responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}],"parameterNames":["coolingpoint"]}}

HTTP status code 404

if no device exists for the provided id.

HTTP status code 500

for unknown or unanticipated issues.

Edgex API Version

Example - http://localhost:48081/api/version

get

get

Get the API version