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. The value is `true` or `false`. Default is false.
filter	Query/Form	Optional	String	Specify how to filter the returned data by attributes. For example, [[{“field”:”field1”,”operator”:”>=”,”value”:”1”},{“field”:”field2”,”operator”:”<=”,”value”:”2”}],[{“field”:”field3”,”operator”:”==”,”value”:”3”}]], which means the returned data is filtered by (field1 >= 1 and field2 <= 2) or (field3=3).
orderBy	Query/Form	Optional	String	Specify how to sort the returned data by attributes. For example, [{“field”:”field1”,”order”:”ASC”}, {“field”:”field2”,”order”:”DESC”}], which means the returned data is sorted first by field1 in ascending order and then by field2 in descending order.
pageSize	Query/Form	Optional	Integer	The number of the returned records on a single page. The maximum number is 20000.
pageNo	Query/Form	Optional	Integer	The number of page to be returned, starting from 1.

Response Content Type¶

application/json; charset = UTF-8

Response Parameters¶

Name	To Return Definitely/Conditionally	Data Type	Description
data	Definitely	Attribute Struct	Describe the attributes of the asset.
pagination	Definitely	Pagination Struct	Describe the pagination information. See Pagination Struct.

Pagination Struct ¶

Name	To Return Definitely/Conditionally	Data Type	Description
pageNo	Definitely	Integer	The number of page to be returned, starting from 1.
pageSize	Definitely	Integer	The number of the returned records on a single page.
totalSize	Definitely	Integer	The total number of the returned records.

Response Codes¶

See Common Data Service API 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"
}