Query Asset Attribute¶
Get asset attributes by object instance IDs.
Request Format¶
GET/POST https://{api-gateway}/cds-asset-service/v1.0/attribute?action=query
Request Parameters¶
Name |
Location |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
orgId |
Query |
Mandatory |
String |
The organization ID which the attribute 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. |
attributes |
Query/Form |
Optional |
String |
The attribute ID of the asset. Separate multiple IDs by commas. Both model attributes and “virtual attributes” defined in Common Data Service are supported. How to get attributes>> |
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. |
Response Content Type¶
application/json; charset = UTF-8
Response Codes¶
Samples¶
Request Sample¶
GET https://{api-gateway}/cds-asset-service/v1.0/attribute?action=query&orgId=yourOrgId&mdmIds=yourMdmId
Response Sample¶
{
"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"
}