Get Details of Monitored Object

Last Updated on : 2022-04-02 08:21:55download

Get the details of a specified monitored object based on the ID of the monitored object. The details include the name of the monitored object and a list of linked devices.

API address

GET: /v1.0/iot-03/si/monitor-object/{monitor_object_id}

Request parameter

Parameter nameTypeINRequiredDescription
monitor_object_idStringuritrueThe ID of a specified monitored object.

Return parameter

Parameter nameTypeDescription
resultMonitorObjectTotalDTOThe returned result.

Description of result

Parameter nameTypeDescription
monitor_object_idStringThe ID of a specified monitored object.
monitor_object_typeStringThe type of a specified monitored object.
monitor_object_nameStringThe name of a specified monitored object.
remarkStringThe remarks.
device_listListA list of linked devices.
picture_listListThe list of pictures of monitored objects.

Description of picture_list

Parameter nameTypeDescription
attachment_nameStringThe file name.
attachment_valueStringThe cloud_key of a specified file.
thumbnail_attachment_valueStringThe cloud_key of a specified file thumbnail.

Request example

GET: /v1.0/iot-03/si/monitor-object/197***

Return example

{
    "result": {
        "monitorObjectId": "197***",
        "remark": "Remarks of vibration monitoring test",
        "monitorObjectType": "energy_collect",
        "monitorObjectName": "Vibration Monitoring Test",
        "deviceList": [
            "vdevo***"
        ],
        "pictureList": [
            {
                "thumbnailAttachmentValue": "is-product/other/20211126/20211126**.JPG",
                "attachmentValue": "is-product/other/20211126/20211126**.JPG",
                "attachmentName": "****.JPG"
            }
        ]
    }
}

Error code

For more information, see error code.