V2.5 Update Device Group


Update device groups.

Request Format

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

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

name

Optional

StringI18n

The device group name. For more details on the structure and locales supported, see Internationalized name struct.

desc

Optional

String

Description.

Response Parameters

Name

Data Type

Description

code

Number

Return code of a request.

msg

String

The explanation to the return code. Its value is OK if the request is

requestId

String

A unique ID to identify a request.

data

String

Updated device group information.

Samples

Request Sample

url: https://{apigw-address}/connect-service/v2.5/deviceGroups?action=updateGroup&orgId=yourOrgId&groupId=yourGroupId
method: POST
requestBody:
{
    "name": {
        "defaultValue": "groupName",
        "i18nValue": {
            "en_US": "name",
            "zh_CN": "中文名",
            "es_ES": "nombre",
            "ja_JP": "名前"
        }
    },
    "desc": "groupDescription"
}

Return Sample

{
    "code": 0,
    "msg": "OK",
    "requestId": "fbb06269-b8fc-4674-aca7-2f5503e61259",
    "data": "yourGroupId"
}