Get Resource List¶

获取资源列表。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.3/resource/list

请求参数（Query）¶

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

请求参数（Body）¶

名称	必需/可选	数据类型	描述
codes	可选	Array	按代码获取资源。
ids	可选	Array	按 ID 获取资源。
types	可选	Array	按资源所属类型的代码获取资源。
pagination	必需	Pagination 请求结构体	分页参数，参见 Pagination 请求结构体（若不提供，则默认按照每页1000条数据的格式返回第0页的数据）。

响应参数¶

名称	数据类型	描述
data	Data 结构体	资源信息。

Data 结构体¶

名称	数据类型	描述
resources	Resources 列表	资源列表。
pagination	Pagination 结构体	分页信息。

Resources 列表¶

名称	数据类型	描述
code	String	资源代码。
name	Object	资源名称。
id	String	资源标识符。
type	String	资源类型代码。

错误码¶

代码	描述
31400	缺少必要参数。
31404	本 OU 未获取此应用。

示例¶

请求示例¶

url: /app-portal-service/v2.3/resource/list?orgId=your_org_ID

method: POST

{
  "orgId": "your_ou_id",
  "codes": [
    "your_resource_code_1",
    "your_resource_code_2"
  ],
  "ids": [
    "your_resource_id_1",
    "your_resource_id_2"
  ],
  "types": [
    "your_resource_type_code_1",
    "your_resource_type_code_2"
  ],
  "pagination": {
    "pageNo": 0,
    "pageSize": 1000,
    "sorters": []
  }
}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "resources": [
      {
        "id": "your_resource_id_1",
        "code": "your_resource_code_1",
        "type": "your_resource_type_code_1",
        "name": {
          "defaultValue": "your_resource_name_1",
          "i18nValue": {
            "zh_CN": "your_resource_name_zh_1",
            "en_US": "your_resource_name_en_1"
          }
        }
      },
      {
        "id": "your_resource_id_2",
        "code": "your_resource_code_2",
        "type": "your_resource_type_code_2",
        "name": {
          "defaultValue": "your_resource_name_2",
          "i18nValue": {
            "zh_CN": "your_resource_name_zh_2",
            "en_US": "your_resource_name_en_2"
          }
        }
      }
    ],
    "pagination": {
      "totalElements": 2,
      "pageNo": 0,
      "pageSize": 1000
    }
  }
}