Get Structure Asset¶
获取用户在组织结构上的资产。
操作权限¶
用户需要登录 EnOS 应用门户并选择 OU。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.2/structure/asset/list
请求参数(Header)¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| Authorization | 必需 | String | Access Token,以Bearer Token表示,其形式为`Bearer {your token}`,需要通过调用 Log In 或 Refresh Access Token 接口后获取 | 
请求参数(Body)¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| structureIds | 必需 | List<String> | 组织结构id列表,可以通过接口 Get User Structures 获取这些组织结构 | 
| locale | 必需 | java.util.Locale | 语言,用于显示对应语言的资产和组织结构名称,不填默认为英语 | 
响应参数¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| data | List<StructureAssetDTO> | 组织结构及其下面用户有权限的资产 | 
StructureAssetDTO 结构体¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| structureId | String | 组织结构 ID | 
| structureName | String | 组织结构名称 | 
| assets | List<AssetBaseDTO> | 组织结构下用户有权限的资产 | 
AssetBaseDTO 结构体¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| assetId | String | 资产 ID | 
| assetName | String | 资产名称 | 
| displayOrder | Integer | 排列序号 | 
| structureNameJson | I18nString | 组织结构名称,多语言,json结构 | 
| assetNameJson | I18nString | 资产名称,多语言,json结构 | 
错误码¶
| 代码 | 描述 | 
|---|---|
| 31400 | structureIds 或 locale 为空或者存在不合法 id | 
| 31401 | 提供的 Access Token 无效 | 
| 31404 | 组织内不存在调用时使用的 app | 
| 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": ""
}