查询多条数据

更新时间：2026.07.21 10:41

功能说明

分页查询指定表单页面的数据，支持状态、创建时间、字段值和多条件排序。

调用说明

地址：

https://www.shudacloud.com/api/open-api/platform/form-data/query

方式：POST

接口编码：form-data:query

鉴权方式：在请求 Header 中传入 X-API-Key。无需传入 tenant-id，服务端会根据 API Key 自动识别所属租户。

本页参数和返回值来自测试环境真实调试；请求示例中的域名已按生产环境填写。当前示例 API Key 仅在测试环境有效。

请求参数

名称	位置	类型	是否必选	示例值	描述
X-API-Key	Header	String	是	qop_f9f5d23ff4c84e2aa513e37d08780022	开放平台 API Key
appCode	Body	String	是	cd5151d248b24b1cac453a423648cb4f	应用编码
pageCode	Body	String	是	fbafb18922b94dc2ad43325d29b6ab6e	表单页面编码
pageNo	Body	Integer	否	1	页码，默认 1
pageSize	Body	Integer	否	10	每页数量，默认 10，最大 100
dataStatus	Body	Integer	否	0	数据状态：0 草稿，1 保存
createTime	Body	Array	否	["2026-01-01 00:00:00","2026-12-31 23:59:59"]	创建时间范围
filters	Body	Object	否	{"form-d2oB":"开放接口文档测试数据-已更新-20260721"}	字段筛选，键使用 form-xxxx
sortRules	Body	Array	否	[{"fieldName":"createTime","order":"desc"}]	多条件排序，优先于单字段排序
sortField	Body	String	否	createTime	单字段排序字段
sortOrder	Body	String	否	desc	排序方向：asc 或 desc

返回数据

名称	类型	示例值	描述
code	Integer	0	业务状态码，0 表示成功
msg	String	空字符串	业务提示信息
data.total	Long	1	总条数
data.list	Array	见返回示例	当前页数据列表
data.list[].id	String	c3f5f8b41e21c012ec7a065c32cb7a74	表单实例编号
data.list[].data	Object	{"form-d2oB":"开放接口文档测试数据-已更新-20260721"}	表单数据

示例

请求示例

curl --request POST \
  --url "https://www.shudacloud.com/api/open-api/platform/form-data/query" \
  --header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022" \
  --header "Content-Type: application/json" \
  --data '{
  "appCode": "cd5151d248b24b1cac453a423648cb4f",
  "pageCode": "fbafb18922b94dc2ad43325d29b6ab6e",
  "pageNo": 1,
  "pageSize": 10,
  "filters": {
    "form-d2oB": "开放接口文档测试数据-已更新-20260721"
  },
  "sortRules": [
    {
      "fieldName": "createTime",
      "order": "desc"
    }
  ]
}'

正常返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 1,
    "list": [
      {
        "id": "c3f5f8b41e21c012ec7a065c32cb7a74",
        "pageCode": "fbafb18922b94dc2ad43325d29b6ab6e",
        "dataStatus": 0,
        "creator": "fe60e40e057c4700e60cb7885a43b790",
        "updater": "fe60e40e057c4700e60cb7885a43b790",
        "createTime": 1784601334976,
        "updateTime": 1784601335766,
        "data": {
          "form-d2oB": "开放接口文档测试数据-已更新-20260721"
        }
      }
    ]
  }
}

常见异常

业务状态码	说明
400	请求参数格式或必填参数校验失败
1002030001	未传入 X-API-Key
1002030002	API Key 无效
1002030003	API Key 已停用
1002030004	当前调用 IP 不在 API Key 白名单内
1002030006	当前 API Key 无权调用该接口
1002030007	appCode 不能为空
1002030008	当前 API Key 无权访问该应用

开放接口的业务异常通常仍返回 HTTP 200，请以响应体中的 code 判断调用是否成功。

上一条 查询单条数据 下一条 新建数据