Skip to content

数据接口返回格式

针对以 /data 结尾的接口(类似图表、数据集的数据接口) ,衡石系统内有一批能够切换其返回结果格式的查询参数。

参数列表

参数名参数值参数说明默认值
formatString数据的返回格式,可选值:objectarrayarray
formatKeyString当返回格式为 object 时,指定用什么字段作为 key。可选值:field_name, field_labelfield_name
formatSchemaBool返回数据是否携带 schematrue

传入错误的参数值,系统将使用默认的格式对结果格式进行处理。

/poll-data 等异步数据接口将应用对应的 /data 数据接口上的参数值,所以说在 /poll-data 等异步接口上传递以上参数是不起作用的。

HENGSHI SENSE API 使用手册