notification/insert

Creates new device notification on behalf of device.

Authorization

Access JSON Web Token (CreateDeviceNotification)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "deviceId": {string},
    "notification": {
        "notification": {string},
        "timestamp": {datatime},
        "parameters": {object}
    }
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: notification/insert
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
deviceIdYesstringDevice unique identifier.
notificationYesobjectA DeviceNotification resource to create.
notification.notificationYesstringNotification name.
notification.timestampNodatetimeNotification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
notification.parametersNoobjectNotification parameters, a JSON object with an arbitrary structure.

Response Topic and Payload

Topic

dh/response/notification/insert@{clientId}

Payload Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "notification": {
        "id": {integer},
        "timestamp": {datetime}
    }
}

Payload Parameters

Property NameTypeDescription
actionstringAction name: notification/insert
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
notificationobjectAn inserted DeviceNotification resource.
notification.idintegerNotification identifier.
notification.timestampdatetimeNotification UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601)).