上报设备事件

POST /api/deviceEvents

创建设备事件

请求参数

参数名 类型 必填 描述 限制
deviceId string 设备标识
attributeName string 属性名称
attributeCode string 属性编码 由字母数字组成,符合变量定义规范
attributeData Object 属性值 属性具体取值,
attributeDataType Enum<string> 属性值类型 取值:Integer/Float/String/Boolean
ingressTime String 消息达到时间 时间格式:yyyy-MM-dd'T'HH:mm:ss.SSSZ
deviceTime String 消息产生时间 时间格式:yyyy-MM-dd'T'HH:mm:ss.SSSZ
source Enum<String> 消息源 source_device:从设备发出的消息
source_rest: 调用Restful API接口生成的消息
channel Enum<string> 渠道 标用于标识属性类型,取值
m:普通消息类型
w:告警类消息
g:地理位置信息数据
context Map<String, Object> 附加属性

请求样例

POST /api/v1/deviceEvents HTTP/1.1
Host: zl.glodon.com
Content-Type: application/json
Authorization: Bearer xxx-xxxx-xxx
Cache-Control: no-cache
Postman-Token: 74f1dc9a-bdd3-5890-c679-7851c0795127

{
  "deviceId": "281ac902-e4a8-425f-b924-728e82a3a1af",
  "attributeCode": "temp",
  "attributeData": 23.5,
  "ingressTime": "",
  "deviceTime": "",
  "source": "source_device",
  "correlationId": "",
  "channel": "m"
}

响应参数

名称 编码 数据类型 描述
消息元数据 meta Metadata
消息数据体 payload Payload

Metadata

名称 编码 数据类型 描述
消息标识 id STRING
消息类型 type Enum<STRING> m: Measurement普通数据(Default)
log:日志数据
ack:响应数据
c:配置命令
设备标识 deviceid STRING
消息版本号 version STRING
时间戳 ts LONG Unix时间戳,自 1970 年 1 月 1 日(00:00:00 GMT)以来的秒数
是否需要响应 needack Boolean
关联标识 correlationId STRING 仅当消息类型为ack时需要,取值为请求消息的id

Payload

下行Payload格式

名称 编码 数据类型 描述
属性数据列表 attrs List<PayloadAttribute> 下行:消息类型m
上行:消息类型m
操作列表 actions List<PayloadAction> 下行:消息类型为 m,c

PayloadAttribute

名称 编码 数据类型 描述
属性编码 code String
属性值 value Object
属性数据类型 channel Enum<STRING> m: Measurement普通数据(Default)
w:告警数据
g:位置数据

PayloadAction

名称 编码 数据类型 描述
编码 code STRING 操作方法名称,需符合函数名定义规则
参数列表 params Map<String,Object>

响应样例

{
  "returnCode": 0,
  "result": {
    "meta": {
      "type": "m",
      "deviceid": "839be002-947d-43a2-aceb-40ff95d9484e",
      "version": "1.0.0",
      "ts": 1469564492,
      "needack": false,
      "id": "b69451e2-779b-4275-943b-cf0f6bbeb858"
    },
    "payload": {
      "attrs": [
        {
          "code": "temp",
          "value": 23.8,
          "channel": "m"
        }
      ]
    }
  }
}