Ping Resource

get

ping

Device Resource (by id)

delete

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

Device Resource (set op state by name)

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

put

Update the op status time of the device by unique name of the device. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Device Resource (set admin state by name)

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

put

Update the admin state of the device by device name. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Device Resource (set last reported by name)

put

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

Device Resource (set last reported by name)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Device Resource (set last connected by name)

put

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

Device Resource (set last connected by name)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the name provided.

Device Resource (by name)

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

delete

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

get

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

Device Resource (set op state by id)

put

Update the op state of the device by database generated identifier. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Device Resource (set admin state by id)

put

Update the admin state of the device by database generated identifier. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Device Resource (set last reported by id)

put

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

Device Resource (set last reported by id)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Device Resource (set last connected by id)

put

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

Device Resource (set last connected by id)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device cannot be found by the identifier provided.

Device Resource (by id)

get

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

Device Resource (by label)

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

get

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

Device Resource (by profile)

Example - http://localhost:48081/api/v1/device/profile/57bc6d7b555e5218873e5a2f (where the id is a device profile id)

get

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

Device Resource (by service)

Example - http://localhost:48081/api/v1/device/service/57bc6d6a555e5218873e5a2d (where the id is the associated device service id)

get

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

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

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the name provided.

Device Resource (by addressable name)

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

get

Find all devices associated to the Addressable with the specified addressable name. List may be empty if no device match. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the name provided.

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

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

Device Resource (by addressable)

get

Find all devices associated to the Addressable with the specified addressable database generated identifier. List may be empty if no device match. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the id provided.

Device Resource

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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

DeviceProfile Resource (by id)

delete

Remove the DeviceProfile designated by database generated id. This does not remove associated commands. Returns ServiceException (HTTP 503) 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.

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

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 ServiceException (HTTP 503) 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

Find all DeviceProfiles with a manufacture attribute matching that provided. List may be empty if no profiles match. Returns ServiceException (HTTP 503) 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

Remove the DeviceProfile designated by unique name. This does not remove associated commands. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

DeviceProfile Resource (upload YAML file)

post

Add a new DeviceProfile (and associated Command objects) via YAML profile file - name must be unique. Returns ServiceException (HTTP 503) 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.

DeviceProfile Resource (by id)

get

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

DeviceProfile Resource (upload YAML)

post

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

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

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device profile cannot be found by the name provided.

DeviceProfile Resource (by id)

get

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

DeviceProfile Resource (by model)

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

get

Find all DeviceProfiles with a model attribute matching that provided. List may be empty if no profiles match. Returns ServiceException (HTTP 503) 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

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

DeviceProfile Resource

post

Add a new DeviceProfile (and associated Command objects) - name must be unique. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

DeviceReport Resource (by id)

delete

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

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

Remove the DevicReport designated by name. ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no DeviceReport is found with the provided name.

DeviceReport Resource (by id)

get

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

DeviceReport Resources (by device name)

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

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 ServiceException (HTTP 503) 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

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 ServiceException (HTTP 503) for unknown or unanticipated issues.

DeviceReport Resource

post

Add a new DeviceReport - name must be unique. Referenced objects (device, schedule event) are all referenced in the new DeviceReport by name and must already be persisted. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

DeviceService Resource (by id)

delete

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

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

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

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

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

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

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

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

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

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

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

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

Remove the DeviceService designated by name. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if the device service cannot be found by the name provided.

DeviceService Resource (update op state)

put

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

DeviceService Resource (update admin state)

put

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

DeviceService Resource (update last reported)

put

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

DeviceService Resource (update last connected)

put

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

DeviceService Resource (by id)

get

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

DeviceService Resource (by addressable)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no Addressable match on the id provided.

DeviceService Resource (by label)

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

get

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

DeviceService Resource

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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

ScheduleEvent Resource (by id)

delete

Remove the ScheduleEvent designated by database generated id. ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no ScheduleEvent is found with the provided id. DataValidationException (HTTP 409) if an attempt to delete a schedule event still being referenced by device reports.

