Get Assets by Application¶

查询当前用户在某个应用下有权限的所有资源。

前提条件¶

用户已登录应用门户，并进入一个 OU。如有需要，可通过 Log In API 登录应用门户，通过 Choose Organization API 选择 OU。
OU 已获取当前应用，或该应用为 OU 内自建应用。
应用已拥有“获取本 OU 内所有用户的权限信息”的权限。如有需要，联系 OU 管理员获取权限。

请求格式¶

GET https://{apigw-address}/app-portal-service/v2.2/user/app/asset/tree

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
accessKey	Query	必需	String	应用的 `accessKey`，用于鉴权，以获得应用有权访问的数据。如何获取 accessKey 信息 >>
resourceTypes	Query	可选	String	指定资源类型作为过滤条件，支持输入最多 1000 种资源类型。

请求参数（Header）¶

名称

必需/可选

数据类型

描述

Authorization

必需

String

用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 Bearer {your token}。可通过调用 Log In 或 Refresh Access Token 接口后获取。

needAssociatedAsset

可选

Boolean

是否返回可见组织结构节点上挂载的资源信息。支持以下赋值：

true 为返回。
false 为不返回。

默认为 false。

响应参数¶

名称	数据类型	描述
id	String	资源 ID 或组织结构节点 ID。
name	String	资源的默认名称。
tag	String	资源标签。如果是资源，则返回 `asset`。如果是组织结构节点，则返回 `null`。由于资源只能挂载到组织结构的末端节点上，所以当此参数返回 `asset` 时，必有父节点，即必然返回 `parentId`，且父节点为组织结构节点。同时必然没有子节点，即不返回 `children`。
tags	List<StructureTagDTO>	组织结构节点的标签。
displayOrder	Integer	同一层级的组织结构节点排序序号，序号越小排在越上方。
nameJson	I18nString	资源的多语言名称。
parentId	String	父节点 ID。
data.type	String	资源类型标识符。仅当 `tag` 参数返回 `asset` 时返回。当 `tag` 参数返回 `null` 时，此值为 `null`。
data.typeName	I18nString	资源类型名称。仅当 `tag` 参数返回 `asset` 时返回。当 `tag` 参数返回 `null` 时，此值为 `null`。
children	Data 结构体	子节点。
associatedResources	Data 结构体	节点关联的资源信息。

StructureTagDTO 结构体¶

名称	数据类型	描述
id	Integer	组织结构标签序号。序号越小的标签越靠前。
key	String	组织结构标签键。
value	String	组织结构标签值。

错误码¶

代码	描述
31400	AccessKey 不能为空
31401	提供的 Access Token 无效
31403	没有此应用权限
31404	应用不存在或 OU 未获取此应用
31512	未选择 OU

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/app/asset/tree?accessKey=your_access_key&resourceTypes=type1,type2

method: GET

headers: {"Authorization":"Bearer your_access_token"}

返回示例¶

{
  "code": 0,
  "data": {
    "children": [
      {
        "children": [
          {
            "displayOrder": -1,
            "id": "your_asset_id",
            "name": "your_asset_name",
            "nameJson": {
              "default": "your_asset_name_default",
              "en_US": "your_asset_name_en",
              "zh_CN": "your_asset_name_zh",
              "es_ES": "your_asset_name_es",
              "ja_JP": "your_asset_name_jp"
            },
            "parentId": "",
            "tag": "asset",
            "type": "auth_unit",
            "typeName": {"default":"your_asset_type_default","en_US":"your_asset_type_en","zh_CN":"your_asset_type_zh"}}
          }
        ],
        "displayOrder": 0,
        "id": "your_asset_id",
        "name": "your_asset_name",
        "nameJson": {
          "default": "your_asset_name_default",
          "en_US": "your_asset_name_en",
          "zh_CN": "your_asset_name_zh"
        },
        "parentId": "your_node_id",
        "tags": [
          {
            "id": 123,
            "key": "your_tag_key",
            "value": "your_tag_value"
          }
        ]
      }
    ],
    "displayOrder": 0,
    "id": "your_asset_id",
    "name": "your_asset_name",
    "nameJson": {
      "default": "your_asset_name_default",
      "en_US": "your_asset_name_en",
      "zh_CN": "your_asset_name_zh"
    },
    "parentId": "",
    "tags": []
  },
  "message": "OK"
}