Get Structure by Detail¶

获取应用下挂载的完整组织结构节点。

请求格式¶

GET https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/detail

请求参数（Header）¶

名称

必需/可选

数据类型

描述

locale

可选

String

指定以何种语言返回列表信息，支持以下赋值：

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

默认返回英语 en_US 的列表信息。

authorization

可选

String

用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 Bearer {your token}。如不指定，则返回应用下挂载的全部组织结构节点。如指定，则返回该用户在应用内有查看权限的组织结构节点，该用户必须处于登录状态。可通过调用 Log In 或 Refresh Access Token 接口后获取。

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
structureRootId	Query	必需	String	组织结构根节点 ID。
appId	Query	必需	String	应用的 Access Key。如何获取 Access Key >>
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>
needAssociatedAsset	Query	可选	Boolean	是否返回组织结构节点关联的资源信息。支持以下赋值： `true`：返回。 `false`：不返回。默认为 `false`。

响应参数¶

名称	数据类型	描述
id	String	节点 ID。
parentId	String	父节点 ID。
name	String	组织结构名称。
description	String	组织结构描述。
displayOrder	Integer	排列序号，序号小的排在上方。
tags	Object	组织结构标签。
assets	AssetDTO 结构体	当前节点挂载的资产信息。AssetDTO 结构体 >>
children	Data 结构体	子节点信息。包括 `id`，`parentId`，`name`，`description`，`displayOrder`，`tags`，`assets` 和 `children`。
associatedResources	Data 结构体	节点关联的资源信息。包括 `id`，`parentId`，`name`，`description`，`displayOrder`，`tags`，`assets` 和 `children`。

AssetDTO 结构体¶

名称	数据类型	描述
assetId	String	资产 ID。
assetName	String	资产名称。
displayOrder	Integer	排列序号，序号小的资产排在上方。
assetNameJson	Object	资产名称，支持国际化。

错误码¶

代码	描述
31404	组织结构未分配给当前应用。
31520	OU 未获取应用。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.3/structure-service/structures/detail?structureRootId=yourRootNodeId&appId=yourAccessKey&orgId=yourOrgId

method: GET

返回示例¶

{
    "code": 0,
    "data": {
        "children": [
            {
                "assets": [
                    {
                        "assetId": "your_resource_id_1",
                        "assetNameJson": {
                            "default": "your_resource_name_1",
                            "zh_CN": "your_resource_name_zh_1"
                        },
                        "displayOrder": 0,
                        "assetName": "your_resource_name_1"
                    }
                ],
                "children": [
                    {
                        "assets": [
                            {
                                "assetId": "your_resource_id_2",
                                "assetNameJson": {
                                    "default": "your_resource_name_2"
                                },
                                "displayOrder": 0,
                                "assetName": "your_resource_name_2"
                            },
                            {
                                "assetId": "your_resource_id_3",
                                "assetNameJson": {
                                    "default": "your_resource_name_3"
                                },
                                "displayOrder": 0,
                                "assetName": "your_resource_name_3"
                            }
                        ],
                        "children": [],
                        "name": "your_node_name_1",
                        "displayOrder": 0,
                        "description": "",
                        "id": "your_node_id",
                        "parentId": "your_parent_node_id",
                        "tags": {}
                    }
                ],
                "name": "your_node_name_2",
                "displayOrder": 0,
                "description": "",
                "id": "your_node_id_2",
                "parentId": "your_parent_node_id",
                "tags": {}
            }
        ],
        "name": "your_node_name_3",
        "displayOrder": 0,
        "description": "",
        "id": "your_node_id_3",
        "parentId": "",
        "tags": {
            "key1": "value1"
        }
    },
    "message": "OK"
}