表单接口调试
1. 简介
1.1 接口简介
表单接口包括：
- 表单字段查询接口V1
- 表单字段查询接口V2
- 表单字段查询接口V5
开发前，请仔细阅读 开发指南。
以下所有接口路径中的 app_id 和 entry_id 分别表示应用 ID 和该应用内的表单 ID，因此 app_id+entry_id 表示全局唯一的表单 ID，可以前往开放平台内的 API 文档进行查看。
1.2 接口版本
接口版本 | 更新时间 | 版本说明 |
v1 | 2021.6.1 | 原始接口 |
v2 | 2021.10.26 | V2 在 V1 的基础之上新增了系统字段及表单数据修改时间的获取。 |
v5 | 2022.10.28 | 在 v1 的基础上，接口调用频率由 5 次/秒提升至 30 次/秒； 参数 app_id 和 entry_id 放入 body，接口路由修改为 POST app/entry/widget/list。 |
2. 接口调用
2.1 表单字段查询接口V5
获取指定表单的字段/字段信息，除分割线字段和查询字段以外。具体可以查阅文档最后的 字段与数据类型对照表。
请求地址：https://api.jiandaoyun.com/api/v5/app/entry/widget/list
请求频率：30 次/秒
请求参数：
参数 | 类型 | 必需 | 说明 |
app_id | String | 是 | 应用ID |
entry_id | String | 是 | 表单ID |
{
"app_id": "59264073a2a60c0c08e20bfb",
"entry_id": "59264073a2a60c0c08e20bfd"
}注：响应参数同「表单字段查询接口v2 」，此处不在赘述。
2.2 表单字段查询接口V2
获取指定表单的字段/字段信息，除分割线字段和查询字段以外。具体可以查阅文档最后的 字段与数据类型对照表。
请求地址：https://api.jiandaoyun.com/api/v2/app/{app_id}/entry/{entry_id}/widgets
请求频率：5 次/秒
请求方式：POST
请求参数：
无
响应内容：
只要每一个表单字段不删除，字段 ID 就不会变化：
参数 | 含义 |
widgets | 字段信息 |
widgets[].label | 字段标题 |
widgets[].name | 字段名（设置了字段别名则采用别名，未设置则采用字段ID） |
widgets[].widgetName | 字段 ID |
widgets[].type | 字段类型；每种字段类型都有对应的数据类型 |
widgets[].items | 仅子表单控件有；数组里包含了每个子字段的信息 |
sysWidgets | 系统字段列表（扩展字段、流程字段受功能开关影响，微信增强一旦开启会始终返回） |
sysWidgets[].name | 系统字段名称 |
dataModifyTime | 表单内数据最新修改时间（可用于判断表单内的数据是否发生变更） |
响应示例：
{
"widgets": [
{
"name": "_widget_1529400746031",
"widgetName": "_widget_1529400746031",
"label": "单行文本",
"type": "text"
},
{
"name": "_widget_1529400746045",
"widgetName": "_widget_1529400746045",
"label": "多行文本",
"type": "textarea"
},
{
"name": "_widget_1529400746056",
"widgetName": "_widget_1529400746056",
"label": "数字",
"type": "number"
},
{
"name": "_widget_1529400746068",
"widgetName": "_widget_1529400746068",
"label": "日期",
"type": "datetime"
},
{
"name": "_widget_1529400746079",
"widgetName": "_widget_1529400746079",
"label": "日期时间",
"type": "datetime"
},
{
"name": "_widget_1529400746090",
"widgetName": "_widget_1529400746090",
"label": "单选按钮组",
"type": "radiogroup"
},
{
"name": "_widget_1529400746105",
"widgetName": "_widget_1529400746105",
"label": "复选框组",
"type": "checkboxgroup"
},
{
"name": "_widget_1529400746119",
"widgetName": "_widget_1529400746119",
"label": "下拉框",
"type": "combo"
},
{
"name": "_widget_1529400746136",
"widgetName": "_widget_1529400746136",
"label": "下拉复选框",
"type": "combocheck"
},
{
"name": "_widget_1529400746157",
"widgetName": "_widget_1529400746157",
"label": "地址",
"type": "address"
},
{
"name": "_widget_1529400746173",
"widgetName": "_widget_1529400746173",
"label": "定位",
"type": "location"
},
{
"name": "_widget_1529400746191",
"widgetName": "_widget_1529400746191",
"label": "图片",
"type": "image"
},
{
"name": "_widget_1529400746209",
"widgetName": "_widget_1529400746209",
"label": "附件",
"type": "upload"
},
{
"name": "_widget_1529400746221",
"widgetName": "_widget_1529400746221",
"label": "子表单",
"type": "subform",
"items": [
// 同主表
]
},
{
"name": "_widget_1529400746242",
"widgetName": "_widget_1529400746242",
"label": "关联数据",
"type": "linkdata"
},
{
"name": "_widget_1529400746254",
"widgetName": "_widget_1529400746254",
"label": "手写签名",
"type": "signature"
},
{
"name": "_widget_1529400746696",
"widgetName": "_widget_1529400746696",
"label": "成员单选",
"type": "user"
},
{
"name": "_widget_1529400746713",
"widgetName": "_widget_1529400746713",
"label": "成员多选",
"type": "usergroup"
},
{
"name": "_widget_1529400746729",
"widgetName": "_widget_1529400746729",
"label": "部门单选",
"type": "dept"
},
{
"name": "_widget_1529400746746",
"widgetName": "_widget_1529400746746",
"label": "部门多选",
"type": "deptgroup"
}
],
"sysWidgets": [
{
"name": "flowState"
},
{
"name": "wx_open_id"
},
{
"name": "wx_nickname"
},
{
"name": "wx_gender"
},
{
"name": "creator"
},
{
"name": "updater"
},
{
"name": "deleter"
},
{
"name": "ext"
},
{
"name": "createTime"
},
{
"name": "updateTime"
},
{
"name": "deleteTime"
}
],
"dataModifyTime": "2021-09-08T03:40:26.586Z"
}2.3 表单字段查询接口V1
获取指定表单的字段/字段信息，除分割线字段和查询字段以外。具体可以查阅文档中 字段与数据类型对照表。
请求地址：https://api.jiandaoyun.com/api/v1/app/{app_id}/entry/{entry_id}/widgets
请求频率：5 次/秒
请求方式：POST
请求参数：
无
响应内容：
参数 | 含义 |
widgets | 字段信息 |
widgets[].label | 字段标题 |
widgets[].name | 字段名（设置了字段别名则采用别名，未设置则采用字段 ID） |
widgets[].widgetName | 字段 ID |
widgets[].type | 字段类型；每种字段类型都有对应的数据类型 |
widgets[].items | 仅子表单字段有；数组里包含了每个子字段的信息 |
响应示例：
{
"widgets": [
{
"name": "_widget_1529400746031",
"widgetName": "_widget_1529400746031",
"label": "单行文本",
"type": "text"
},
{
"name": "_widget_1529400746045",
"widgetName": "_widget_1529400746045",
"label": "多行文本",
"type": "textarea"
},
{
"name": "_widget_1529400746056",
"widgetName": "_widget_1529400746056",
"label": "数字",
"type": "number"
},
{
"name": "_widget_1529400746068",
"widgetName": "_widget_1529400746068",
"label": "日期",
"type": "datetime"
},
{
"name": "_widget_1529400746221",
"widgetName": "_widget_1529400746221",
"label": "子表单",
"type": "subform",
"items": [
{
"name": "_widget_1529400746259",
"widgetName": "_widget_1529400746259",
"label": "手写签名",
"type": "signature"
},{
"name": "_widget_1529400746077",
"widgetName": "_widget_1529400746077",
"label": "日期",
"type": "datetime"
}
]
}
]
}
400-111-0890
在线咨询