跳到主要内容

获取列表(分页)

V1 列值协议;直接 HTTP 调用,需要用户 Bearer 和当前请求签名。

项目内容
方法POST
路径/open-api/openapi/form/page
认证用户 Bearer + 当前请求签名 + 租户与应用上下文
请求格式application/json

调用准备​

按公共请求约定替换地址和占位值,按生成签名计算本次请求的签名。以下 JSON 保存为 UTF-8 的 request.json;签名必须使用同一份实际参数。示例为命令行 cURL;Windows PowerShell 可使用 curl.exe 并将多行命令合为一行。

请求参数​

参数类型 / 必填说明
table字符串 / 是目标表单 ID;与当前应用归属一致。
navi.page整数 / 是页码,从 1 开始。
navi.vol整数 / 是每页条数;示例 10,遵守部署限额。
conditions对象 / 否筛选条件,参见查询条件参考。
orders对象数组 / 否按 column 与 direction 指定排序。
columns对象 / 否指定输出列或排除列。

请求示例​

request.json
{
"table": "YOUR_FORM_ID",
"navi": {
"page": 1,
"vol": 10
}
}
curl --request POST "https://admin.duoge.work/api/open-api/openapi/form/page" \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN" \
--header "TENANT-ID: YOUR_NUMERIC_TENANT_ID" \
--header "X-APPLICATION-ID: YOUR_APPLICATION_ID" \
--header "app_id: YOUR_APPLICATION_ID" \
--header "timestamp: CURRENT_MILLISECONDS" \
--header "signature: SIGNATURE_FOR_THIS_REQUEST" \
--header "Content-Type: application/json" \
--data-binary "@request.json"

返回说明​

成功时 data 为分页对象;records 为本页记录数组,total 为总记录数,current / size / pages 为分页信息。不要用 records.length 代替 total。无命中时 records 为空数组。

以下仅为相关字段的结构示意;记录字段、消息及其他属性按实际返回。

{
"code": 0,
"data": {
"records": [
{
"id": "EXAMPLE_RECORD_ID"
}
],
"total": 1,
"current": 1,
"size": 10,
"pages": 1
}
}

使用说明与排错​

适合列表展示和逐页同步。翻页时保持相同筛选及稳定排序;数据变化时分页结果也可能变化。产品中的“获取列表”示例使用此 /page 路径;无分页读取另见列表查询。条件、选项值与排序见查询条件参考。