Update Organization Structure¶

Update organization structure nodes.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.3/structure/update

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	OU ID. How to get orgId >>

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
structureRootId	Required	String	The root node of the organization structure.
structures	Required	StructureUpdateDTO Struct	The node list to be updated. StructureUpdateDTO Struct >>

StructureUpdateDTO Struct ¶

Name	Required/Optional	Data Type	Description
structureId	Required	String	Organization structure ID.
name	Optional	I18nString	The updated node name in multiple languages. Internationalized name struct >>
tags	Optional	TagDTO Struct	Organization structure node tags. TagDTO Struct >>
isTagIncrementalUpdate	Optional	Boolean	Whether to incrementally update tags. This is only set when the `tags` parameter is specified. The following values are supported: `true`: Indicates that the tags in the `tags` parameter need to be added, while retaining the existing tags. `false`: Only the tags in the `tags` parameter are retained, and the existing tags are not retained. Default is `true`.

tagDTO Struct ¶

Name	Required/Optional	Data Type	Description
key	Required	String	Tag key.
value	Required	string	Tag value.

Response Parameters¶

Name	Data Type	Description
data	boolean	Whether the organization structure is updated successfully. `true` indicates that the update is successful. `false` indicates that the update fails.

Error Codes¶

Error Code	Description
31400	Invalid organization structure, nodes or tag name, non-existed node in the current organization structure, duplicated tag keys, etc.
31403	The application does not have the access to the organization structure.
31404	OU does not exist.
31408	The organization structure node name already exists.
31430	Invalid name of organization structure node.
31432	The number of node tags exceeds the limit.

Samples¶

Request Sample¶

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"
            }
        }
    ]
}

Return Sample¶

{
  "code": 0,
  "data": true,
  "message": "OK"
}