core-command API documentation version 1.1.x

http://localhost:48082/api

Welcome

Welcome to the Core Command Microservice API Documentation.

Ping Resource

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

get

get

Test service providing an indication that the service is available.

Config Resource

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

get

get

Fetch the current state of the service's configuration.

Metrics Resource

Example - http://localhost:48082/api/v1/metrics

get

get

Fetch the current state of the service's metrics.

Issue command

Example - http://localhost:48082/api/v1/device/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6/command/8829622b-3c6a-47d2-8afc-80171f474056

get put

get

Issue the get command referenced by the command id to the device/sensor (also referenced by database generated id) it is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided. Throws LockedException (HTTP 423) if the device is locked (admin state).

put

Issue the put command referenced by the command id to the device/sensor (also referenced by database generated id) it is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided. Throws LockedException (HTTP 423) if the device is locked (admin state).

Issue the get command referenced by the command id to the device/sensor (also referenced by database generated id) it is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided. Throws LockedException (HTTP 423) if the device is locked (admin state).

URI Parameters

  • id: required (string)
  • commandid: required (string)

HTTP status code 200

String as returned by the device/sensor via the device service.

HTTP status code 400

if the request is malformed or unparsable

HTTP status code 404

if no device exists by the id provided

HTTP status code 423

if the device is locked (admin state).

HTTP status code 500

for unanticipated or unknown issues encountered.

Issue the put command referenced by the command id to the device/sensor (also referenced by database generated id) it is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided. Throws LockedException (HTTP 423) if the device is locked (admin state).

URI Parameters

  • id: required (string)
  • commandid: required (string)

Body

Type: application/json

Example:

{"temp":72}

HTTP status code 200

String as returned by the device/sensor via the device service.

HTTP status code 400

if the request is malformed or unparsable

HTTP status code 404

if no device exists by the id provided

HTTP status code 423

if the device is locked (admin state)

HTTP status code 500

for unanticipated or unknown issues encountered.

Device & their commands by id

Example - http://localhost:48082/api/v1/device/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6

get

get

Retrieve a device (by database generated id) and its command offerings. Throws ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided.

Retrieve a device (by database generated id) and its command offerings. Throws ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the id provided.

URI Parameters

  • id: required (string)

HTTP status code 200

CommandResponse containing the device and its commands

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"commandresponse","properties":{"host":{"type":"string","required":false,"title":"host"},"device":{"type":"object","$ref":"#/schemas/device","required":false,"title":"device"}}}

Example:

{"name":"livingroomthermostat","id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","description":"living room HVAC thermostat","labels":["home","hvac","thermostat"],"adminState":"unlocked","opState":"enabled","lastConnected":0,"lastReported":0,"locationObject":"{lat:45.45,long:47.80}","commands":[{"id":"8829622b-3c6a-47d2-8afc-80171f474056","name":"cooling point","get":{"url":"http://localhost:48082/api/v1/device/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6/api/v1/command/8829622b-3c6a-47d2-8afc-80171f474056"},"put":{"url":"http://localhost:48082/api/v1/device/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6/api/v1/command/8829622b-3c6a-47d2-8afc-80171f474056","parameters":[{"name":"coolingpoint","value":"72"}],"responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]}}]}

HTTP status code 404

if no device exists by the id provided.

HTTP status code 500

for unanticipated or unknown issues encountered.

Device & their commands by name

Example - http://localhost:48082/api/v1/device/name/livingroomthermostat

get

get

Retrieve a device (by name) and its command offerings. Throws ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the name provided.

Retrieve a device (by name) and its command offerings. Throws ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists by the name provided.

URI Parameters

  • name: required (string)

HTTP status code 200

CommandResponse containing the device and its commands

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"commandresponse","properties":{"host":{"type":"string","required":false,"title":"host"},"device":{"type":"object","$ref":"#/schemas/device","required":false,"title":"device"}}}

Example:

{"name":"livingroomthermostat","id":"ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6","description":"living room HVAC thermostat","labels":["home","hvac","thermostat"],"adminState":"unlocked","opState":"enabled","lastConnected":0,"lastReported":0,"locationObject":"{lat:45.45,long:47.80}","commands":[{"id":"8829622b-3c6a-47d2-8afc-80171f474056","name":"cooling point","get":{"url":"http://localhost:48082/api/v1/device/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6/api/v1/command/8829622b-3c6a-47d2-8afc-80171f474056"},"put":{"url":"http://localhost:48082/api/v1/device/ebe456c9-b761-42bf-9bf8-1ca0a6c7cfc6/api/v1/command/12da905b-97d2-4a58-b9ab-84a71980b363","parameters":[{"name":"coolingpoint","value":"72"}],"responses":[{"code":"200","description":"ok","expectedValues":["temperature"]}]}}]}

HTTP status code 404

if no device exists by the name provided.

HTTP status code 500

for unanticipated or unknown issues encountered.

Devices & their commands

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

get

get

Retrieve a list of (all) devices and their command offerings. Throws ServiceException (HTTP 500) for unanticipated or unknown issues encountered.

Issue command

Example - http://localhost:48082/api/v1/device/name/RPIMotionDetector/command/Set_Green_Led

get put

get

Issue the get command referenced by the command name to the device/sensor (also referenced by name). It is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if device with given name does not exist or device doesn't have command with the given commandname. Throws LockedException (HTTP 423) if device adminState is locked.

put

Issue the put command referenced by the command name to the device/sensor (also referenced by name) it is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if device with given name does not exist or device doesn't have command with the given commandname. Throws LockedException (HTTP 423) if device adminState is locked.

Issue the get command referenced by the command name to the device/sensor (also referenced by name). It is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if device with given name does not exist or device doesn't have command with the given commandname. Throws LockedException (HTTP 423) if device adminState is locked.

URI Parameters

  • name: required (string)
  • commandname: required (string)

HTTP status code 200

String as returned by the device/sensor via the device service.

HTTP status code 400

if the request is malformed or unparsable

HTTP status code 404

if device with given name does not exist or device doesn't have command with the given commandname.

HTTP status code 423

if the device is locked (admin state).

HTTP status code 500

for unanticipated or unknown issues encountered.

Issue the put command referenced by the command name to the device/sensor (also referenced by name) it is associated to via the device service. ServiceException (HTTP 500) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if device with given name does not exist or device doesn't have command with the given commandname. Throws LockedException (HTTP 423) if device adminState is locked.

URI Parameters

  • name: required (string)
  • commandname: required (string)

Body

Type: application/json

Example:

{"temp":72}

HTTP status code 200

String as returned by the device/sensor via the device service.

HTTP status code 400

if the request is malformed or unparsable

HTTP status code 404

if device with given name does not exist or device doesn't have a command with the given commandname.

HTTP status code 423

if the device is locked (admin state)

HTTP status code 500

for unanticipated or unknown issues encountered

Edgex API Version

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

get

get

Get the API version