This URL provides all health details of the Sensor.
Resource URL
GET /devicehealth/getAllDeviceHealth
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned.
Field Name | Description | Data Type |
|---|---|---|
| Sensor Id | Number |
| Hardware health of Sensor | Boolean |
| Hardware health state of Sensor | Number |
| Capacity health of Sensor | Boolean |
| Inspection health of Sensor | Boolean |
| Inspection health state of Sensor | Number |
| If Sensor connected | Boolean |
| Name of Sensor | String |
| Health summary of Sensor | String |
| If Sensor normal | Boolean |
| Health state of Sensor | Number |
Example
Request
GET https://%3CNSM_IP%3E/sdkapi/devicehealth/getAllDeviceHealth
Response
{
"sensorId": 1005,
"hardwareHealthNormal": true,
"hardwareHealthState": 1,
"capacityHealthNormal": false,
"capacityHealthState": 3,
"inspectionHealthNormal": true,
"inspectionHealthState": 1,
"connected": false,
"sensorName": "NS9100_2_18",
"summaryHealth": [
{
"name": null,
"state": 3,
"supported": true
},
{
"name": null,
"state": 1,
"supported": false
},
{
"name": null,
"state": 1,
"supported": true
}
],
"normal": false,
"healthState": 3
}