Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart IndustryIndustrial Environment AnalyticsEnvironmental monitoring object managementAdd Monitored Object

Add Monitored Object

Last Updated on : 2023-06-21 07:13:11download

Add a monitored object, including the name, code, and picture.

API address

POST: /v1.0/iot-03/si/monitor-object

Request parameter

Description of body

Parameter name	Type	Required	Description
monitor_object_type	String	true	The type of a specified monitored object.
monitor_object_name	String	true	The name of a specified monitored object.
remark	String	false	The remarks.
device_list	List	false	A list of linked devices.
picture_list	List	false	The list of pictures of monitored objects.

Description of picture_list

Parameter name	Type	Required	Description
attachment_name	String	false	The file name.
attachment_value	String	false	The `cloud_key` of a specified file.
thumbnail_attachment_value	String	false	The `cloud_key` of a specified file thumbnail.

Return parameter

Parameter name	Type	Description
result	Boolean	Indicates whether the operation is successful.

Request example

POST: /v1.0/iot-03/si/monitor-object

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

Return example

{
    "result": true,
    "t": 1632730415965,
    "success": true
}

Error code

For more information, see error code.

Prev DocDelete Monitored Object

Next DocModify Monitored Object