查询表单数据
描述
根据指定的条件查询表单提交的数据。
访问地址
http://api.weTool.im/api/v1/entry/query
访问方式
POST
参数
参数名 | 数据类型 | 是否必须 | 示例值 | 默认值 | 描述 |
form_id | String | 是 | 558226580cf22a4f82d7b49a | 表单ID | |
page_number | Number | 否 | 1 | 0 | 查询页码,整数,从0开始计数 |
page_size | Number | 否 | 20 | 15 | 页码大小,整数,最大值为100 |
fields | Array | 否 | ["field1","field2"] | 需要查询的字段,可以在表单的API页面查询到字段名称 | |
order_by | Object | 否 | {"field1":1} | 排序依据。1为正序,-1为倒序。比如示例表示的含义为“按field1正序排列” | |
filters | Array | 否 | [{"field":"field1" ,"compare_type":"eq" ,"data_type":"string" ,"value":"123"}] | 过滤条件,每个条件是一个Object对象,各个条件将以and连接。示例中的条件用SQL表示,其含意为“field1='123'”。对象描述如下表格中所示。 |
过滤条件数据结构:
参数名 | 描述 |
field | 条件字段名 |
compare_type | 比较类型,值可以为"eq"(等于),"gt"(大于),"lt"(小于) |
data_type | 字段数据类型,值可以为"string"(文本),"number"(数字),“date”(日期) |
value | 条件值 |
返回值
参数名 | 描述 |
status | 执行状态。"success"表示成功,"error"表示失败 |
message | 如果失败,用此字段描述失败原因。如果成功,此字段为空。 |
total | 满足查询条件的总记录数 |
rows | 满足查询条件的当前页记录明细 |
返回示例
{"status":"success","total":2,"rows":[{"field5":1434297600000,"id":"552b51160cf2ba60b5b68289","field6":123.0,"field1":"文本1"},{"field5":1434297600000,"id":"552b51160cf2ba60b5b68290","field6":124.0,"field1":"文本2"}]}
curl示例
curl -u 51470abd078d49c496fda859:vWXVAWXeEQKfLlerFDMD3rsekBQzU5tz --header "Content-Type:application/json" -d "{\"form_id\":\"552b4ffe0cf2ba60b5b6825b\",\"fields\":[\"field1\",\"field5\",\"field6\",\"id\"],
\"filters\":[{\"field\":\"field1\" ,\"compare_type\":\"eq\" ,\"data_type\":\"string\" ,\"value\":\"123\"}],\"order_by\":{\"field1\":1}}" --url http://api.weTool.im/api/v1/entry/query