Get Device List
API Basic Information
API Description: None
Request method: get
API Request path: /api/v1/cits/devices
API Request parameters
Path request parameters
None
Query parameters
| parameter name | type | required | remark |
|---|---|---|---|
| iotIdList | string | Optional | List of device iotIds to query. |
| gatewayIotId | string | Optional | Fill in when querying the list of sub devices under the specified edge gateway |
| productId | string | Optional | Corresponding product id of the device. |
| productIdList | array | Optional | List of product IDs |
| type | string | Optional | Device type. Optional values: UNSPECIFIED - Unknown state. ACCESS - Access device. INTERCOM - Intercom device. INDOOR - Indoor unit. |
| typeList | array | Optional | Device type list (same options as type) |
| macList | string | Optional | List of device mac addresses to query. |
| onlineStatus | string | Optional | Online status: UNSPECIFIED/ONLINE/OFFLINE |
| page | integer | Optional | The current page number to return (starting from 0). If not specified, the default is 0. |
| size | integer | Optional | Number of items displayed per page,default is 50 if not specified. The backend restricts the maximum number of records per page to not exceed 50, any value above 50 will be treated as 50. |
Request body
None
Response
| parameter name | type | required | remark |
|---|---|---|---|
| currentPage | integer | Optional | The current page number, starting from 0. |
| totalElements | integer | Optional | The total number of records. |
| totalPages | integer | Optional | The total number of pages. |
| elements[] | DeviceDto | Optional | List of devices on the current page. |
Related data models
Device
nexhome.iotdomain.cits.v1.devices.DeviceDto
| parameter name | type | required | remark |
|---|---|---|---|
| id | integer | Optional | Device ID. |
| iotId | string | Optional | Device IOT ID. |
| productId | string | Optional | Corresponding product ID of the device. |
| name | string | Optional | Device name. |
| position | string | Optional | Device location. |
| type | string | Optional | Device type. Options: UNSPECIFIED - Unknown. ACCESS - Access device. INTERCOM - Intercom device. INDOOR - Indoor unit. GATEWAY - Edge gateway. IPC - Camera. CENTER - Master station. ROBOT - Robot. SIGNAGE - Door signage |
| brand | string | Optional | Device brand |
| remark | string | Optional | Device remark |
| mac | string | Optional | Device mac |
| ip | string | Optional | Device IP |
| mask | string | Optional | Subnet mask |
| gateway | string | Optional | Gateway |
| dns | string | Optional | DNS |
| softVersion | string | Optional | Software version |
| softVersionCode | integer | Optional | Software version code |
| hardVersion | string | Optional | Hardware version |
| onlineStatus | string | Optional | Online status, UNSPECIFIED (unknown)/ONLINE (online)/OFFLINE (offline) Optional values: UNSPECIFIED - Unknown state. ONLINE - Online. OFFLINE - Offline. |
| lastOnlineTime | integer | Optional | Last online timestamp (milliseconds) |
| sn | string | Optional | Device sn |
| sipNumber | string | Optional | Device SIP number (returned for intercom devices) |
| model | string | Optional | Model |
| cover | string | Optional | Device cover file key (currently only for IPC devices). Call /api/v1/cits/devices/{iot_id}/files:generateOssUrl to obtain URL |
| gatewayIotId | string | Optional | Parent device IoT ID (returned when querying sub-devices) |
| spaceId | string | Optional | Space ID (returned when querying sub-devices from edge) |
| spaceName | string | Optional | Space full name (returned when querying sub-devices from edge) |
| spaceLayer | integer | Optional | Space layer (returned when querying sub-devices from edge) |
| developerId | string | Optional | Devloper ID |
| developerAppId | string | Optional | APP-ID |
| createdTime | integer | Optional | Create time |
| lastModificationTime | integer | Optional | Update Time |
| relayList | RelayDetail | Optional | Relay list |
| platform | string | Optional | Device platform Options: UNSPECIFIED - Unknown. NEXHOME - NEXHOME. HTW - HTW |