Search Related Asset Node¶
查询指定资产树上的资产,指定相对于某个已知资产的关系作为查询条件。
操作权限¶
需授权的资源 | 所需操作权限 |
---|---|
资产树管理 | Read |
请求格式¶
POST http://{apigw-address}/asset-tree-service/v2.1/asset-nodes?action=searchRelatedAsset
请求参数(URI)¶
名称 | 位置(Path/Query) | 是否必须 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | true | String | 资产所属的组织ID。如何获取orgId信息>> |
treeId | Query | true | String | 需要获取的资产树ID。如何获取资产树信息ID>> |
请求参数(Body)¶
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
filter | false | Filter结构体 | 资产的查询条件。 所有的条件都是可选的。 所有指定的条件之间都是“与”关系,即待查询的资产必须同时满足所有指定的条件。 4个关系查询条件至多提供一个,见Filter结构体>> |
pagination | false | Pagination请求结构体 | 用于在接口请求中描述分页要求。每页最大记录数为1000条。默认第一页,分页大小为100条记录。见Pagination请求结构体>> |
projection | false | Projection结构体 | 用于在接口请求中描述待返回的对象projection。详见projection参数如何对结果集做裁剪>> |
Filter结构体 ¶
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
assetIds | False | String Array | 资产ID。如果想查询多个资产,就提供多个资产ID。如何获取Asset ID信息>> |
nameLike | False | I18nSearchVo | 资产名称,支持模糊搜索 见I18nSearchVo结构体 |
modelIds | False | String Array | 资产所属模型ID。如果想查询多个模型,就提供多个模型ID 如何获取modelId信息>> |
rootModelIds | False | String Array | 资产所属的根模型ID。如果想查询多个根模型,就提供多个根模型ID |
isParentOfAssetId | False | String | 待查询的资产是指定资产的直接父节点,值为指定资产的资产ID 如何使用查询表达式>> |
isChildOfAssetId | False | String | 待查询的资产是指定资产的直接子节点,值为指定资产的资产ID 如何使用查询表达式>> |
isAncestorOfAssetId | False | String | 待查询的资产是指定资产的祖先节点,值为指定资产的资产ID 如何使用查询表达式>> |
isDescendantOfAssetId | False | String | 待查询的资产是指定资产的子孙节点,值为指定资产的资产ID 如何使用查询表达式>> |
I18nSearchVo结构体 ¶
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
locale | String | True | 语言类型,只支持default、zh_CN和en_US |
value | String | True | 资产名称在所属语言下的值 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | Asset结构体 | asset的列表。参见 Asset结构体>> |
示例 1¶
请求示例¶
POST https://{apigw-address}/asset-tree-service/v2.1/asset-nodes?treeId=k6wweMTP&action=searchRelatedAsset&orgId=yourOrgId
{
"filter": {
"isChildOfAssetId": "4R6PbfVj"
},
"projection": ["attributes", "assetId", "name"]
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "153ad7a2-2ec1-41b0-b750-e4ea2ce2786c",
"data":
[{
"assetId": "8byS3cuc",
"name": {
"i18nValue": {},
"defaultValue": "ycmdevice_1"
},
"attributes": {}
}, {
"assetId": "Fq5M1Y6E",
"name": {
"i18nValue": {},
"defaultValue": "ycmdevice_3"
},
"attributes": {}
}, {
"assetId": "nPQUW0Nr",
"name": {
"i18nValue": {
"en_US": "Rebecca_testSiteAPI3"
},
"defaultValue": "Rebecca_testSiteAPI3"
},
"attributes": {}
}, {
"assetId": "oLrrH1uz",
"name": {
"i18nValue": {},
"defaultValue": "Rebecca_Service1"
},
"attributes": {}
}, {
"assetId": "vuT6x3Xl",
"name": {
"i18nValue": {},
"defaultValue": "ycmdevice_2"
},
"attributes": {}
}],
"pagination" : {
"pageNo": 1,
"pageSize": 10,
"totalSize": 10,
"sortedBy":null
}
}