Skip to content

字段参考

概述

本词汇表列出了 API v2 中重复出现的标识符和字段。在阅读端点规范时使用它,以保持集成中的命名一致。

组织

字段描述示例
slug用于 URL 和访问令牌的组织标识符。小写,每个租户唯一。yengear

项目

字段描述示例
project_id项目的公共标识符。出现在 URL 中:/projects/{project_id}/...proj_xxxx

设备

字段描述示例
id设备的内部整数主键。在嵌套路由中用作 {device_pk}128
serial_number硬件标识符(IMEI、SN)。通过安全码绑定设备时使用。868686000123456
agri_id (设备)设备创建时分配的平台生成的字符串 ID。数据点 ID 的前缀。d-1000-abcd

数据点

字段描述示例
id数据点的内部整数主键。在嵌套路由中用作 {id}1
unitModbus 从站 ID(整数)。1
address寄存器地址(整数)。0
data_index读取多个寄存器时使用的偏移量。0
modbus_type寄存器类型(holdinginputcoildiscrete)。holding
data_type寄存器值的编码(int16uint32float 等)。int16
data_endian字节顺序(ABCDDCBABADCCDAB)。ABCD
data_scale缩放系数,最终值 = 原始值 × data_scale + data_delta。0.1
data_delta缩放后应用的加法偏移。-10
the_type数据点类型 ID,通过 /points/options/ 端点解析。1
the_type_detailthe_type 的扩展元数据(名称、单位、图标)。{ "name": "Temperature", "unit": "℃" }
agri_id (数据点)完整的数据点标识符d-1000-abcd-1-000

数据负载

字段描述示例
tUTC 时间戳(秒)。1708070400
value / v数据点的数值读数。某些端点使用 value,其他使用 v25.6
project_id注入到 POST /devices/{device_pk}/data/ 响应中以显示源项目。proj_xxxx
org_slug注入到 POST /devices/{device_pk}/data/ 响应中以显示所属组织。yengear