Query Asset Hierarchy


根据对象实例标识符等信息获取指定资产的层级关系。

请求格式


GET https://{api-gateway}/cds-asset-service/v1.0/hierarchy?action=query

请求参数


名称

位置

必需/可选

数据类型

描述

orgId

Query

必需

String

资产层级所属的组织 ID。如何获取 orgId 信息>>

mdmIds

Query/Form

必需

String

资产对应的对象实例的标识符,多个对象实例之间用英文逗号隔开。单次查询指定的对象实例数量不超过 20000。为保证查询性能,建议单次查询指定的对象实例数量不超过 100。

mdmTypes

Query/Form

可选

String

资产所属的对象类型的标识符,多个对象类型之间用英文逗号隔开。单次查询指定的对象类型数量不超过 100,置空则返回所有子资产层级。如何获取 mdmTypes 信息>>

attributes

Query/Form

可选

String

待查询对象的属性,多个属性之间用英文逗号隔开。支持指定查询对象的模型属性和在通用数据服务中自定义的“虚拟属性”。如何获取 attributes 信息>>

pageNo

Query/Form

可选

Integer

分页查询时指定页码。

pageSize

Query/Form

可选

Integer

分页查询时单页返回记录的条数,最大值为 20000。

locale

Query/Form

可选

String

中文:zh-CN, 英文:en-US, 日语:ja-JP,西班牙语:es-ES。默认为 en-US。

withI18n

Query/Form

可选

Boolean

是否返回完整的国际化内容。

返回内容类型


application/json; charset = UTF-8

返回码


参见 通用数据服务 API 返回码

示例

请求示例


GET https://{api-gateway}/cds-asset-service/v1.0/hierarchy?action=query&orgId=yourOrgId&mdmIds=yourMdmId

返回示例


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