device-virtual API documentation version v1

http://device-virtual:49990/api/v1

Ping Resource

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

get

get

Test service providing an indication that the service is available.

Command Device (by ID) with Command Name

Example--http://localhost:49990/api/v1/device/57bd0f2d32d258ad3fcd2d4b/Command

get put post

get

Issue the GET command referenced by the command to the device/sensor (referenced by database-generated ID) to which it is associated thorugh the Device Service. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists for the ID provided. Throws LockedException (HTTP 423) if the device or service is locked (admin state) or disabled (operating state).

put

Issues the PUT command referenced by the command to the device/sensor (referenced by database-generated ID) to which it is associated through the Device Service. ServiceException (HTTP 503) 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 or service is locked (admin state).

post

Issues the PUT command referenced by the command to the device/sensor (referenced by database generated ID) to which it is associated through the device service. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists for the ID provided. Throws LockedException (HTTP 423) if the device or service is locked (admin state).

Issue the GET command referenced by the command to the device/sensor (referenced by database-generated ID) to which it is associated thorugh the Device Service. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists for the ID provided. Throws LockedException (HTTP 423) if the device or service is locked (admin state) or disabled (operating state).

URI Parameters

  • id: (string)
  • command: (string)

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"responseobject","properties":{"ValueDescriptorName":{"type":"object","required":false,"title":"ValueDescriptorName"}}}

Example:

{"VDS-CurrentTemperature": "32.52"}

HTTP status code 200

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

HTTP status code 404

If no device exists by the ID provided.

HTTP status code 423

If the device or service is locked (admin state) or disabled (operating state).

HTTP status code 503

For unanticipated or unknown issues encountered.

Issues the PUT command referenced by the command to the device/sensor (referenced by database-generated ID) to which it is associated through the Device Service. ServiceException (HTTP 503) 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 or service is locked (admin state).

URI Parameters

  • id: (string)
  • command: (string)

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"responseobject","properties":{"ValueDescriptorName":{"type":"object","required":false,"title":"ValueDescriptorName"}}}

Example:

{"VDS-CurrentTemperature": "32.52"}

HTTP status code 200

String as returned by the device/sensor through the Device Service.

HTTP status code 404

If no device exists for the ID provided.

HTTP status code 423

If the device or service is locked (admin state) or disabled (operating state).

HTTP status code 503

For unanticipated or unknown issues encountered.

Issues the PUT command referenced by the command to the device/sensor (referenced by database generated ID) to which it is associated through the device service. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws NotFoundException (HTTP 404) if no device exists for the ID provided. Throws LockedException (HTTP 423) if the device or service is locked (admin state).

URI Parameters

  • id: (string)
  • command: (string)

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"responseobject","properties":{"ValueDescriptorName":{"type":"object","required":false,"title":"ValueDescriptorName"}}}

Example:

{"VDS-CurrentTemperature": "32.52"}

HTTP status code 200

String as returned by the device/sensor through the Device Service.

HTTP status code 404

If no device exists for the ID provided.

HTTP status code 423

If the device or service is locked (admin state) or disabled (operating state).

HTTP status code 503

For unanticipated or unknown issues encountered.

Command all operational Devices for the service with command name.

Example--http://localhost:49990/api/v1/device/all/Command

get put post

get

Issues the get command referenced by the command to all operational device(s)/sensor(s) that are associated to the device service and have this command. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws LockedException (HTTP 423) if the device service is locked (admin state).

put

Issues the PUT command referenced by the command to all operational device(s)/sensor(s) that are associated to the device service and have this command. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws LockedException (HTTP 423) if the device service is locked (admin state).

post

Issues the put command referenced by the command to all operational device(s)/sensor(s) that are associated to the Device Service and have this command. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws LockedException (HTTP 423) if the device service is locked (admin state).

Issues the get command referenced by the command to all operational device(s)/sensor(s) that are associated to the device service and have this command. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws LockedException (HTTP 423) if the device service is locked (admin state).

