Get Asset Tree¶

获取资产树信息。

请求格式¶

GET https://{apigw-address}/asset-tree-service/v2.1/asset-trees?action=get

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	资产所属的组织ID。如何获取orgId信息>>
treeId	Query	必需	String	需要获取的资产树ID。如何获取资产树信息ID>>

响应参数¶

名称	数据类型	描述
treeId	String	资产树ID。
name	StringI18n	支持国际化的资产树名称。见国际化名称结构体>>
tags	Map（Key为String，Value为String）	用户自定义的一组资产树标签。
asset	Asset结构体	资产树的根资产，见 Asset 结构体>>

Asset 结构体 ¶

名称	数据类型	描述
assetId	String	资产ID。
modelId	String	资产所属模型ID。
modelIdPath	String	模型ID的路径。
name	StringI18n	支持国际化的资产名称。见国际化名称结构体>>
timezone	String	资产所属时区。使用+08:00格式表示不支持夏令时的时区. 使用Asia/Shanghai格式表示支持夏令时的时区。
description	String	资产描述。
label	String	资产类型： + `0` 表示设备资产， + `1` 表示逻辑资产。
inValid	Boolean	`true` 为无效节点， `false` 为有效节点。
attributes	Map（Key为String，Value为Object）	资产所属的模型属性。
tags	Map（Key为String, Value为String）	用户自定义标签。详情见标签的作用与表示方法>>

错误码¶

名称	错误信息	描述
17404	TreeId is not exist	Tree ID不存在。
99400	Invalid arguments	请求参数非法，请检查请求参数。
99500	System error	服务器内部错误，请联系EnOS。

示例¶

请求示例¶

url: https://{apigw-address}/asset-tree-service/v2.1/asset-trees?action=get&treeId=yourTreeId&orgId=yourOrgId
method: GET

返回示例¶

{
    "code":0,
    "msg":"OK",
    "requestId":"f3c1ffc7-cc8e-4a50-ad40-0fa7b0c3a7ac",
    "data":{
        "treeId":"ourTreeId",
        "name":{
            "defaultValue":"ourTreeId",
            "i18nValue":{
                "en_US":"ourTreeID"
            }
        },
        "tags":{
            "user":"zm",
            "user0":"lily"
        },
        "asset":{
            "inValid":false,
            "assetId":"yourAssetId",
            "modelId":"yourModelId",
            "modelIdPath":"yourModelIdPath",
            "name":{
                "defaultValue":"0430343",
                "i18nValue":{
                    "en_US":"0430343"
                }
            },
            "timezone":"+08:00",
            "description":null,
            "label":"1",
            "attributes":{

            },
            "tags":{
                "tree":"0430"
            }
        }
    }
}

Java SDK调用示例¶

package com.envisioniot.enos.asset_tree_service;

import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.api.common.constant.request.Pagination;
import com.envisioniot.enos.api.common.constant.request.Projection;
import com.envisioniot.enos.asset_tree_service.v2_1.*;
import com.envisioniot.enos.asset_tree_service.vo.*;
import org.junit.Test;
import java.util.HashMap;
import java.util.Map;

public class AssetTreeTest {
    private static String AccessKey = "yourAccessKey";
    private static String SecretKey = "yourSecretKey";
    private static String OrgId = "yourOrgId";
    private static String ServerUrl = "yourServerUrl";


    @Test
    public void testGetTree() throws Exception {;
        GetAssetTreeRequest request = new GetAssetTreeRequest();
        request.setOrgId(OrgId);
        request.setTreeId("yourTreeId");
        GetAssetTreeResponse response = Poseidon.config(PConfig.init().appKey(AccessKey).appSecret(SecretKey).debug())
            .url(ServerUrl)
            .getResponse(request, GetAssetTreeResponse.class);
        System.out.println(response.getData());
    }
}