DeviceNotification

Represents a device notification, a unit of information dispatched from devices.

Methods

MethodAuthorizationUriDescription
queryAccess JSON Web Token (GetDeviceNotification)GET /device/{deviceId}/notificationQueries device notifications.
getAccess JSON Web Token (GetDeviceNotification)GET /device/{deviceId}/notification/{id}Gets information about device notification.
insertAccess JSON Web Token (CreateDeviceNotification)POST /device/{deviceId}/notificationCreates new device notification.
pollAccess JSON Web Token (GetDeviceNotification)GET /device/{deviceId}/notification/pollPolls new device notifications.
This method returns all device notifications that were created after specified timestamp.
In the case when no notifications were found, the method blocks until new notification is received. If no notifications are received within the waitTimeout period, the server returns an empty response. In this case, to continue polling, the client should repeat the call with the same timestamp value.
pollManyAccess JSON Web Token (GetDeviceNotification)GET /device/notification/pollPolls new device notifications.
This method returns all device notifications that were created after specified timestamp.
In the case when no notifications were found, the method blocks until new notification is received. If no notifications are received within the waitTimeout period, the server returns an empty response. In this case, to continue polling, the client should repeat the call with the same timestamp value.

Resource Representation

{
    "id": {integer},
    "notification": {string},
    "deviceId": {string},
    "networkId": {integer},
    "deviceTypeId": {integer},
    "timestamp": {datetime},
    "parameters": {object}
}
Property NameTypeDescription
idintegerNotification identifier.
notificationstringNotification name.
deviceIdstringDevice unique identifier.
networkIdintegerNetwork unique identifier.
deviceTypeIdintegerDevice type unique identifier.
timestampdatetimeNotification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
parametersobjectNotification parameters, a JSON object with an arbitrary structure.