表单字段查询
更新时间：2026.07.21 10:41
功能说明
查询指定表单页面的字段定义。返回的字段 name 用于表单数据查询、新增和修改。
调用说明
地址：
https://www.shudacloud.com/api/open-api/platform/form-fields/query
方式：POST
接口编码：form-fields: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 | 表单页面编码 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | Integer | 0 | 业务状态码，0 表示成功 |
| msg | String | 空字符串 | 业务提示信息 |
| data | Array | 见返回示例 | 字段列表 |
| data[].code | String | ea3515906fbf418bbe4e2464f7dc24e8 | 字段编码 |
| data[].name | String | form-d2oB | 字段名，读写数据时作为 data 的键 |
| data[].label | String | 单行文本 | 字段标签 |
| data[].type | String | text | 字段类型 |
| data[].config | Object | 见返回示例 | 字段配置 |
示例
请求示例
curl --request POST \
--url "https://www.shudacloud.com/api/open-api/platform/form-fields/query" \
--header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022" \
--header "Content-Type: application/json" \
--data '{
"appCode": "cd5151d248b24b1cac453a423648cb4f",
"pageCode": "fbafb18922b94dc2ad43325d29b6ab6e"
}'
正常返回示例
{
"code": 0,
"msg": "",
"data": [
{
"code": "ea3515906fbf418bbe4e2464f7dc24e8",
"name": "form-d2oB",
"label": "单行文本",
"type": "text",
"config": {
"id": "form-d2oB",
"code": "ea3515906fbf418bbe4e2464f7dc24e8",
"name": "form-d2oB",
"type": "text",
"label": "单行文本",
"props": {
"maxlength": 0,
"placeholder": "请输入文本",
"defaultValue": {
"customValue": "",
"defaultValueType": "1"
}
},
"component": "Input"
}
}
]
}
常见异常
| 业务状态码 | 说明 |
|---|---|
| 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判断调用是否成功。