URI Parameters

  • command: (string)

Body

Type: application/json

Schema:

{"type":"array","$schema":"http://json-schema.org/draft-03/schema#","title":"responseobjects","items":{"type":"object","required":false,"$ref":"#/schemas/responseobject"}}

Example:

[{"VDS-CurrentTemperature": "32.52"},{"VDS-CurrentHumidity": "1.0"}]

HTTP status code 200

String as returned by the device(s)/sensor(s) through the Device Service.

HTTP status code 423

If the device service is locked (admin state).

HTTP status code 503

For unanticipated or unknown issues encountered.

Issues the PUT command referenced by the command to all operational device(s)/sensor(s) that are associated to the device service and have this command. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws LockedException (HTTP 423) if the device service is locked (admin state).

URI Parameters

  • command: (string)

Body

Type: application/json

Schema:

{"type":"array","$schema":"http://json-schema.org/draft-03/schema#","title":"responseobjects","items":{"type":"object","required":false,"$ref":"#/schemas/responseobject"}}

Example:

[{"VDS-CurrentTemperature": "32.52"},{"VDS-CurrentHumidity": "1.0"}]

HTTP status code 200

String as returned by the device(s)/sensor(s) through the device service.

HTTP status code 423

If the device service is locked (admin state).

HTTP status code 503

For unanticipated or unknown issues encountered.

Issues the put command referenced by the command to all operational device(s)/sensor(s) that are associated to the Device Service and have this command. ServiceException (HTTP 503) for unanticipated or unknown issues encountered. Throws LockedException (HTTP 423) if the device service is locked (admin state).

URI Parameters

  • command: (string)

Body

Type: application/json

Schema:

{"type":"array","$schema":"http://json-schema.org/draft-03/schema#","title":"responseobjects","items":{"type":"object","required":false,"$ref":"#/schemas/responseobject"}}

Example:

[{"VDS-CurrentTemperature": "32.52"},{"VDS-CurrentHumidity": "1.0"}]

HTTP status code 200

String as returned by the device(s)/sensor(s) through the device service.

HTTP status code 423

If the device service is locked (admin state).

HTTP status code 503

For unanticipated or unknown issues encountered.

Update Callback

Example--http://localhost:49990/api/v1/callback

post put delete

post

Add the object referred to by the database ID. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the object cannot be found by the ID provided in metadata.

put

Update the object referred to by the database ID. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the object cannot be found by the id provided.

delete

Delete the object referred to by the database ID. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the object cannot be found by the ID provided.

Add the object referred to by the database ID. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the object cannot be found by the ID provided in metadata.

HTTP status code 200

Boolean indicating success of the operation.

HTTP status code 404

If the object cannot be found by the ID provided.

HTTP status code 503

For unknown or unanticipated issues.

Run device discovery request for all registered Provision Watchers

Example--http://localhost:49990/api/v1/discovery

post

post

Run the discovery request for a Device Service. Does not do anything unlesss the driver functionality is instrumented. Returns ServiceException (HTTP 503) for unknown or unanticipated issues.

Run the discovery request for a Device Service. Does not do anything unlesss the driver functionality is instrumented. Returns ServiceException (HTTP 503) for unknown or unanticipated issues.

HTTP status code 200

The service is running the discovery request.

HTTP status code 503

For unknown or unanticipated issues.

Set the Device Service data transformation state

Example--http://localhost:49990/api/v1/debug/transformData/false (sets the device service to not transform data to or from the devices)

get

get

Tells the Device Service to pass data modified or unmodified to and from the devices. Returns ServiceException (HTTP 503) for unknown or unanticipated issues.

Tells the Device Service to pass data modified or unmodified to and from the devices. Returns ServiceException (HTTP 503) for unknown or unanticipated issues.

URI Parameters

  • transformData: (boolean)

HTTP status code 200

Set the data transformation state successfully.

HTTP status code 503

For unknown or unanticipated issues.