Get Application Information¶

获取应用信息。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>
appId	Query	必需	String	应用的 Access Key。如何获取 Access Key >>

响应参数¶

名称	数据类型	描述
id	String	应用 ID。
code	String	应用代码。
nameJson	Object	应用的国际化名称。国际化名称结构体 >>
displayName	String	应用的展示名称。
descriptionJson	Object	应用的国际化描述。
createdType	Number	应用类型。 `0` 表示从其它 OU 获取的应用。 `1` 表示 OU 内自建应用。 `2` 表示应用快捷方式。
order	number	应用排列顺序。
category	Object	应用分类。
isEnable	Boolean	应用是否启用。`true` 表示启用，`false` 表示禁用。
isDisplay	Boolean	应用是否显示在导航栏中。`true` 表示显示，`false` 表示未显示。
tags	Tags 列表	应用标签列表。Tags 列表 >>
menus	AppResourceDTO 结构体	应用菜单列表。AppResourceDTO 结构体 >>
permissions	AppResourceDTO 结构体	应用权限列表。AppResourceDTO 结构体 >>

Tags 列表¶

名称	数据类型	描述
key	String	标签的键。
value	String	标签的值。

AppResourceDTO 结构体¶

名称	数据类型	描述
id	String	菜单或权限点 ID。
code	String	菜单或权限点的代码。
nameJson	Object	菜单或权限点的国际化名称。
descriptionJson	Object	菜单或权限点的国际化描述。
url	String	菜单 URL。
displayOrder	Integer	当前菜单在其所在层级内的排序，值为从 1 开始的整数，序号越小的菜单越排在上方。
parentId	String	上级菜单 ID。
children	AppResourceDTO 结构体	下级菜单的详细信息。

错误码¶

代码	描述
31400	必要参数为空。
31404	应用不存在或 OU 未获取此应用。

示例¶

请求示例¶

url: /app-portal-service/v2.3/app/get?orgId=your_org_id&appId=your_access_key

method: GET

返回示例¶

{
    "code": 0,
    "data": {
        "permissions": [
            {
                "code": "Write",
                "nameJson": {
                    "default": "Write",
                    "en_US": "WriteUS",
                    "zh_CN": "WriteCN",
                    "es_ES": "WriteES",
                    "ja_JP": "WriteJP"
                },
                "displayOrder": 0,
                "name": "your_menu_name",
                "id": "your_menu_id",
                "url": "",
                "parentId": ""
            },
            {
                "code": "Read",
                "nameJson": {
                    "default": "Read",
                    "en_US": "ReadUS",
                    "zh_CN": "ReadCN",
                    "es_ES": "ReadES",
                    "ja_JP": "ReadJP"
                },
                "displayOrder": 0,
                "name": "your_menu_name",
                "id": "your_menu_id",
                "url": "",
                "parentId": ""
            }
        ],
        "menus": [
            {
                "code": "menu2",
                "nameJson": {
                    "default": "menu2",
                    "en_US": "menu2US",
                    "zh_CN": "menu2CN",
                    "es_ES": "menu2ES",
                    "ja_JP": "menu2JP"
                },
                "children": [
                    {
                        "code": "menu2_1",
                        "nameJson": {
                            "default": "menu2-1",
                            "en_US": "menu2-1US",
                            "es_ES": "menu2-1ES",
                            "ja_JP": "menu2-1JP"
                        },
                        "children": [

                        ],
                        "displayOrder": 1,
                        "name": "your_menu_name",
                        "id": "your_menu_id",
                        "url": "your_menu_url",
                        "parentId": "your_parent_menu_id"
                    }
                ],
                "displayOrder": 1,
                "name": "your_menu_name",
                "id": "your_menu_id",
                "url": "",
                "parentId": ""
            },
        ]
    },
    "message": "OK"
}