Get Structure by App¶

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

请求格式¶

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

请求参数（Header）¶

名称必需/可选数据类型描述

locale

可选

String

语言代码。不填默认为英语。

英语为 en_US

中文为 zh_CN

西班牙语为 es_ES

日语为 ja_JP

authorization 可选 String 用户 access token。如不为空，则返回登录用户在应用下的可见组织结构。

请求参数（URI）¶

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

响应参数¶

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

StructureDTO 结构体¶

名称	数据类型	描述
id	String	组织结构 ID。
parentId	String	组织结构父节点 ID。
name	String	组织结构名称。
description	String	组织结构描述。
displayOrder	Integer	排列序号。
tags	Object	标签。

错误码¶

代码	描述
31520	组织未购买应用。

示例¶

请求示例¶

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

method: GET

返回示例¶

{
    "code": 0,
    "data": [
        {
            "name": "your_structure_name",
            "displayOrder": 0,
            "description": "",
            "id": "your_structure_id",
            "parentId": "",
            "tags": {
                "key1": "value1"
            }
        }
    ],
    "message": "OK"
}