获取记录
GET
/datasheets/{datasheetId}/records请求参数
每页返回多少条记录。默认每页返回 100 条记录。取值范围为 1~1000 的整数。
总共返回多少条记录。如果 maxRecords 与 pageSize 同时使用,且 maxRecords 的值小于总记录数,则只生效 maxRecords 的设置。
指定分页的页码,与参数 pageSize 配合使用。例如 pageSize=1000&pageNum=2
,返回 1001~2000 之间的记录。
对返回的记录进行排序。sort 是由多个排序对象 (sort object) 组成的数组。单个排序对象的结构为 {"order":"asc 或 desc", "field":"字段名称或字段 ID"}
。查询示例:sort[][field]=客户名称&sort[][order]=asc
,即按照「客户名称」列的字母升序来排列返回的记录。如果 sort 与 viewId 同时使用,则 sort 指定的排序条件将会覆盖视图里的排序条件。
返回一个指定的记录。获取多条记录示例:&recordIds=rec4zxfWB5uyM&recordIds=reclNflLgtzjY
。如果查询中包含多个 recordIds={recordId}
,返回结果按照传入 recordId 的顺序排序。无分页,每次最多返回 1000 条记录。
不显式指定 viewId 时,返回全部记录和全部字段。显式指定 viewId 时,则按照指定视图中的排序来依次返回该视图中的所有记录。注意:视图中隐藏的字段,不会出现在返回结果中。
限制在返回的记录结果只包含指定的字段。cURL 查询示例:1. &fields[]=姓名&fields[]=年龄
(当 &fieldKey=name
) 2. &fields[]=fldWooy3c3Puz&fields[]=fldEAr5y7Go5S
(当 &fieldKey=id
)。以上两种写法均会指定返回的记录只包含「姓名」「年龄」两列。
使用智能公式来筛选记录。公式使用方式可参考《一分钟上手公式》。如果 filterByFormula 与 viewId 同时使用,则会返回指定视图中满足此公式的所有记录。查询示例:&filterByFormula={标题}="标题1"
(需要用 encodeURIComponent() 函数对 {标题}="标题1"
进行转义编码),可以精确匹配「标题」这列中值为「标题1」的记录。
单元格中值的类型,默认为 json
类型。指定为 string
时,所有值都会自动转换为字符串格式。
查询字段和返回字段时所用的 key。默认使用 name
(字段名称)。指定为 id
时将以 fieldId 作为查询和返回方式(使用 id
可以避免因修改字段名称而导致的代码失效问题)。
示例代码
返回响应
全局状态值,如果为 false,则表示发生了业务错误或接口调用错误。
业务状态码,200 表示业务请求成功。
返回信息,执行错误时返回错误信息。
当前分页返回的所有记录数据。
每页返回的实际记录数。如果请求时指定 pageSize=100
,但实际记录数只有 35,则返回 35。
符合筛选条件的总记录条数。