Help Center > > API Reference> Northbound Java SDK API Reference> Service API List> Message Push> Pushing Firmware Upgrade Result Notifications

Pushing Firmware Upgrade Result Notifications

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

After an NA subscribes to firmware upgrade result change notifications (the notification type is fwUpgradeResultNotify) on the IoT platform, the IoT platform sends a notification message to the NA when a firmware upgrade task is complete.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to firmware upgrade result notifications.

Note

1. When subscribing to platform management data, an NA must subscribe to the specified callback address in the API description. The server and port in the callback address are the public IP address and specified port of the NA.

2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.

3. If the callback address is not the address of the NA, the NA must implement the original callback API. For details on the API content, see Message Push in the Huawei IoT Platform Northbound API Reference.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

void handleFwUpgradeResult(NotifyFwUpgradeResultDTO body)

Class

PushMessageReceiver

Parameter Description

NotifyFwUpgradeResultDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is fwUpgradeResultNotify.

deviceId

Mandatory

String

body

Identifies a device.

appId

Mandatory

String

body

Identifies the application to which the device belongs.

operationId

Mandatory

String

body

Identifies a firmware upgrade task.

subOperationId

Mandatory

String

body

Identifies a firmware upgrade sub-task.

curVersion

Mandatory

String

body

Indicates the current firmware version of the device.

targetVersion

Mandatory

String

body

Indicates the target firmware version to which the device is to be upgraded.

sourceVersion

Mandatory

String

body

Indicates the source firmware version of the device.

status

Mandatory

String

body

Indicates the upgrade result.

  • SUCCESS
  • FAIL

statusDesc

Mandatory

String

body

Indicates the upgrade result description.

  • SUCCESS: The device upgrade is successful.
  • FAIL: The device upgrade fails.

upgradeTime

Mandatory

String

body

Indicates the firmware upgrade duration.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"fwUpgradeResultNotify",
    "deviceId":"******",
    "appId":"***********",
    "operationId":"***********",
    "subOperationId":"***********",
    "curVersion":"1.6",
    "targetVersion":"1.6",
    "sourceVersion":"1.3",
    "status":"SUCCESS",
    "statusDesc":"****",
    "upgradeTime":"****"
}

Response Example

Response:
Status Code: 200 OK

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel