Get Sub-Devices Under Edge Gateway
API Basic Information
API Description: N/A
Request method: get
API Request path: /api/v1/cits/devices/{gatewayIotId}/subDevices
API Request parameters
Path request parameters
| parameter name | type | required | remark |
|---|---|---|---|
| gatewayIotId | string | Required | Edge gateway IoT ID |
Query parameters
| parameter name | type | required | remark |
|---|---|---|---|
| needRealtime | boolean | Optional | Whether to read in real time from the edge (fetch extra space/SIP info; returns offline error if the edge is offline). Default false, read from cloud cache |
| mac | string | Optional | Device MAC |
| customEncode | string | Optional | Device-side custom code |
| productId | string | Optional | Product ID |
| 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 |
| iotIdList | array | Optional | Sub-device IoT ID list |
| macList | array | Optional | Sub-device MAC list |
| spaceIdList | array | Optional | Space IDs mounted on the edge gateway (supported only when needRealtime is true) |
| includeParentSpace | boolean | Optional | Include parent spaces with spaceIdList, default false |
| includeSubSpace | boolean | Optional | Include sub spaces with spaceIdList, default false |
| permissionSpaceIdList | array | Optional | Space IDs authorized on the edge gateway (only when needRealtime is true) |
| typeList | array | Optional | Device type list (same options as type) |
| productIdList | array | Optional | Product ID list |
| onlineStatus | string | Optional | Online status: UNSPECIFIED/ONLINE/OFFLINE |
| isCloudEnabled | boolean | Optional | Whether device is cloud-enabled (only when needRealtime is true) |
| spaceLayerList | array | Optional | Space layer list on the edge (only when needRealtime is true) |
| unpaged | boolean | Optional | Whether to disable paging |
| page | integer | Optional | Current page (0-based) |
| size | integer | Optional | Page size (default 50) |
Request body
None
Response
| parameter name | type | required | remark |
|---|---|---|---|
| currentPage | integer | Optional | Current page number, 0-based |
| totalElements | integer | Optional | Total number of records |
| totalPages | integer | Optional | Total pages |
| elements[] | DeviceDto | Optional | Device list of 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 | Product ID |
| name | string | Optional | Device name |
| position | string | Optional | Device position |
| type | string | Optional | Device type (same options as above) |
| brand | string | Optional | Brand |
| remark | string | Optional | Remark |
| mac | string | Optional | MAC |
| ip | string | Optional | 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/ONLINE/OFFLINE |
| lastOnlineTime | integer | Optional | Last online timestamp (ms) |
| lastOfflineTime | integer | Optional | Last offline timestamp (ms) |
| sn | string | Optional | Device SN |
| sipNumber | string | Optional | SIP number (intercom devices) |
| model | string | Optional | Model |
| cover | string | Optional | Cover file key (currently for IPC devices; call /api/v1/cits/devices/{iot_id}/files:generateOssUrl for URL) |
| gatewayIotId | string | Optional | Parent device IoT ID (when querying sub-devices) |
| spaceId | string | Optional | Space ID (when querying from edge) |
| spaceName | string | Optional | Space full name (when querying from edge) |
| spaceLayer | integer | Optional | Space layer (when querying from edge) |
| developerId | string | Optional | Developer ID |
| developerAppId | string | Optional | Developer App ID |
| createdTime | integer | Optional | Create timestamp (ms) |
| lastModificationTime | integer | Optional | Update timestamp (ms) |
| relayList | RelayDetail | Optional | Relay list |
| platform | string | Optional | Platform Options: UNSPECIFIED - Unknown. NEXHOME - NEXHOME. HTW - HTW |
Device Relay List
nexhome.iotdomain.cits.v1.devices.RelayDetail
| parameter name | type | required | remark |
|---|---|---|---|
| code | integer | Optional | Relay code |
| name | string | Optional | Relay name |