V2.5 Search Device by Device Group¶

Search devices by device groups.

Request Format¶

POST https://{apigw-address}/connect-service/v2.5/deviceGroups?action=searchDeviceByDeviceGroup

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get orgId>>

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
groupId	Mandatory	String	Device group ID
expression	Optional	String	For more details, see How to use expression>>
pagination	Optional	Pagination Request Struct	For more details, see Pagination Request Struct

Response Parameters¶

Name	Data Type	Description
code	Number	Failed or succeeded to create an alert. 0: succeeded, -1: failed.
msg	String	Returns `OK` if successful. Other returned values indicate failure.
requestId	String	A unique ID to identify a request.
data	Device Struct	See Device Struct.
pagination	Pagination Request Struct	See Pagination Request Struct>>

Device Struct¶

Name	Data Type	Description
orgId	String	The organization ID which the asset belongs to.
assetId	String	The asset ID.
modelId	String	The model ID which the asset belongs to.
modelIdPath	String	The model ID path.
productKey	String	The product key.
productName	StringI18n	The product name.
productType	String	The product type.
dataFormat	String	“Custom” represents the user-defined data type. “Json” represents the JSON data type.
deviceKey	String	The device key.
deviceName	StringI18n	The device name.
deviceSecret	String	The device secret, returned only when the value of `requireSecret` is `true`. The returned value will be encrypted. How to Decrypt >>
sessionKey	String	The key for encrypting and decrypting the value of `deviceSecret`, returned only when the value of `requireSecret` is `true`. The returned value will be encrypted. How to Decrypt >>
deviceDesc	String	The device description.
timezone	String	Timezone of the device’s location.
deviceAttributes	Map	The device attributes. The Key is the attribute ID, and the Value type depends on the attribute defined in the `ThingModel`.
deviceTags	Map	The device tags. (The Key and Value are of String type.)
mirrorSource	String	The device key of the mirror source.
createTime	Long	The time when the device was created.
status	String	The device status (online, offline, inactive, disable, or mirror) Note: EnOS Edge only supports online or offline.
activeTime	Long	The time when the device was activated.
lastOnlineTime	Long	The last online time of the device.
lastOfflineTime	Long	The last offline time of the device.
measurepointLastUpdate	Long	The last time when a measurement point was updated.
eventLastUpdate	Long	The last time when an event was updated.
attributeLastUpdate	Long	The last time when an attribute was updated.
featureLastUpdate	Long	The last time when a measurement point, an event, or an attribute was updated.
firmwareVersion	String	The firmware version.

Samples¶

Request Sample¶

url: https://{apigw-address}/connect-service/v2.5/deviceGroups?action=searchDeviceByDeviceGroup&orgId=yourOrgId&groupId=yourGroupId
method: POST

Return Sample¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "4b64be78-72c6-4eee-8cc5-227f0d0d2a5a",
    "data": [{
        "orgId": "yourOrgId",
        "assetId": "assetId",
        "modelId": "modelId",
        "modelIdPath": "modelIdPath",
        "productKey": "productKey",
        "productName": {
            "defaultValue": "ProductName",
            "i18nValue": {
                "en_US": "name",
                "zh_CN": "名称"
            }
        },
        "productType": "Device",
        "dataFormat": "Custom",
        "deviceKey": "deviceKey",
        "deviceName": {
            "defaultValue": "deviceName_test",
            "i18nValue": {
                "en_US": "name",
                "zh_CN": "名称"
            }
        },
        "deviceSecret": null,
        "sessionKey": null,
        "deviceDesc": "Device description",
        "timezone": "+08:00",
        "deviceAttributes": {
            "attribute1": "value1",
            "attribute2": "value2"
        },
        "deviceTags": {
            "tag1": "tagValue1",
            "tag2": "tagValue2"
        },
        "mirrorSource": null,
        "firmwareVersion": null,
        "createTime": 1718950104553,
        "status": "inactive",
        "statusSource": null,
        "activeTime": 0,
        "lastOnlineTime": 0,
        "lastOfflineTime": 0,
        "treeIds": [],
        "measurepointLastUpdate": null,
        "eventLastUpdate": null,
        "attributeLastUpdate": null,
        "featureLastUpdate": null
    }],
    "pagination": {
        "sortedBy": null,
        "pageNo": 1,
        "pageSize": 100,
        "totalSize": 1
    }
}