用户表单查询
更新时间：2026.07.21 10:41
功能说明
查询指定应用下的所有非目录页面，包含普通页面和表单页面。
调用说明
地址：
https://www.shudacloud.com/api/open-api/platform/forms/query
方式：POST
接口编码：forms:query
鉴权方式：在请求 Header 中传入 X-API-Key。无需传入 tenant-id，服务端会根据 API Key 自动识别所属租户。
本页参数和返回值来自测试环境真实调试；请求示例中的域名已按生产环境填写。当前示例 API Key 仅在测试环境有效。
请求参数
| 名称 | 位置 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|---|
| X-API-Key | Header | String | 是 | qop_f9f5d23ff4c84e2aa513e37d08780022 | 开放平台 API Key |
| appCode | Body | String | 是 | cd5151d248b24b1cac453a423648cb4f | 应用编码 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | Integer | 0 | 业务状态码，0 表示成功 |
| msg | String | 空字符串 | 业务提示信息 |
| data | Array | 见返回示例 | 页面列表 |
| data[].id | String | f4a44060bf7ee14e47410f6fbc3e7403 | 页面编号 |
| data[].code | String | fbafb18922b94dc2ad43325d29b6ab6e | 页面编码 |
| data[].appCode | String | cd5151d248b24b1cac453a423648cb4f | 应用编码 |
| data[].name | String | 未命名的表单 | 页面名称 |
| data[].type | Integer | 1 | 页面类型：0 普通页面，1 表单页面 |
| data[].status | Integer | 0 | 页面状态 |
示例
请求示例
curl --request POST \
--url "https://www.shudacloud.com/api/open-api/platform/forms/query" \
--header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022" \
--header "Content-Type: application/json" \
--data '{
"appCode": "cd5151d248b24b1cac453a423648cb4f"
}'
正常返回示例
{
"code": 0,
"msg": "",
"data": [
{
"id": "f4a44060bf7ee14e47410f6fbc3e7403",
"code": "fbafb18922b94dc2ad43325d29b6ab6e",
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"name": "未命名的表单",
"menuType": 0,
"type": 1,
"status": 0,
"sort": 4,
"createTime": 1784532387854
},
{
"id": "e7bb1be47e3b4445b3e65df8849bb126",
"code": "eff5cd1ca8b5494e820eebd56e8023c6",
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"name": "待我处理",
"menuType": 0,
"type": 0,
"status": 0,
"sort": 0,
"createTime": 1784532582040
},
{
"id": "db5b7f891d3b4d5da3c51256a58c5db1",
"code": "8d71fa27bc274d26bb7b9195408b4e39",
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"name": "我发起的",
"menuType": 0,
"type": 0,
"status": 0,
"sort": 1,
"createTime": 1784532582347
},
{
"id": "b1fd56e1c30544eeb7435fc6ad78b9b7",
"code": "56aec0b22aac4593a9c8a47bdb815a50",
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"name": "我处理的",
"menuType": 0,
"type": 0,
"status": 0,
"sort": 2,
"createTime": 1784532582373
},
{
"id": "c8a2b695798a4d5bbca93f5628bfcea8",
"code": "d3c28dde62554bec8b6363d5861356df",
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"name": "抄送我的",
"menuType": 0,
"type": 0,
"status": 0,
"sort": 3,
"createTime": 1784532582392
},
{
"id": "84daee010d67b607b37e8e3e289b6579",
"code": "8bfa18226c5f4c398da5516524559d05",
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"name": "代理审批",
"menuType": 0,
"type": 1,
"status": 0,
"sort": 5,
"createTime": 1784533948047
}
]
}
常见异常
| 业务状态码 | 说明 |
|---|---|
| 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判断调用是否成功。
