Query Asset Attribute¶

根据对象实例标识符等信息获取指定资产的属性。

请求格式¶

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

请求参数¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	属性所属的组织 ID。如何获取 orgId 信息>>
mdmIds	Query/Form	必需	String	属性对应的对象实例的标识符，多个对象实例之间用英文逗号隔开。单次查询指定的对象实例数量不超过 20000。为保证查询性能，建议单次查询指定的对象实例数量不超过 100。
attributes	Query/Form	可选	String	待查询的资产属性的标识符，多个属性之间用英文逗号隔开。支持指定查询对象的模型属性和在通用数据服务中自定义的“虚拟属性”。如何获取 attributes 信息>>
locale	Query/Form	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
withI18n	Query/Form	可选	Boolean	是否返回完整的国际化内容，`true` 为返回，`false` 为不返回。默认不返回。
filter	Query/Form	可选	String	返回结果按 attributes 进行过滤。例如：`[[{"field":"field1","operator":">=","value":"1"},{"field":"field2","operator":"<=","value":"2"}],[{"field":"field3","operator":"==","value":"3"}]]`，该表达式含义为：(field1 >= 1 and field2 <= 2) or (field3=3)。
orderBy	Query/Form	可选	String	返回结果按 attributes 进行排序。例如：`[{"field":"field1","order":"ASC"}, {"field":"field2","order":"DESC"}]`，该表达式含义为：按 field1 升序进行一级排序，并按 field2 降序进行二级排序。
pageSize	Query/Form	可选	Integer	分页查询时单页返回记录的条数，最大值为 20000。
pageNo	Query/Form	可选	Integer	分页查询时指定页码，从 1 开始。

返回内容类型¶

application/json; charset = UTF-8

响应参数¶

名称	必然/可能返回	数据类型	描述
data	必然返回	Attribute 结构体	描述资产的属性。
pagination	必然返回	Pagination 结构体	描述分页信息。参见 Pagination 结构体。

Pagination 结构体 ¶

名称	必然/可能返回	数据类型	描述
pageNo	必然返回	Integer	请求页数，从 1 开始。
pageSize	必然返回	Integer	每页的记录数。
totalSize	必然返回	Integer	记录总数。

返回码¶

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

示例¶

请求示例¶

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

返回示例¶

{
    "data": {
        "yourMdmId": {
              "mdmType": "EnOS_Solar_Site",
              "mdmId": "yourMdmId",
              "capacity": "18.0"
        },
        "yourMdmId": {
              "capacity_rated": "4.0",
              "voltageClass": "10000",
              "mdmType": "EnOS_Solar_Site",
              "pvSysPR": "0.953",
              "mdmId": "yourMdmId",
              "capacity": "5.08032"
        }
    },
    "code": 0,
    "msg": "OK",
    "traceId": "1234567890abcdefghijkl0987654321"
}