Get Structure by Detail¶

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

请求格式¶

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

authorization

可选

String

用户 access token。如不为空，则返回登录用户有查看权限的资产及其上级节点。

needAssociatedAsset

可选

Boolean

返回组织结构节点关联的资源信息。true 为返回，false 为不返回。

请求参数（URI）¶

名称	必需/可选	数据类型	描述
structureRootId	必需	String	组织结构 ID。
appId	必需	String	应用 ID。
orgId	必需	String	组织 ID。

响应参数¶

名称	数据类型	描述
data	StructureDTO 结构体	组织结构信息。

StructureDTO 结构体¶

名称	数据类型	描述
id	String	组织结构 ID。
parentId	String	组织结构父节点 ID。
name	String	组织结构名称。
description	String	组织结构描述。
displayOrder	Integer	排列序号。
tags	Object	标签。
assets	AssetDTO 结构体	资产信息。
children	Data 结构体	组织结构子节点。
associatedResources	Data 结构体	节点关联的资源信息。

AssetDTO 结构体¶

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

错误码¶

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

示例¶

请求示例¶

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

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