查询表单详情
查询表单详情
获取指定表单的完整设计结构,返回扁平化题目模型、主题配色、全局设置与逻辑规则配置。
接口基本信息
- 接口路径:
/open/v2/form/detail - 请求方法:
GET - 认证方式:HTTP Basic Auth (
Authorization: Basic <base64(appId:appSecret)>) - 数据格式:
application/json
请求参数 (Query Parameters)
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 示例 |
|---|---|---|---|---|---|
formKey |
String | 是 | - | 表单全局唯一标识 Key(8位字符) | "ICGqvdBR" |
请求调用示例
1. HTTP 报文请求
GET /tduck-api/open/v2/form/detail?formKey=ICGqvdBR HTTP/1.1
Host: api.example.com
Authorization: Basic R1JzMHc5QXl6ZjVjV2dUYzpha3ZETlFSamVqVFdEZWxmOFRPTUVRTVcyMTFDM2Zqaw==
2. cURL 命令行示例
curl -X GET "https://api.example.com/tduck-api/open/v2/form/detail?formKey=ICGqvdBR" \
-H "Authorization: Basic R1JzMHc5QXl6ZjVjV2dUYzpha3ZETlFSamVqVFdEZWxmOFRPTUVRTVcyMTFDM2Zqaw=="
响应参数说明 (Response Body)
| 字段名 | 类型 | 说明 |
|---|---|---|
code |
Integer | 状态码(200 表示成功) |
msg |
String | 提示信息 |
data |
Object | 表单详情对象(FormDetailV2VO) |
├─ formKey |
String | 表单唯一标识 Key |
├─ name |
String | 表单名称 |
├─ description |
String | 表单描述或填报须知 |
├─ type |
String | 表单类型:ORDINARY (普通表单), EXAM (在线考试) |
├─ status |
String | 收集状态:RELEASE (正在收集), STOP (已停止) |
├─ folderId |
Long | 所属文件夹 ID |
├─ items |
Array<Object> | 扁平化题目定义列表(List<FormItemV2VO>) |
│ ├─ id |
String | 自定义题目 ID(如 q_name) |
│ ├─ type |
String | 题型代码(如 INPUT, RADIO, CHECKBOX) |
│ ├─ label |
String | 题目标题 |
│ ├─ required |
Boolean | 是否必填 |
│ ├─ placeholder |
String | 输入占位提示 |
│ ├─ sort |
Integer | 题目显示序号 |
│ ├─ options |
Array | 选项列表(选择题组件返回) |
│ └─ exam |
Object | 考试题目属性(分值、标准答案、解析等) |
├─ theme |
Object | 主题外观配置对象(配色、背景、Logo等) |
├─ setting |
Object | 表单全局设置对象(权限、频次限制等) |
├─ logic |
Object | 逻辑规则配置对象 |
├─ createTime |
String | 表单创建时间戳 |
└─ updateTime |
String | 表单最后修改时间戳 |
响应示例
成功响应 (HTTP 200)
{
"code": 200,
"msg": "操作成功",
"data": {
"formKey": "ICGqvdBR",
"name": "2026年全球云计算大会参会报名表",
"description": "欢迎各位技术专家与从业者报名参会,请认真填写真实信息。",
"type": "ORDINARY",
"status": "RELEASE",
"folderId": 0,
"items": [
{
"id": "q_name",
"type": "INPUT",
"label": "参会人员真实姓名",
"required": true,
"placeholder": "请输入您的姓名",
"sort": 1
},
{
"id": "q_gender",
"type": "RADIO",
"label": "性别",
"required": true,
"options": [
{"label": "男", "value": "男"},
{"label": "女", "value": "女"}
],
"sort": 2
},
{
"id": "q_interests",
"type": "CHECKBOX",
"label": "感兴趣的专题方向",
"required": true,
"options": [
{"label": "AI 大模型", "value": "AI 大模型"},
{"label": "云原生架构", "value": "云原生架构"}
],
"sort": 3
}
],
"theme": {
"themeColor": "#1890ff",
"backgroundColor": "#f0f2f5",
"submitBtnText": "确认提交报名"
},
"setting": {
"submitPromptText": "感谢您的提交!",
"ipWriteCountLimitStatus": true,
"ipWriteCountLimit": 3
},
"createTime": "2026-08-18 10:00:00",
"updateTime": "2026-08-20 09:30:00"
}
}
错误响应 (HTTP 400 表单 Key 为空)
{
"code": 400,
"msg": "formKey 不能为空",
"data": null
}
官方文档·
约 7 分钟阅读 (2536 字)
最后更新于 2026-08-20 09:48:29
这篇文章对您有帮助吗?
您的反馈将帮助我们不断改进平台技术文档质量