属性接口规范¶
属性
类型的接口提供未定义在 EnOS 模型上的属性信息。将 属性
类型的接口注册为数据源之前,需按照以下规范对接口进行标准化。
请求参数¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
orgId | 必需 | String | 属性所属的组织 ID。 |
dimensionId | 必需 | String | 属性对应的维度的标识符。 |
keys | 必需 | String | 属性对应的维度的键值。 |
fields | 可选 | String | 属性的字段映射,多个字段之间用英文逗号隔开。 |
响应参数¶
名称 | 必然/可能返回 | 数据类型 | 描述 |
---|---|---|---|
data | 必然返回 | AttributeData 结构体 | 描述属性的信息。参见 AttributeData 结构体。 |
AttributeData 结构体 ¶
名称 | 必然/可能返回 | 数据类型 | 描述 |
---|---|---|---|
key | 必然返回 | String | 属性对应的维度的键值。 |
field | 必然返回 | String | 属性的字段映射。 |
value | 必然返回 | Integer/Double/String | 属性的数值。 |
请求示例¶
POST {requestURL}?orgId=yourOrgId
Content-Type: application/x-www-form-urlencoded
Payload: dimensionId=yourDimensionId&keys=yourKey1,yourKey2&fields=yourField1,yourField2
返回示例¶
{
"data": {
"key1": {
"field1": "10",
"field2": 0
},
"key2": {
"field1": "10",
"field2": 0
}
},
"code": 0,
"msg": "OK"
}