Query Accessible Asset¶
根据对象类型标识符等信息获取可访问的资产列表。
请求格式¶
GET https://{api-gateway}/cds-asset-service/v1.0/accessible-asset?action=query
请求参数¶
名称 |
位置 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。 如何获取 orgId 信息>> |
accessKey |
Query |
可选 |
String |
访问密钥。 如何获取 accessKey 信息>> |
mdmTypes |
Query |
必需 |
String |
资产所属的对象类型的标识符,多个对象类型之间用英文逗号隔开。单次查询指定的对象类型数量不超过 100。如何获取 mdmTypes 信息>> |
attributes |
Query |
可选 |
String |
待查询对象的属性,多个属性之间用英文逗号隔开。支持指定查询对象的模型属性和在通用数据服务中自定义的“虚拟属性”。如何获取 attributes 信息>> |
pageNo |
Query |
可选 |
Integer |
分页查询时指定页码。 |
pageSize |
Query |
可选 |
Integer |
分页查询时单页返回记录的条数,最大值为 20000。 |
locale |
Query |
可选 |
String |
中文:zh-CN, 英文:en-US, 日语:ja-JP,西班牙语:es-ES。默认为 en-US。 |
withI18n |
Query |
可选 |
Boolean |
是否返回完整的国际化内容。 |
返回内容类型¶
application/json; charset = UTF-8
返回码¶
参见 通用数据服务 API 返回码。
示例¶
请求示例¶
GET https://{api-gateway}/cds-asset-service/v1.0/accessible-asset?action=query&orgId=yourOrgId&mdmTypes=yourMdmType
返回示例¶
{
"data": [
{
"mdmId": "site 1",
"attributes": {
"mdmId": "yourMdmId",
"mdmType": "EnOS_Solar_Site",
"name": "*************"
}
},
{
"mdmId": "site 2",
"attributes": {
"mdmId": "yourMdmId",
"mdmType": "EnOS_Solar_Site",
"name": "*************"
}
}
],
"code": 0,
"msg": "OK",
"traceId": "1234567890abcdefghijkl0987654321"
}