分类： 列出文档

要列出文档，请向 /api/resource/{doctype} 发送 GET 请求。

GET /api/resource/Person

所有列表默认每页返回 20 条记录。要更改每页大小，可以传递查询参数 limit_page_length。要请求后续页面，请传递 limit_start。

响应以 JSON 对象形式返回，列表是一个数组，键为 data。

响应：

{
 "data": [
 {
 "name": "000000012"
 },
 {
 "name": "000000008"
 }
 ]
}

默认情况下，列表中只包含 name 字段。要添加更多字段，可以在 GET 请求中传递 fields 参数。fields 必须是一个包含字段名的 JSON 数组。

GET /api/resource/Person/?fields=[“name”,”first_name”]

响应：

{
 "data": [
 {
 "first_name": "Jane",
 "name": "000000012"
 },
 {
 "first_name": "John",
 "name": "000000008"
 }
 ]
}

你可以通过传递查询参数 filters 来使用 SQL 条件筛选列表。filters 必须是一个包含一个或多个过滤条件的 JSON 数组。每个条件的格式为 [{doctype}, {field}, {operator}, {operand}]。

例如，获取所有名字为 “Jane” 的人员的 name（id）：

GET /api/resource/Person?filters=[[“Person”,”first_name”,”=”,”Jane”]]

响应：

 { "data": [ { "name": "000000012" } ] }

作者：Rushabh Mehta ([email protected])、Raffael Meyer ([email protected])