表单组件类型总览
本文档统一说明 OpenAPI V2 中常见 field_type 的名称、分类、共性语义与命名约定。
如果你需要看:
如何使用这页
- 先在本页确认
field_type属于哪一类组件、它的基础语义是什么 - 需要看字段配置时,跳转到
forms/getTemplate查看settings - 需要看记录返回值时,跳转到
record/getRecord查看field_value
通用约定
命名约定
| 约定 | 说明 |
|---|---|
ocr_* | OCR 识别类字段族,如 ocr_id_card、ocr_business_license、ocr_electric_meter |
语义约定
| 类别 | 共性语义 |
|---|---|
| 身份信息 | 承载人员身份或标识信息 |
| 选择类 | 通过候选项选择结果 |
| 文本类 | 输入或展示纯文本内容 |
| 数值类 | 表达数字及其单位、范围等约束 |
| 时间类 | 表达日期或时间 |
| 复合类 | 由多项子结构组合而成,如检查项、矩阵、级联选择 |
| 地址类 | 表达定位地址或行政区划地址 |
| 媒体类 | 表达图片、音频、视频、文件或签名等媒体内容 |
| 展示类 | 用于说明或提示,不直接采集业务值 |
| OCR 类 | 表达图像识别结果及其识别项 |
补充约定:
- 对于业务含义特殊但值结构仍为字符串的字段,优先按实际
field_type处理,不额外引入新的分类名。
组件类型速查
field_type | 类别 | 基础语义 |
|---|---|---|
name | 身份信息 | 填写人姓名 |
tel | 身份信息 | 填写人手机号 |
recorder | 身份信息 | 填表人微信名 |
identity | 身份信息 | 身份证号 |
job_number | 身份信息 | 工号 |
sex | 选择类 | 性别 |
radio | 选择类 | 单选 |
checkbox | 选择类 | 多选 |
text | 文本类 | 单行文本 |
textarea | 文本类 | 多行文本 |
number | 数值类 | 数字 |
date | 时间类 | 日期 |
time | 时间类 | 时间 |
checklist | 复合类 | 检查清单 |
matrix | 复合类 | 固定行矩阵 |
dynamic_matrix | 复合类 | 动态行矩阵 |
chained_selects | 复合类 | 级联选择 |
address | 地址类 | 定位地址 |
owner_address | 地址类 | 手动填写地址 |
customer_name | 文本类 | 自定义姓名 |
customer_mobile | 文本类 | 自定义手机号 |
customer_number | 文本类 | 自定义编号 |
carnumber | 文本类 | 车牌号 |
signature | 媒体类 | 手写签名 |
image | 媒体类 | 图片 |
audio | 媒体类 | 录音 |
video | 媒体类 | 视频 |
file | 媒体类 | 文件 |
description | 展示类 | 说明文字 |
ocr_* | OCR 类 | OCR 识别字段族 |
两类 API 的分工
forms/getTemplate
在 获取表单结构 中,field_type 主要用于说明:
- 字段是什么类型
- 该类型在
settings中有哪些配置项 - 某个组件在渲染和校验时应如何解释
record/getRecord
在 获取单条记录 中,field_type 主要用于说明:
- 字段值会以什么结构出现在
field_value - 接入侧应如何解析不同类型的记录值
- 哪些类型会返回对象、数组、文本或媒体结构
维护建议
- 新增组件类型时,优先先更新本页的“命名与分类”
- 若组件新增的是配置能力,重点补充
forms/getTemplate - 若组件新增的是返回值能力,重点补充
record/getRecord - 对于组件族,优先使用族级命名,如
ocr_*,避免文档频繁因枚举补漏而漂移