表单字段查询接口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"
}

响应内容：

只要每一个表单字段不删除，字段 ID 就不会变化：

参数	含义
widgets	字段信息
widgets[].label	字段标题
widgets[].name	字段名（设置了字段别名则采用别名，未设置则采用字段ID）
widgets[].type	字段类型；每种字段类型都有对应的数据类型
widgets[].items	仅子表单控件有；数组里包含了每个子字段的信息
sysWidgets	系统字段列表（扩展字段、流程字段受功能开关影响，微信增强一旦开启会始终返回）
sysWidgets[].name	系统字段名称
dataModifyTime	表单内数据最新修改时间（可用于判断表单内的数据是否发生变更）

响应示例：

{
    "widgets": [
        {
            "name": "_widget_1529400746031",
            "label": "单行文本",
            "type": "text"
        },
        {
            "name": "_widget_1529400746045",
            "label": "多行文本",
            "type": "textarea"
        },
        {
            "name": "_widget_1529400746056",
            "label": "数字",
            "type": "number"
        },
        {
            "name": "_widget_1529400746068",
            "label": "日期",
            "type": "datetime"
        },
        {
            "name": "_widget_1529400746079",
            "label": "日期时间",
            "type": "datetime"
        },
        {
            "name": "_widget_1529400746090",
            "label": "单选按钮组",
            "type": "radiogroup"
        },
        {
            "name": "_widget_1529400746105",
            "label": "复选框组",
            "type": "checkboxgroup"
        },
        {
            "name": "_widget_1529400746119",
            "label": "下拉框",
            "type": "combo"
        },
        {
            "name": "_widget_1529400746136",
            "label": "下拉复选框",
            "type": "combocheck"
        },
        {
            "name": "_widget_1529400746157",
            "label": "地址",
            "type": "address"
        },
        {
            "name": "_widget_1529400746173",
            "label": "定位",
            "type": "location"
        },
        {
            "name": "_widget_1529400746191",
            "label": "图片",
            "type": "image"
        },
        {
            "name": "_widget_1529400746209",
            "label": "附件",
            "type": "upload"
        },
        {
            "name": "_widget_1529400746221",
            "label": "子表单",
            "type": "subform",
            "items": [
                // 同主表
            ]
        },
        {
            "name": "_widget_1529400746242",
            "label": "关联数据",
            "type": "linkdata"
        },
        {
            "name": "_widget_1529400746254",
            "label": "手写签名",
            "type": "signature"
        },
        {
            "name": "_widget_1529400746696",
            "label": "成员单选",
            "type": "user"
        },
        {
            "name": "_widget_1529400746713",
            "label": "成员多选",
            "type": "usergroup"
        },
        {
            "name": "_widget_1529400746729",
            "label": "部门单选",
            "type": "dept"
        },
        {
            "name": "_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"
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

app_id

string

应用ID

必需

entry_id

string

表单ID

必需

示例

{
    "app_id": "59264073a2a60c0c08e20bfb",
    "entry_id": "59264073a2a60c0c08e20bfd"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

widgets

array [object {4}]

字段信息

必需

name

string

字段标题

必需

label

string

必需

字段名（设置了字段别名则采用别名，未设置则采用字段ID）

type

string

必需

字段类型；每种字段类型都有对应的数据类型

items

array [object {4}]

可选

仅子表单控件有；数组里包含了每个子字段的信息

sysWidgets

array [object {1}]

必需

系统字段列表（扩展字段、流程字段受功能开关影响，微信增强一旦开启会始终返回）

name

string

必需

系统字段列表（扩展字段、流程字段受功能开关影响，微信增强一旦开启会始终返回）

dataModifyTime

string

可选

表单内数据最新修改时间（可用于判断表单内的数据是否发生变更）

示例

{
    "widgets": [
        {
            "name": "_widget_1529400746031",
            "label": "单行文本",
            "type": "text"
        },
        {
            "name": "_widget_1529400746045",
            "label": "多行文本",
            "type": "textarea"
        },
        {
            "name": "_widget_1529400746056",
            "label": "数字",
            "type": "number"
        },
        {
            "name": "_widget_1529400746068",
            "label": "日期",
            "type": "datetime"
        },
        {
            "name": "_widget_1529400746079",
            "label": "日期时间",
            "type": "datetime"
        },
        {
            "name": "_widget_1529400746090",
            "label": "单选按钮组",
            "type": "radiogroup"
        },
        {
            "name": "_widget_1529400746105",
            "label": "复选框组",
            "type": "checkboxgroup"
        },
        {
            "name": "_widget_1529400746119",
            "label": "下拉框",
            "type": "combo"
        },
        {
            "name": "_widget_1529400746136",
            "label": "下拉复选框",
            "type": "combocheck"
        },
        {
            "name": "_widget_1529400746157",
            "label": "地址",
            "type": "address"
        },
        {
            "name": "_widget_1529400746173",
            "label": "定位",
            "type": "location"
        },
        {
            "name": "_widget_1529400746191",
            "label": "图片",
            "type": "image"
        },
        {
            "name": "_widget_1529400746209",
            "label": "附件",
            "type": "upload"
        },
        {
            "name": "_widget_1529400746221",
            "label": "子表单",
            "type": "subform",
            "items": [
                // 同主表
            ]
        },
        {
            "name": "_widget_1529400746242",
            "label": "关联数据",
            "type": "linkdata"
        },
        {
            "name": "_widget_1529400746254",
            "label": "手写签名",
            "type": "signature"
        },
        {
            "name": "_widget_1529400746696",
            "label": "成员单选",
            "type": "user"
        },
        {
            "name": "_widget_1529400746713",
            "label": "成员多选",
            "type": "usergroup"
        },
        {
            "name": "_widget_1529400746729",
            "label": "部门单选",
            "type": "dept"
        },
        {
            "name": "_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"
}

表单字段查询接口V5