ScheduleEvent Resource (by name)

Example - http://localhost:48081/api/v1/scheduleevent/name/scrub pushed records (where 'scrub pushed records' is a schedule event name)

delete

Remove the ScheduleEvent designated by name. ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no ScheduleEvent is found with the provided name. DataValidationException (HTTP 409) if an attempt to delete a schedule event still being referenced by device reports.

get

Return ScheduleEvents matching given name (schedule names should be unique). May be null if no schedule events matches on the name provided. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no ScheduleEvent is found with the provided name.

ScheduleEvent Resource (by id)

get

Fetch a specific ScheduleEvent by database generated id. May return null if no schedule event with the id is found. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no ScheduleEvent is found with the provided id.

ScheduleEvent Resource

post

Add a new ScheduleEvent - name must be unique. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if the event's associated schedule is not found (referenced by name). DataValidationException (HTTP 409) if the schedule was not provided.

put

Update the ScheduleEvent identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. DataValidationException (HTTP 409) if an attempt to change the name is made when the schedule event is still being referenced by device reports. NotFoundException (HTTP 404) if no schedule is found for the identifier provided.

get

Return all schedule events sorted by id. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Schedule Resource

delete

Remove the Schedule designated by database generated id. ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Schedule is found with the provided id.

Schedule Resource (by id)

get

Fetch a specific Schedule by database generated id. May return null if no schedule with the id is found. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Schedule is found with the provided id.

Schedule Resource (by name)

Example - http://localhost:48081/api/v1/schedule/name/hourly (where hourly is the name of a schedule)

delete

Remove the Schedule designated by name. ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Schedule is found with the provided name.

get

Return Schedule matching given name (schedule names should be unique). May be null if no schedule matches on the name provided. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Schedule is found with the provided name.

Schedule Resource

post

Add a new Schedule - name must be unique. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. DataValidationException (HTTP 409) if the cron expression string is not properly formatted.

put

Update a Schedule identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. DataValidationException (HTTP // 409) if any the time or frequency strings are not properly formatted. NotFoundException (HTTP 404) if no schedule is found for the id.

get

Return all schedules sorted by id. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

ProvisionWatcher Resource (by id)

delete

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

ProvisionWatcher Resource (by id)

get

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

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

Remove the ProvisionWatcher designated by unique name identifier. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no provision watcher with the provided name is found.

ProvisionWatcher Resource (by profile)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceProfile match on the id provided.

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

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

ProvisionWatcher Resource (by service)

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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if no DeviceService match on the id provided.

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

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

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

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 ServiceException (HTTP 503) for unknown or unanticipated issues.

ProvisionWatcher Resource

post

Add a new ProvisionWatcher - name must be unique. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Addressable Resource (by id)

delete

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

Addressable Resource (by id)

get

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

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

Remove the Addressable designated by unique name identifier. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns NotFoundException (HTTP 404) if not found by name.

Addressable Resource (by topic)

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

get

Return Addressable objects with given topic. List may be empty if none are associated to the topic. Returns ServiceException (HTTP 503) 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

Return Addressable objects with given port. List may be empty if none are associated to the port. Returns ServiceException (HTTP 503) 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

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

Addressable Resource (by address)

get

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

Addressable Resource

post

Add a new Addressable - name must be unique. Returns ServiceException (HTTP 503) 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 ServiceException (HTTP 503) 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 ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Command Resource (by id)

delete

Remove the Command designated by database generated id. ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Command is found with the provided id. DataValidationException (HTTP 409) if the Command is still associated to a Device Profile.

Command Resource (by id)

get

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

Command Resource

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

get

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

Command Resource

post

Add a new Command. Returns ServiceException (HTTP 503) for unknown or unanticipated issues.

put

Update the Command identified by the database generated id in the object provided. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Command is found with the provided id. DataValidationException (HTTP 409) if the name is updated and it is not unique for the Device Profile.

get

Return all command objects. Returns ServiceException (HTTP 503) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.