Update Organization Structure¶
修改组织结构节点。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.3/structure/update
请求参数(Query)¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| orgId | 必需 | String | 组织 ID。 | 
请求参数(Body)¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| structureRootId | 必需 | String | 目标组织节点的根节点。 | 
| structures | 必需 | StructureUpdateDTO 结构体 | 目标组织结构的节点列表。 | 
StructureUpdateDTO 结构体¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| structureId | 必需 | String | 组织结构 ID。 | 
| name | 可选 | I18nString | 修改后的组织结构节点名称。名称规则参见 `国际化名称结构体 /docs/api/zh_CN/2.4.0/api_faqs.html#id3>`__。 | 
| tags | 可选 | tagDTO 结构体 | 组织结构节点标签。 | 
| isTagIncrementalUpdate | 可选 | Boolean | 是否增量更新 tag。仅在指定 tags 参数时填写。true:默认值,新增 tags 参数中的键值对标签;false:仅保留 tags 参数中的键值对标签。 | 
tagDTO 结构体¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| key | 必需 | String | tag 的键。 | 
| value | 必需 | string | tag 的值。 | 
响应参数¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| data | boolean | 返回 true:修改成功;返回 false:修改失败。 | 
错误码¶
| 代码 | 描述 | 
|---|---|
| 31400 | 组织结构、节点或标签名称不合法,待修改节点不属于当前组织结构,标签的键已存在等。 | 
| 31403 | 应用无权访问该组织结构。 | 
| 31404 | OU 不存在。 | 
| 31408 | 组织结构节点名称已经存在。 | 
| 31430 | 组织结构节点名称不合法。 | 
| 31432 | 节点 tag 数量超过限制。 | 
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.3/structure/update
method: POST
requestBody:
{
    "structureRootId": "your_structure_root_node_ID",
    "structures": [
        {
            "structureId": "your_structure_id",
            "name": {
                "defaultValue": "Turbine1",
                "i18nValue": {"zh_CN": "风机", "en_US": "Turbine"}
            },
            "isTagIncrementalUpdate": false,
            "tags": [
                {
                    "key": "k111",
                    "value": "v111"
                },
                {
                    "key": "k222",
                    "value": "v222"
                }
            ]
        },
        {
            "structureId": "your_structure_id",
            "name": {
                "defaultValue": "Turbine2"
            }
        }
    ]
}
返回示例¶
{
  "code": 0,
  "data": true,
  "message": "OK"
}