Search Related Asset Node¶

Query assets on the specified asset tree by specifying the relationship with a known asset.

Request Format¶

POST https://{apigw-address}/asset-tree-service/v2.1/asset-nodes?action=searchRelatedAsset

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>>
treeId	Query	true	String	ID of the asset tree to be gotten. How to get the ID of an asset tree>>

Request Parameters (Body)¶

Name	Required or Not	Data Type	Description
filter	false	Filter struct	Asset query criteria. All criteria are optional. All the specified criteria are related with each other under the “and” relationship, that is, the assets to be queried must satisfy all the specified criteria at the same time. At most one out of the 4 relational query criteria is allowed. See Filter Struct
pagination	false	Pagination request struct	Used to describe paging requirements in an interface request. The maximum records per page is 1000. See Pagination Request Struct
projection	false	Projection struct	Used to describe the object projection to be returned in the interface request. For details, see How does projection crop the result set>>

Filter Struct ¶

Name	Required or Not	Data Type	Description
assetIds	False	String Array	Asset ID, which supports querying multiple assets; multiple asset IDs are separated by commas. How to get assetId>>
nameLike	False	I18nSearchVo	Asset name. Supports fuzzy inquiry of specified language. See I18nSearchVo Struct
modelIds	False	String Array	Model ID which the asset belongs to. Provide the list of multiple model IDs if you want to query multiple models. How to get modelID>>
rootModelIds	False	String Array	Root model ID which the asset belongs to. Provide multiple root model IDs if you want to query multiple root models
isParentOfAssetId	False	String	The asset to be queried is the immediate parent node of the specified asset, and its value is the asset ID of the specified asset. How to use expression>>
isChildOfAssetId	False	String	The asset to be queried is the immediate child node of the specified asset, and its value is the asset ID of the specified asset. How to use expression>>
isAncestorOfAssetId	False	String	The asset to be queried is the ancestor node of the specified asset, and its value is the asset ID of the specified asset. How to use expression>>
isDescendantOfAssetId	False	String	The asset to be queried is the descendant node of the specified asset, and its value is the asset ID of the specified asset. How to use expression>>

I18nSearchVo Struct ¶

Name	Required or Not	Data Type	Description
locale	String	True	Language, only support “default”, “zh_CN”, and “en_US”
value	String	True	The asset name in the specific language

Response Parameters¶

Name	Data Type	Description
data	Asset struct	asset list

Sample 1¶

Request Sample¶

POST
https://{apigw-address}/asset-tree-service/v2.1/asset-nodes?treeId=k6wweMTP&action=searchRelatedAsset&orgId=o15517683199241
{
 "filter": {
  "isChildOfAssetId": "4R6PbfVj"
 },
"projection": ["attributes", "assetId", "name"]
}

Return Sample¶

{
 "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
}
}