Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSaaS Basic Service of Commercial LightingCommercial Device ManagementGet Device List

Get Device List

Last Updated on : 2023-06-21 07:13:02

Get a list of devices.

API address

GET: /v1.0/illumination/devices

Request parameter

Parameter name	Type	IN	Required	Description
projectId	String	uri	false	The project ID.
roomId	String	uri	true	The room ID.
roomType	Integer	uri	true	The room type.
page	Integer	uri	false	The current page number.
pageSize	Integer	uri	false	The number of items to be returned per page.
deviceStatus	List《String》	uri	true	The device status.

Return parameter

Parameter name	Type	Description
total	int	The total number of returned items.
list	DeviceBasicVO[]	The list of devices.

Request example

GET: /v1.0/illumination/devices

{
  "pageSize": "10",
  "page": "1",
  "projectId": "1323671234234",
  "roomId": "152372223482",
}

Return example

{
    "tid": "f2919c24fbac11ed876d16e5066b4061",
    "result": {
        "list": [
            {
                "switchInfo": [
                ],
                "masterGroupJoinStatus": 2,
                "deviceStatuses": [
                    "normal"
                ],
                "industryPurpose": {
                },
                "installTime": 1681962468804,
                "switchStatus": false,
                "ownerId": "59457509",
                "deviceId": "6c4794741ec4f88c993***",
                "deviceName": "Gateway",
                "uuid": "a651b293c892b***",
                "roomId": "1559640253681***",
                "deviceStatus": "normal",
                "capability": "zigbee/wifi",
                "pointId": "",
                "devicePurpose": {
                },
                "deviceMac": "",
                "currentBrightness": 0,
                "model": "",
                "id": 2114488,
                "deviceType": "gateway",
                "deviceTypeValue": 1,
                "productId": "wpr7snzwzxbsy***",
                "deviceSaasId": "sa43837415438329***",
                "categoryCode": "wf_zig_wg2",
                "roomName": "Test",
                "topCategory": "wgzk",
                "online": true,
                "devicePower": 0,
                "category": "wg2",
                "projectId": "1541976932755718***",
                "properties": [
                    {
                        "dpName": "Mute Alert",
                        "dpId": 4,
                        "mode": "rw",
                        "dpValueStd": "false",
                        "propertyDetail": {
                            "type": "bool"
                        },
                        "dpCode": "switch_alarm_sound",
                        "property": {
                            "range": [
                            ]
                        }
                    }
                ]
            }
        ],
        "total": 1
    },
    "t": 1685095574507,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify Device Name

Next DocCommercial Device Control