Query Details of Industrial Device

Last Updated on : 2023-06-15 06:00:46

Query the details of a specified industrial device by the device code.

API address

GET: /v1.1/iot-03/si/devices/{device_code}

Request parameter

Parameter name	Type	IN	Required	Description
device_code	String	uri	true	The code of a specified device.

Return parameter

Parameter name	Type	Description
result	IotDeviceDetailDTO	The returned result.

Description of result

Parameter name	Type	Description
sampling_rate	String	The sampling frequency.
sampling_time	Long	The sampling time.
real_time_address	String	The real-time location.
real_time_longitude	String	The real-time longitude.
real_time_latitude	String	The real-time latitude.
device_properties	List	The special attributes of a specified device.
tuya_device_id	String	The ID of a Tuya device.
tuya_product_id	String	Tuya product ID.
gateway_id	String	The gateway ID.
device_code	String	The unique code of a specified device.
device_name	String	The device name.
device_type_code	String	The code of a specified device type.
device_model_code	String	The code of a specified device model.
customer_code	String	The code of a specified customer.
production_time	Long	The production time.
batch_number	String	The device batch number.
sale_time	Long	The sales time.
sale_address	String	The detailed sales address.
sale_longitude	String	The longitude of a specified sales address.
sale_latitude	String	The latitude of a specified sales address.
real_time_positioning	Boolean	Indicates whether the device can be located in real time.
is_gateway	Boolean	Specifies whether it is a gateway device.
is_online	Boolean	Indicates whether a device is online.
running_status	String	The operating status of a device.
failure	Boolean	Indicates whether a failure occurs.
creator	String	The creator.
modifier	String	The modifier.
gmt_create	Long	The time when it is created.
gmt_modified	Long	The time when it is updated.
is_unbind	Boolean	Indicates whether it is unbound.

Description of device_properties

Parameter name	Type	Description
name	String	The name of a specified attribute.
code	String	The code of a specified attribute.
value	String	The value of a specified attribute.

Request example

GET: /v1.1/iot-03/si/devices/cnc

Return example

{
    "result": {
        "gmt_create": 1637824772859,
        "is_unbind": false,
        "tuya_product_id": "hz9***",
        "batch_number": "",
        "modifier": "",
        "is_gateway": true,
        "gmt_modified": 1637892279303,
        "gateway_id": "6c73***",
        "device_name": "Edge Gateway-Positioning",
        "device_properties": [
        ],
        "sale_longitude": "12***",
        "sale_latitude": "2***",
        "is_online": true,
        "customer_code": "",
        "device_model_code": "elegw01",
        "creator": "bay***",
        "real_time_positioning": true,
        "production_time": 0,
        "sale_address": "Zhejiang Province***",
        "running_status": "",
        "tuya_device_id": "6c7***",
        "real_time_longitude": "12***",
        "device_type_code": "gw",
        "failure": false,
        "device_code": "cnc",
        "real_time_latitude": "3***",
        "real_time_address": "Zhejiang Province****",
        "sale_time": 0
    },
    "t": 1638199642413,
    "success": true
}

Error code

For more information, see error code.

Prev DocAdd Industrial Device

Next DocDelete Industrial Device