Skip to content

表单组件类型总览

本文档统一说明 OpenAPI V2 中常见 field_type 的名称、分类、共性语义与命名约定。

如果你需要看:

如何使用这页

  • 先在本页确认 field_type 属于哪一类组件、它的基础语义是什么
  • 需要看字段配置时,跳转到 forms/getTemplate 查看 settings
  • 需要看记录返回值时,跳转到 record/getRecord 查看 field_value

通用约定

命名约定

约定说明
ocr_*OCR 识别类字段族,如 ocr_id_cardocr_business_licenseocr_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_*,避免文档频繁因枚举补漏而漂移