Get Structure Asset¶

获取用户在组织结构上有权查看的资产。

前提条件¶

用户已登录应用门户，并进入一个 OU。如有需要，可通过 Log In API 登录应用门户，通过 Choose Organization API 选择 OU。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/structure/asset/list

请求参数（Header）¶

名称	必需/可选	数据类型	描述
Authorization	必需	String	用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 `Bearer {your token}`。可通过调用 Log In 或 Refresh Access Token 接口后获取。

请求参数（Body）¶

名称

必需/可选

数据类型

描述

structureIds

必需

Array

组织结构 ID 列表。可通过 Get User Structures API 获取组织结构 ID。

locale

必需

String

指定以何种语言返回列表信息，支持以下赋值：

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

默认返回英语 en_US 的列表信息。

响应参数¶

名称	数据类型	描述
structureId	String	组织结构 ID。
structureName	String	组织结构名称。
structureNameJson	I18nString	组织结构的多语言名称。
assets	AssetBaseDTO Struct	组织结构下用户有权限的资产。AssetBaseDTO 结构体 >>

AssetBaseDTO 结构体¶

名称	数据类型	描述
assetId	String	资产 ID。
assetName	String	资产的默认名称。
displayOrder	Integer	排列序号，序号越小的排在越上方。
assetNameJson	I18nString	资产的多语言名称。

错误码¶

代码	描述
31400	structureIds 或 locale 为空或者存在不合法 ID
31401	提供的 Access Token 无效
31404	应用在 OU 内不存在
31512	未选择 OU

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/structure/asset/list

method: POST

headers: {"Authorization":"Bearer your_token"}

返回示例¶

{
  "code": 0,
  "data": [
      {
        "assets": [
                      {"assetId": "your_asset_id_1","assetName": "Inverter1", "displayOrder": 0, "assetNameJson": {"default": "Inverter1"}},
                      {"assetId": "your_asset_id_2","assetName": "Inverter2", "displayOrder": 1, "assetNameJson": {"default": "Inverter2"}}
                    ],
        "structureId": "your_structure_id_1",
        "structureName": "OrganizationA",
        "structureNameJson": {"default": "OrganizationA"}
      },
      {
        "assets": [
                      {"assetId": "your_asset_id_3","assetName": "Inverter3", "displayOrder": 0, "assetNameJson": {"default": "Inverter3"}},
                      {"assetId": "your_asset_id_4","assetName": "Inverter4", "displayOrder": 1, "assetNameJson": {"default": "Inverter4"}}
                    ],
        "structureId": "your_structure_id_2",
        "structureName": "OrganizationB",
        "structureNameJson": {"default": "OrganizationB"}
      }
    ],
  "message": ""
}