Get Asset Structure¶
获取资产所在的组织结构的上游组织结构。
操作权限¶
用户需要登录 EnOS 应用门户。
用户需要选择 OU。
请求格式¶
GET https://{apigw-address}/app-portal-service/v2.2/asset/structure
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
assetId |
Query |
必需 |
String |
资产ID。如何获取Asset ID信息>> |
请求参数(Header)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
Authorization |
必需 |
String |
Access Token,以 Bearer Token 表示,其形式为 Bearer {your token}。 需要通过调用 Log In 或 Refresh Access Token 接口后获取 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
data 结构体 |
组织结构 |
displayOrder |
Integer |
兄弟节点排列序号 |
nameJson |
I18nString |
组织结构名称,多语言,json结构 |
descriptionJson |
I18nString |
组织结构描述,多语言,json结构 |
data 结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
structures |
AssetStructure 结构体 |
组织结构树列表 |
AssetStructure 结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
组织结构 ID |
name |
String |
组织结构名称 |
description |
String |
组织描述 |
orgId |
String |
组织结构所在的组织 ID |
children |
AssetStructure 结构体 |
下层组织结构 |
错误码¶
代码 |
描述 |
---|---|
31400 |
资产 ID 不能为空 |
31401 |
提供的 Access Token 无效 |
31404 |
资产不存在 |
31512 |
未选择 OU |
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/asset/structure?assetId=your_asset_id
method: GET
headers: {"Authorization":"Bearer your_token"}
返回示例¶
{
"code": 0,
"data": {
"structures": [
{
"children": [],
"description": "",
"descriptionJson": {
"default": ""
},
"displayName": "wyf",
"id": "your_node_id",
"name": "wyf",
"nameJson": {
"default": "wyf"
},
"orgId": "your_org_id",
"displayOrder": 0
},
{
"children": [],
"description": "",
"descriptionJson": {
"default": ""
},
"displayName": "wyf2",
"id": "your_node_id",
"name": "wyf2",
"nameJson": {
"default": "wyf2"
},
"orgId": "yourOrgId",
"displayOrder": 1
}
]
},
"message": "OK"
}