DeviceManagementApi
API controller for managing devices.
| API | Description |
|---|---|
| GET api/manage/devices/{iotDeviceGuid} |
Get IoTDevice by it's GUID. |
| GET api/manage/devices?deviceId={deviceId} |
Get IoTDevice by DeviceId. |
| GET api/manage/devices?assetId={assetId} |
Get IoTDevice by AssetId. |
| GET api/manage/devices?assetGuid={assetGuid} |
Get IoTDevice by AssetGuid. |
| GET api/manage/devices?reportToAssetId={reportToAssetId} |
Get IoTDevices by ReportToAssetId. |
| GET api/manage/devices?reportToAssetGuid={reportToAssetGuid} |
Get IoTDevices by ReportToAssetGuid. |
| POST api/manage/devices |
Create a new IoTDevice. |
| PUT api/manage/devices/{iotDeviceGuid} |
Full update of an IoTDevice. |
| PATCH api/manage/devices?assetGuid={assetGuid} |
Update the DeviceId of an IoTDevice by specifying it's AssetGuid. |
| DELETE api/manage/devices/{iotDeviceGuid} |
Delete an IoTDevice by IoTDeviceGuid. |
| DELETE api/manage/devices?assetGuid={assetGuid} |
Delete an IoTDevice by AssetGuid. |
GatewayManagementApi
API controller for managing gateways.
| API | Description |
|---|---|
| GET api/manage/gateways |
Method for listing gateways. |
| GET api/manage/gateways/{id} |
Method for retrieving gateway for a specific id. |
| PUT api/manage/gateways/{id} |
Method for updating a gateway with a specific id. |
| POST api/manage/gateways |
Method for creating a new gateway. |
| DELETE api/manage/gateways/{id} |
Method for deleting gateway with a specific id. |
GatewaysApi
Api controller for handling gateway specific content.
| API | Description |
|---|---|
| GET api/monitor/gateways/{id} |
Get information about a gateway. For use by monitor applications. |
| GET api/gateways/{id}/endpoints?UseIPv6={UseIPv6} |
Gets the endpoints for a gateway. For use by gateways. |
| GET api/gateways/{gatewayId}/devices |
Get the devices connected to a specific gateway. For use by gateways. |
| GET api/monitor/gateways/{gatewayId}/devices |
Get the devices connected to a specific gateway. For use by monitor applications. |
| GET api/gateways/{gatewayId}/values?typeClass={typeClass}&resolution={resolution} |
Get the last collected values for the devices connected to a specific gateway. For use by gateways. |
| GET api/monitor/gateways/{gatewayId}/values?typeClass={typeClass}&resolution={resolution} |
Get the last collected values for the devices connected to a specific gateway. For use by monitoring applications. |
| GET api/monitor/meters/{meterId}/values?typeClass={typeClass}&resolution={resolution} |
Get the last collected values for a given meter where MeterId = MeterNumber (which might not be the meter's serial number). For use by monitoring applications. |
| GET api/gateways/{gatewayId}/devices/{deviceId}/values?typeClass={typeClass}&resolution={resolution} |
Get the last collected values for a specific device. For use by gateways. |
| GET api/monitor/gateways/{gatewayId}/devices/{deviceId}/values?typeClass={typeClass}&resolution={resolution} |
Get the last collected values for a specific device. For use by monitoring applications. |
| GET api/gateways/{gatewayId}/eventlogic |
Get the event logic for alarm kit devices connected to a specific gateway. For use by gateways. |
Nef
| API | Description |
|---|---|
| POST api/nef/meters/{meterId}/linkedgateway/{gatewaySerialNumber} |
No documentation available. |
| POST api/nef/meters/{meterId}/linkedgateway |
No documentation available. |