Get Asset Trees¶
Search asset tree by a group of assetId. If assetId is not in the tree, then there is no such key in data.
Request Format¶
POST https://{apigw-address}/asset-tree-service/v2.1/asset-nodes?action=getAssetTree
Request Parameters (URI)¶
| Name | Location (Path/Query) | Required or Not | Data Type | Description |
|---|---|---|---|---|
| orgId | Query | true | String | Organization ID which the asset belongs to. How to get orgId>> |
Request Parameters (Body)¶
| Name | Location (Path/Query) | Required or Not | Data Type | Description |
|---|---|---|---|---|
| assetIds | Query | true | String Array | A group of asset ID, where at most 100 Ids are supported. How to get assetId>> |
| projection | Query | false | String Array | Used to describe the object projection to be returned in the interface request. For details, see How does projection crop the result set>> |
Response Parameters¶
| Name | Data Type | Description |
|---|---|---|
| data | Map (the Key is assetId and the Value is the AssetTree struct) | List of assets and their asset trees. See AssetTree Struct |
AssetTree Struct
| Name | Data Type | Description |
|---|---|---|
| treeId | String | Asset tree ID |
| tags | Map<String, String> | A group of user-customized tags of asset tree |
| asset | AssetTree struct | Root asset on the asset tree |
Sample 1¶
Request Sample¶
POST https://{apigw-address}/asset-tree-service/v2.1/asset-nodes?action= getAssetTree&orgId=o15541858646501
{
"assetIds": ["BtsYmF2r", "qf1vsBQW"]
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"requestId": "82248518-6da4-49d2-8d07-cf7a0ff55b60",
"data": {
"BtsYmF2r" : [{
"treeId" : "QafeaWe",
"tags" : { },
"asset": {
"modelId": "NULLMODEL",
"assetId": "qf1vsBQW",
"timezone": "+08:00",
"name": {
"i18nValue": {
"en_US": "zmTree604111zzz"
},
"defaultValue": "zmTree604"
},
"description": "",
"attributes": {},
"inValid": false,
"label": "1",
"modelIdPath": "/NULLMODEL",
"tags": {}
}]
}