主题
数据接口返回格式
针对以 /data
结尾的接口(类似图表、数据集的数据接口) ,衡石系统内有一批能够切换其返回结果格式的查询参数。
参数列表
参数名 | 参数值 | 参数说明 | 默认值 |
---|---|---|---|
format | String | 数据的返回格式,可选值:object 、array | array |
formatKey | String | 当返回格式为 object 时,指定用什么字段作为 key 。可选值:field_name , field_label | field_name |
formatSchema | Bool | 返回数据是否携带 schema | true |
传入错误的参数值,系统将使用默认的格式对结果格式进行处理。
/poll-data
等异步数据接口将应用对应的/data
数据接口上的参数值,所以说在/poll-data
等异步接口上传递以上参数是不起作用的。