Form component types overview

This page summarizes common field_type values in OpenAPI V2: names, categories, baseline semantics, and naming conventions.

If you need:

• Configuration shape: see Get form template
• Record value shape: see Get a single record

How to use this page

• Start here to see which component family a field_type belongs to and what it means.
• For field configuration, go to forms/getTemplate and inspect settings.
• For values returned on a record, go to record/getRecord and inspect field_value.

General conventions

Naming conventions

Convention	Meaning
ocr_*	OCR-related field family, e.g. ocr_id_card, ocr_business_license, ocr_electric_meter

Semantic families

Category	Shared meaning
Identity	Person identity or identifier information
Choice	Pick one or more options from candidates
Text	Plain text input or display
Numeric	Numbers with units, ranges, etc.
Date/time	Dates or times
Composite	Structures composed of sub-parts, e.g. checklists, matrices, cascaded selects
Address	Located addresses or administrative divisions
Media	Images, audio, video, files, signatures, etc.
Display	Hints or descriptions; not a primary business value
OCR	Recognition output and recognition items

Additional notes:

• If a field has special business meaning but the value is still fundamentally a string, treat it by its actual field_type; do not invent extra category names.

Quick reference

field_type	Category	Baseline meaning
name	Identity	Submitter name
tel	Identity	Submitter phone
recorder	Identity	Submitter WeChat display name
identity	Identity	ID card number
job_number	Identity	Employee ID
sex	Choice	Gender
radio	Choice	Single choice
checkbox	Choice	Multiple choice
text	Text	Single-line text
textarea	Text	Multi-line text
number	Numeric	Number
date	Date/time	Date
time	Date/time	Time
checklist	Composite	Checklist
matrix	Composite	Fixed-row matrix
dynamic_matrix	Composite	Dynamic-row matrix
chained_selects	Composite	Cascaded select
address	Address	Located address
owner_address	Address	Manually entered address
customer_name	Text	Custom name
customer_mobile	Text	Custom mobile
customer_number	Text	Custom number
carnumber	Text	License plate
signature	Media	Handwritten signature
image	Media	Image
audio	Media	Audio
video	Media	Video
file	Media	File
description	Display	Descriptive text
ocr_*	OCR	OCR field family

How the two APIs split work

forms/getTemplate

In Get form template, field_type mainly tells you:

• What kind of field it is
• Which settings appear under settings for that type
• How to interpret the field for rendering and validation

record/getRecord

In Get a single record, field_type mainly tells you:

• What structure field_value will have
• How clients should parse different value shapes
• Which types return objects, arrays, text, or media structures

Maintenance notes

• When adding a component type, update naming and categorization on this page first.
• If the change is mostly configuration, emphasize forms/getTemplate.
• If the change is mostly return values, emphasize record/getRecord.
• For families of components, prefer family-level names like ocr_* so the doc does not drift with long enums.