Query Asset Hierarchy¶
Get asset hierarchies by object instance IDs.
Request Parameters¶
| Name | Location | Mandatory/Optional | Data Type | Description |
|---|---|---|---|---|
| orgId | Query | Mandatory | String | The organization ID which the asset belongs to. How to get orgId >> |
| mdmIds | Query/Form | Mandatory | String | The object instance ID of the asset. Separate multiple IDs by commas. Up to 20000 object instances are allowed in a single query. To ensure query performance, it is recommended that you pass in no more than 100 object instances in a single query. |
| mdmTypes | Query/Form | Optional | String | The object type ID which the asset belongs to. Separate multiple IDs by commas. Up to 100 object type IDs are allowed in a single query. All child hierarchies will be returned if mdmTypes is not set. How to get mdmTypes>> |
| attributes | Query/Form | Optional | String | The attribute of the asset. Separate multiple attributes by commas. Both model attributes and “virtual attributes” defined in Common Data Service are supported. How to get attributes>> |
| pageNo | Query/Form | Optional | Integer | The number of page to be returned. |
| pageSize | Query/Form | Optional | Integer | The number of the returned records on a single page. The maximum number is 20000. |
| locale | Query/Form | Optional | String | Use zh-CN, en-US, ja-JP, or es-ES. If not specified, the value is set to en_US by default. |
| withI18n | Query/Form | Optional | Boolean | Whether to return the internationalization content. |
Samples¶
Request Sample¶
GET https://{api-gateway}/cds-asset-service/v1.0/hierarchy?action=query&orgId=yourOrgId&mdmIds=yourMdmId
Response Sample¶
{
"data": {
"yourMdmId": {
"mdmObjects": {
"Solar_CombinerBox":[
{
"mdmId":"yourChildMdmId",
"attributes": {
"mdmType": "Solar_CombinerBox",
"modelId": "EnOS_Solar_CombinerBox",
"timezone": "+08:00",
"name": "yourMdmName",
"branches": "2,3,4,5,6,7,8,9,10,11,12,13,14,15,16",
"topoParentDeviceID": "yourParentDeviceId",
"modelIdPath": "/EnOS_Solar_CombinerBox",
"mdmId": "yourChildMdmId",
"parentId": "yourMdmId",
"branchMax": "16"
}
}
],
"Solar_Site": [
{
"mdmId": "yourMdmId",
"attributes": {
"altitude": "4.0",
"timezone": "+08:00",
"longitude": "121.0846",
"mdmId": "yourMdmId"
}
}
]
}
}
},
"code": 0,
"msg": "OK",
"traceId": "1234567890abcdefghijkl0987654321"
}