易企办开发者 / REST API

分页、筛选和排序

使用列表查询接口选择字段、过滤记录、指定排序并逐页读取结果。

组合查询条件

列表查询使用 POST 请求提交 JSON 对象。Fields 指定返回字段,Filters 定义条件,Sorts 控制排序,PageIndex 和 PageSize 分别定义页码及页大小。

{
  "Fields": [
    "Title",
    "Created"
  ],
  "Filters": [
    {
      "Field": "Title",
      "Type": 8,
      "Value": "采购"
    }
  ],
  "Sorts": [
    {
      "Field": "Created",
      "Desc": true
    }
  ],
  "PageIndex": 1,
  "PageSize": 20
}

按索引字段设置条件

  • 用 Field 指定字段,Type 指定比较方式,Value 提供比较值。比较值为数组时,将数组编码为 JSON 字符串。
  • Pre 使用 and 或 or。用 Child 组合嵌套条件。
  • 排序或筛选前检查字段已开启索引。Desc 为 true 时按降序排列。
Type比较方式适用字段
0等于所有字段类型
1小于或等于数字、金额、日期、时间
2大于或等于数字、金额、日期、时间
3大于数字、金额、日期、时间
4小于数字、金额、日期、时间
5不等于所有字段类型
6为空所有字段类型
7不为空所有字段类型
8以指定文本开头文本
9在指定值集合中所有字段类型
10包含指定成员人员、组织、成本中心、标签

逐页读取并保持顺序

从第一页开始。规范给出的 PageSize 默认值是 20,上限是 1000。按实际返回的记录和总量决定是否继续翻页。使用稳定的排序条件,避免在更新频繁的列表中漏读或重复处理。

接口定义以易企办中国版公开 OpenAPI v1 为准。

查看完整规范查看官方接口文档
继续阅读 响应与错误