Get form template

Returns the full form definition for a template ID (tpl_id): render forms, validate input, build submission flows, or sync structure on your side.

This page focuses on response structure and integration notes; full schemas and demos are in the companion folder. Examples are sanitized or synthetic.

Request example

Python + requestscurl

python

import requests

url = 'https://open.cli.im/api/v2/rpc/forms/getTemplate'
data = {
    'tpl_id': 122507
}
headers = {
    'Authorization': 'Bearer <your API Key>',
    'Content-Type': 'application/json'
}
response = requests.post(url, json=data, headers=headers)
print(response.text)

bash

curl -X POST 'https://open.cli.im/api/v2/rpc/forms/getTemplate' \
  -H 'Authorization: Bearer <your API Key>' \
  -H 'Content-Type: application/json' \
  -d '{"tpl_id": 122507}'

Request parameters

Parameter	Type	Required	Description
`tpl_id`	integer	Yes	Form template ID

Response overview

response.schema.json (full API response schema)

json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "response.schema.json",
  "title": "forms/getTemplate response schema",
  "description": "`forms/getTemplate` 的完整响应结构，包含成功响应与错误响应。",
  "oneOf": [
    {
      "$ref": "#/$defs/SuccessResponse"
    },
    {
      "$ref": "#/$defs/ErrorResponse"
    }
  ],
  "$defs": {
    "SuccessResponse": {
      "type": "object",
      "required": [
        "code",
        "message",
        "data"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "const": 0
        },
        "message": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {
              "$ref": "content-json.schema.json"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "ErrorResponse": {
      "type": "object",
      "required": [
        "code",
        "error_code",
        "message",
        "message_detail"
      ],
      "properties": {
        "code": {
          "type": "integer"
        },
        "error_code": {
          "type": "integer"
        },
        "message": {
          "type": "string"
        },
        "message_detail": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  }
}

Path	Type	Description
`code`	integer	Platform code; `0` success
`message`	string	Message
`data`	object	Wrapper
`data.data`	object	Form structure body

Wrapper example:

json

{
  "data": { "...": "..." }
}

`data.data` structure

data.data is the form object. Full payload schema and examples are in the collapsible sections below.

content-json.schema.json (payload schema)

json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "content-json.schema.json",
  "title": "forms/getTemplate content schema",
  "description": "`forms/getTemplate` 在 `data.data` 下返回的表单结构对象定义。",
  "type": "object",
  "required": [
    "form",
    "org",
    "project",
    "groups",
    "audit_config",
    "process_status_config",
    "rules"
  ],
  "properties": {
    "form": {
      "$ref": "#/$defs/Form"
    },
    "org": {
      "$ref": "#/$defs/IdObject"
    },
    "project": {
      "$ref": "#/$defs/IdObject"
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Group"
      }
    },
    "audit_config": {
      "$ref": "#/$defs/AuditConfig"
    },
    "process_status_config": {
      "$ref": "#/$defs/ProcessStatusConfig"
    },
    "rules": {
      "$ref": "#/$defs/Rules"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "IdObject": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "Form": {
      "type": "object",
      "required": [
        "id",
        "name",
        "type",
        "type_text",
        "number",
        "description",
        "submit_button_title",
        "created_at_iso",
        "updated_at_iso"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "integer",
          "enum": [
            0,
            1,
            2,
            3,
            7,
            12,
            13,
            21,
            22
          ]
        },
        "type_text": {
          "type": "string"
        },
        "number": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "submit_button_title": {
          "type": "string"
        },
        "created_at_iso": {
          "type": "string"
        },
        "updated_at_iso": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "Group": {
      "type": "object",
      "required": [
        "group_id",
        "group_title",
        "show_group_title",
        "is_page_break_group",
        "fields"
      ],
      "properties": {
        "group_id": {
          "type": "integer"
        },
        "group_title": {
          "type": "string"
        },
        "show_group_title": {
          "type": "boolean"
        },
        "is_page_break_group": {
          "type": "boolean"
        },
        "fields": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Field"
          }
        }
      },
      "additionalProperties": false
    },
    "Field": {
      "type": "object",
      "required": [
        "field_id",
        "field_title",
        "field_desc",
        "field_type",
        "field_short_name",
        "group_id",
        "settings"
      ],
      "properties": {
        "field_id": {
          "type": "integer"
        },
        "field_title": {
          "type": "string"
        },
        "field_desc": {
          "type": "string"
        },
        "field_type": {
          "type": "string",
          "description": "字段类型。固定类型使用枚举；OCR 类字段统一匹配 `ocr_*`。",
          "anyOf": [
            {
              "enum": [
                "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"
              ]
            },
            {
              "pattern": "^ocr_"
            }
          ]
        },
        "field_short_name": {
          "type": "string"
        },
        "group_id": {
          "type": "integer"
        },
        "settings": {
          "$ref": "#/$defs/FieldSettings"
        }
      },
      "additionalProperties": false
    },
    "FieldSettings": {
      "type": "object",
      "required": [
        "is_required",
        "is_hidden",
        "is_result",
        "is_masked",
        "is_unique",
        "is_highlight"
      ],
      "properties": {
        "is_required": {
          "type": "boolean"
        },
        "is_hidden": {
          "type": "boolean"
        },
        "is_result": {
          "type": "boolean"
        },
        "is_masked": {
          "type": "boolean"
        },
        "is_unique": {
          "type": "boolean"
        },
        "is_highlight": {
          "type": "boolean"
        },
        "format": {
          "type": "string"
        },
        "default_to_current": {
          "type": "boolean"
        },
        "unit": {
          "type": "string"
        },
        "unit_enabled": {
          "type": "boolean"
        },
        "range": {
          "$ref": "#/$defs/NumberRange"
        },
        "allow_negative": {
          "type": "boolean"
        },
        "options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OptionItem"
          }
        },
        "is_allow_entry_desc": {
          "type": "boolean"
        },
        "checklist_items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChecklistItem"
          }
        },
        "checklist_result_options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChecklistResultOption"
          }
        },
        "columns": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MatrixColumn"
          }
        },
        "chained_options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChainedOption"
          }
        },
        "ocr_items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OcrItem"
          }
        },
        "description_html": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "NumberRange": {
      "type": "object",
      "required": [
        "minimum",
        "maximum"
      ],
      "properties": {
        "minimum": {
          "type": [
            "number",
            "null"
          ]
        },
        "maximum": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "OptionItem": {
      "type": "object",
      "required": [
        "option_text",
        "is_custom"
      ],
      "properties": {
        "option_id": {
          "type": "integer"
        },
        "option_uuid": {
          "type": "string"
        },
        "option_text": {
          "type": "string"
        },
        "is_custom": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "anyOf": [
        {
          "required": [
            "option_id"
          ]
        },
        {
          "required": [
            "option_uuid"
          ]
        }
      ]
    },
    "ChecklistItem": {
      "type": "object",
      "required": [
        "item_id",
        "item_title"
      ],
      "properties": {
        "item_id": {
          "type": "integer"
        },
        "item_title": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ChecklistResultOption": {
      "type": "object",
      "required": [
        "option_id",
        "option_value",
        "option_text"
      ],
      "properties": {
        "option_id": {
          "type": "integer"
        },
        "option_value": {
          "type": "string"
        },
        "option_text": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "MatrixColumn": {
      "type": "object",
      "required": [
        "column_id",
        "column_title",
        "column_type"
      ],
      "properties": {
        "column_id": {
          "type": "integer"
        },
        "column_title": {
          "type": "string"
        },
        "column_type": {
          "type": "string"
        },
        "format": {
          "type": "string"
        },
        "options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OptionItem"
          }
        }
      },
      "additionalProperties": false
    },
    "ChainedOption": {
      "type": "object",
      "required": [
        "option_id",
        "option_text",
        "level",
        "children"
      ],
      "properties": {
        "option_id": {
          "type": "integer"
        },
        "option_text": {
          "type": "string"
        },
        "level": {
          "type": "integer"
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChainedOption"
          }
        }
      },
      "additionalProperties": false
    },
    "OcrItem": {
      "type": "object",
      "required": [
        "item_id",
        "item_title",
        "unit",
        "unit_enabled"
      ],
      "properties": {
        "item_id": {
          "type": "integer"
        },
        "item_title": {
          "type": "string"
        },
        "unit": {
          "type": "string"
        },
        "unit_enabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "AuditConfig": {
      "type": "object",
      "required": [
        "enabled",
        "stages"
      ],
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "stages": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AuditStage"
          }
        }
      },
      "additionalProperties": false
    },
    "AuditStage": {
      "type": "object",
      "required": [
        "id",
        "title",
        "level"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "title": {
          "type": "string"
        },
        "level": {
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "ProcessStatusConfig": {
      "type": "object",
      "required": [
        "enabled",
        "options"
      ],
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ProcessStatusOption"
          }
        }
      },
      "additionalProperties": false
    },
    "ProcessStatusOption": {
      "type": "object",
      "required": [
        "text",
        "color"
      ],
      "properties": {
        "text": {
          "type": "string"
        },
        "color": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "Rules": {
      "type": "object",
      "required": [
        "time_limit_record",
        "tpl_limit_record",
        "owner_tpl_limit_record"
      ],
      "properties": {
        "time_limit_record": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TimeLimitItem"
          }
        },
        "tpl_limit_record": {
          "type": [
            "object",
            "null"
          ],
          "allOf": [
            {
              "if": {
                "type": "object"
              },
              "then": {
                "$ref": "#/$defs/RecordLimit"
              }
            }
          ]
        },
        "owner_tpl_limit_record": {
          "type": [
            "object",
            "null"
          ],
          "allOf": [
            {
              "if": {
                "type": "object"
              },
              "then": {
                "$ref": "#/$defs/RecordLimit"
              }
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "TimeLimitItem": {
      "type": "object",
      "required": [
        "start_time",
        "end_time",
        "time_limit_type"
      ],
      "properties": {
        "start_time": {
          "type": [
            "integer",
            "string"
          ]
        },
        "end_time": {
          "type": [
            "integer",
            "string"
          ]
        },
        "time_limit_type": {
          "type": "integer",
          "enum": [
            0,
            1,
            2
          ]
        }
      },
      "additionalProperties": false
    },
    "RecordLimit": {
      "type": "object",
      "required": [
        "limit_type",
        "custom_type",
        "custom_limit",
        "custom_type_limit"
      ],
      "properties": {
        "limit_type": {
          "type": "integer",
          "enum": [
            0,
            1,
            2
          ]
        },
        "custom_type": {
          "type": "integer",
          "enum": [
            0,
            1,
            2,
            3
          ]
        },
        "custom_limit": {
          "type": "integer"
        },
        "custom_type_limit": {
          "type": "integer"
        }
      },
      "additionalProperties": false
    }
  }
}

Full example

json

{
  "code": 0,
  "message": "ok",
  "data": {
    "data": {
      "form": {
        "id": 122507,
        "name": "设备巡检",
        "type": 0,
        "type_text": "普通表单",
        "number": "D32",
        "description": "请仔细填写表单中的内容",
        "submit_button_title": "提交",
        "created_at_iso": "2026-02-27 10:26:42(UTC+08:00)",
        "updated_at_iso": "2026-03-09 17:13:04(UTC+08:00)"
      },
      "org": {
        "id": 94910252
      },
      "project": {
        "id": 1104
      },
      "groups": [
        {
          "group_id": 71399639089153,
          "group_title": "",
          "show_group_title": false,
          "is_page_break_group": false,
          "fields": [
            {
              "field_id": 71399639089153,
              "field_title": "巡检人姓名",
              "field_desc": "",
              "field_type": "name",
              "field_short_name": "",
              "group_id": 71399639089153,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089154,
              "field_title": "巡检人手机号",
              "field_desc": "",
              "field_type": "tel",
              "field_short_name": "",
              "group_id": 71399639089153,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089155,
              "field_title": "巡检人微信名",
              "field_desc": "",
              "field_type": "recorder",
              "field_short_name": "",
              "group_id": 71399639089153,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089156,
              "field_title": "巡检人身份证号",
              "field_desc": "",
              "field_type": "identity",
              "field_short_name": "",
              "group_id": 71399639089153,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089157,
              "field_title": "巡检人工号",
              "field_desc": "",
              "field_type": "job_number",
              "field_short_name": "",
              "group_id": 71399639089153,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089158,
              "field_title": "巡检人性别",
              "field_desc": "",
              "field_type": "sex",
              "field_short_name": "",
              "group_id": 71399639089153,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "options": [
                  {
                    "option_id": 71399639089192,
                    "option_text": "男",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089193,
                    "option_text": "女",
                    "is_custom": false
                  }
                ]
              }
            }
          ]
        },
        {
          "group_id": 71399639089154,
          "group_title": "巡检人基本信息",
          "show_group_title": true,
          "is_page_break_group": true,
          "fields": []
        },
        {
          "group_id": 72331175133185,
          "group_title": "",
          "show_group_title": false,
          "is_page_break_group": false,
          "fields": [
            {
              "field_id": 71399639089159,
              "field_title": "巡检内容",
              "field_desc": "",
              "field_type": "text",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089160,
              "field_title": "巡检描述",
              "field_desc": "",
              "field_type": "textarea",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089161,
              "field_title": "当前温度",
              "field_desc": "",
              "field_type": "number",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false,
                "unit": "摄氏度",
                "unit_enabled": true,
                "range": {
                  "minimum": -100,
                  "maximum": 200
                },
                "allow_negative": true
              }
            },
            {
              "field_id": 71399639089162,
              "field_title": "巡检次数",
              "field_desc": "",
              "field_type": "number",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false,
                "unit": "",
                "unit_enabled": false,
                "range": {
                  "minimum": null,
                  "maximum": null
                },
                "allow_negative": false
              }
            },
            {
              "field_id": 71399639089163,
              "field_title": "灭火器检查",
              "field_desc": "",
              "field_type": "checklist",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "is_allow_entry_desc": true,
                "checklist_items": [
                  {
                    "item_id": 71399639089266,
                    "item_title": "压力正常"
                  },
                  {
                    "item_id": 71399639089267,
                    "item_title": "外观完好"
                  },
                  {
                    "item_id": 71399639089268,
                    "item_title": "配件齐全"
                  }
                ],
                "checklist_result_options": [
                  {
                    "option_id": 71399639089271,
                    "option_value": "1",
                    "option_text": "正常"
                  },
                  {
                    "option_id": 71399639089272,
                    "option_value": "2",
                    "option_text": "异常"
                  },
                  {
                    "option_id": 71399639089273,
                    "option_value": "3",
                    "option_text": "需要关注"
                  }
                ]
              }
            },
            {
              "field_id": 71399639089164,
              "field_title": "同行人信息",
              "field_desc": "",
              "field_type": "matrix",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false,
                "columns": [
                  {
                    "column_id": 71399639089283,
                    "column_title": "姓名",
                    "column_type": "text"
                  },
                  {
                    "column_id": 71399639089284,
                    "column_title": "手机号",
                    "column_type": "text"
                  },
                  {
                    "column_id": 71399639089285,
                    "column_title": "性别",
                    "column_type": "sex",
                    "options": [
                      {
                        "option_uuid": "25587b8b-485d-4038-a5ab-9bcd7c4af880",
                        "option_text": "男",
                        "is_custom": false
                      },
                      {
                        "option_uuid": "6d190f28-bb05-41c8-aa0f-57553227f0cd",
                        "option_text": "女",
                        "is_custom": false
                      }
                    ]
                  },
                  {
                    "column_id": 71399639089286,
                    "column_title": "身份证",
                    "column_type": "identity"
                  },
                  {
                    "column_id": 71399639089287,
                    "column_title": "年龄",
                    "column_type": "number"
                  },
                  {
                    "column_id": 72326603341946,
                    "column_title": "婚姻状况",
                    "column_type": "radio",
                    "options": [
                      {
                        "option_uuid": "33ac08a2-4d8e-4b9b-885f-378fbb3535dc",
                        "option_text": "已婚",
                        "is_custom": false
                      },
                      {
                        "option_uuid": "f99e79e7-948b-4c18-8bc0-3785c6a778fa",
                        "option_text": "未婚",
                        "is_custom": false
                      },
                      {
                        "option_uuid": "bae11104-9131-43b6-89e8-9bfaebc92450",
                        "option_text": "其他",
                        "is_custom": true
                      }
                    ]
                  }
                ]
              }
            },
            {
              "field_id": 71399639089165,
              "field_title": "检查具体内容项",
              "field_desc": "",
              "field_type": "dynamic_matrix",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false,
                "columns": [
                  {
                    "column_id": 71399639089294,
                    "column_title": "物品名称",
                    "column_type": "text"
                  },
                  {
                    "column_id": 71399639089295,
                    "column_title": "物品厂家地址",
                    "column_type": "owner_address"
                  },
                  {
                    "column_id": 71399639089296,
                    "column_title": "生成日期",
                    "column_type": "date",
                    "format": "YYYY年M月D日"
                  },
                  {
                    "column_id": 72326603341957,
                    "column_title": "单位",
                    "column_type": "radio",
                    "options": [
                      {
                        "option_uuid": "329f1af8-f849-4aee-93fa-974a1bbfb704",
                        "option_text": "个",
                        "is_custom": false
                      },
                      {
                        "option_uuid": "b145e3df-9bef-4690-afe9-f0bae872b5ad",
                        "option_text": "箱",
                        "is_custom": false
                      },
                      {
                        "option_uuid": "87936ac7-fb80-472f-ad4b-1c5ff6a71b8b",
                        "option_text": "其他",
                        "is_custom": true
                      }
                    ]
                  }
                ]
              }
            },
            {
              "field_id": 71399639089166,
              "field_title": "巡检日期",
              "field_desc": "",
              "field_type": "date",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "format": "YYYY年M月D日 HH时mm分",
                "default_to_current": true
              }
            },
            {
              "field_id": 71399639089167,
              "field_title": "巡检时间",
              "field_desc": "",
              "field_type": "time",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "format": "YYYY-MM-DD HH:mm",
                "default_to_current": true
              }
            },
            {
              "field_id": 72331175133185,
              "field_title": "是否需要报销",
              "field_desc": "",
              "field_type": "radio",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "options": [
                  {
                    "option_id": 72331175133356,
                    "option_text": "需要",
                    "is_custom": false
                  },
                  {
                    "option_id": 72331175133357,
                    "option_text": "不需要",
                    "is_custom": false
                  }
                ]
              }
            },
            {
              "field_id": 71399639089168,
              "field_title": "设备情况",
              "field_desc": "",
              "field_type": "radio",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": true,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": true,
                "options": [
                  {
                    "option_id": 71399639089335,
                    "option_text": "正常",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089336,
                    "option_text": "异常",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089337,
                    "option_text": "其他",
                    "is_custom": true
                  }
                ]
              }
            },
            {
              "field_id": 71399639089169,
              "field_title": "环境情况",
              "field_desc": "",
              "field_type": "radio",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "options": [
                  {
                    "option_id": 71399639089348,
                    "option_text": "正常",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089349,
                    "option_text": "异常",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089350,
                    "option_text": "其他",
                    "is_custom": true
                  }
                ]
              }
            },
            {
              "field_id": 71399639089170,
              "field_title": "消耗工具",
              "field_desc": "",
              "field_type": "checkbox",
              "field_short_name": "",
              "group_id": 72331175133185,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "options": [
                  {
                    "option_id": 71399639089361,
                    "option_text": "螺丝刀",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089362,
                    "option_text": "扳手",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089363,
                    "option_text": "万用表",
                    "is_custom": false
                  },
                  {
                    "option_id": 71399639089369,
                    "option_text": "其他",
                    "is_custom": true
                  }
                ]
              }
            }
          ]
        },
        {
          "group_id": 71399639089156,
          "group_title": "巡检内容",
          "show_group_title": true,
          "is_page_break_group": true,
          "fields": []
        },
        {
          "group_id": 72331175133186,
          "group_title": "",
          "show_group_title": false,
          "is_page_break_group": false,
          "fields": [
            {
              "field_id": 71399639089171,
              "field_title": "负责人姓名",
              "field_desc": "",
              "field_type": "customer_name",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089172,
              "field_title": "负责人手机号",
              "field_desc": "",
              "field_type": "customer_mobile",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089173,
              "field_title": "设备定位",
              "field_desc": "",
              "field_type": "address",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089174,
              "field_title": "安装地址",
              "field_desc": "",
              "field_type": "owner_address",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089175,
              "field_title": "运输车辆车牌",
              "field_desc": "",
              "field_type": "carnumber",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089176,
              "field_title": "负责人手写签名",
              "field_desc": "",
              "field_type": "signature",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089177,
              "field_title": "培训学校",
              "field_desc": "",
              "field_type": "chained_selects",
              "field_short_name": "",
              "group_id": 72331175133186,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "chained_options": [
                  {
                    "option_id": 71399639089433,
                    "option_text": "浙江省",
                    "level": 1,
                    "children": [
                      {
                        "option_id": 71399639089443,
                        "option_text": "杭州市",
                        "level": 2,
                        "children": [
                          {
                            "option_id": 71399639089447,
                            "option_text": "下城区",
                            "level": 3,
                            "children": [
                              {
                                "option_id": 71399639089448,
                                "option_text": "学校1",
                                "level": 4,
                                "children": []
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "option_id": 71399639089453,
                    "option_text": "江苏省",
                    "level": 1,
                    "children": [
                      {
                        "option_id": 71399639089454,
                        "option_text": "南京市",
                        "level": 2,
                        "children": [
                          {
                            "option_id": 71399639089455,
                            "option_text": "鼓楼区",
                            "level": 3,
                            "children": [
                              {
                                "option_id": 71399639089456,
                                "option_text": "学校1",
                                "level": 4,
                                "children": []
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          ]
        },
        {
          "group_id": 71399639089158,
          "group_title": "负责人信息",
          "show_group_title": true,
          "is_page_break_group": true,
          "fields": []
        },
        {
          "group_id": 72331175133187,
          "group_title": "",
          "show_group_title": false,
          "is_page_break_group": false,
          "fields": [
            {
              "field_id": 71399639089178,
              "field_title": "补充图片",
              "field_desc": "",
              "field_type": "image",
              "field_short_name": "",
              "group_id": 72331175133187,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089179,
              "field_title": "补充录音",
              "field_desc": "",
              "field_type": "audio",
              "field_short_name": "",
              "group_id": 72331175133187,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089180,
              "field_title": "补充文件",
              "field_desc": "",
              "field_type": "file",
              "field_short_name": "",
              "group_id": 72331175133187,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            },
            {
              "field_id": 71399639089181,
              "field_title": "补充视频",
              "field_desc": "",
              "field_type": "video",
              "field_short_name": "",
              "group_id": 72331175133187,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            }
          ]
        },
        {
          "group_id": 71399639089160,
          "group_title": "其他补充材料",
          "show_group_title": true,
          "is_page_break_group": true,
          "fields": []
        },
        {
          "group_id": 72331175133188,
          "group_title": "",
          "show_group_title": false,
          "is_page_break_group": false,
          "fields": [
            {
              "field_id": 71399639089182,
              "field_title": "填表时请注意以下说明",
              "field_desc": "",
              "field_type": "description",
              "field_short_name": "",
              "group_id": 72331175133188,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "description_html": "<p><span style=\"font-size: 14px;\">设备巡检示例说明：本文档中的返回示例已做脱敏处理，用于演示说明和结构校验。</span></p>"
              }
            },
            {
              "field_id": 71399639089183,
              "field_title": "卖家身份证信息",
              "field_desc": "请正面拍摄身份证，要求内容清晰完整，方便AI识别",
              "field_type": "ocr_id_card",
              "field_short_name": "",
              "group_id": 72331175133188,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false,
                "ocr_items": [
                  {
                    "item_id": 71399639089533,
                    "item_title": "身份证号",
                    "unit": "",
                    "unit_enabled": false
                  },
                  {
                    "item_id": 71399639089534,
                    "item_title": "姓名",
                    "unit": "",
                    "unit_enabled": false
                  },
                  {
                    "item_id": 71399639089538,
                    "item_title": "地址",
                    "unit": "",
                    "unit_enabled": false
                  }
                ]
              }
            }
          ]
        },
        {
          "group_id": 71399639089162,
          "group_title": "操作说明",
          "show_group_title": true,
          "is_page_break_group": true,
          "fields": []
        },
        {
          "group_id": 72331175133189,
          "group_title": "",
          "show_group_title": false,
          "is_page_break_group": false,
          "fields": [
            {
              "field_id": 71399639089184,
              "field_title": "营业执照信息",
              "field_desc": "请正面拍摄营业执照，要求内容清晰完整，方便AI识别",
              "field_type": "ocr_business_license",
              "field_short_name": "",
              "group_id": 72331175133189,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": true,
                "is_unique": false,
                "is_highlight": false,
                "ocr_items": [
                  {
                    "item_id": 71399639089549,
                    "item_title": "统一社会信用代码",
                    "unit": "",
                    "unit_enabled": false
                  },
                  {
                    "item_id": 71399639089550,
                    "item_title": "企业名称",
                    "unit": "",
                    "unit_enabled": false
                  },
                  {
                    "item_id": 71399639089553,
                    "item_title": "法人/负责人",
                    "unit": "",
                    "unit_enabled": false
                  }
                ]
              }
            },
            {
              "field_id": 71399639089185,
              "field_title": "电表读数",
              "field_desc": "请正面拍摄电表，要求内容清晰完整，方便AI识别",
              "field_type": "ocr_electric_meter",
              "field_short_name": "",
              "group_id": 72331175133189,
              "settings": {
                "is_required": false,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false,
                "ocr_items": [
                  {
                    "item_id": 71399639089571,
                    "item_title": "度数",
                    "unit": "度",
                    "unit_enabled": true
                  }
                ]
              }
            },
            {
              "field_id": 71399639089186,
              "field_title": "产品编号",
              "field_desc": "",
              "field_type": "customer_number",
              "field_short_name": "",
              "group_id": 72331175133189,
              "settings": {
                "is_required": true,
                "is_hidden": false,
                "is_result": false,
                "is_masked": false,
                "is_unique": false,
                "is_highlight": false
              }
            }
          ]
        },
        {
          "group_id": 71399639089164,
          "group_title": "其他信息",
          "show_group_title": true,
          "is_page_break_group": true,
          "fields": []
        }
      ],
      "audit_config": {
        "enabled": true,
        "stages": [
          {
            "id": 20241,
            "title": "组长审批",
            "level": 1
          },
          {
            "id": 20242,
            "title": "厂长审批",
            "level": 2
          }
        ]
      },
      "process_status_config": {
        "enabled": true,
        "options": [
          {
            "text": "待处理",
            "color": "#E64340"
          },
          {
            "text": "处理中",
            "color": "#155EB7"
          },
          {
            "text": "已完成",
            "color": "#06AE56"
          },
          {
            "text": "无需处理",
            "color": "#666"
          },
          {
            "text": "暂无处理进度",
            "color": "#999"
          }
        ]
      },
      "rules": {
        "time_limit_record": [
          {
            "start_time": 1773030000,
            "end_time": 1773036000,
            "time_limit_type": 0
          }
        ],
        "tpl_limit_record": null,
        "owner_tpl_limit_record": null
      }
    }
  }
}

Top-level fields

Field	Type	Description
`form`	object	Basic form info
`org`	object	Owning org
`project`	object	Owning project (partition)
`groups`	array	Groups and field definitions
`audit_config`	object	Approval configuration
`process_status_config`	object	Process status configuration
`rules`	object	Submission rules

`form` object

Field	Type	Description
`id`	integer	Form ID
`name`	string	Form name
`type`	integer	Form type code
`type_text`	string	Form type label
`number`	string	Form number
`description`	string	Description
`submit_button_title`	string	Submit button label
`created_at_iso`	string	Created at with timezone
`updated_at_iso`	string	Updated at with timezone

`form.type` values

Value	Meaning
`0`	Normal form
`1`	Normal form
`2`	Normal form
`3`	Confidential commitment system form
`7`	Manual QR state change system form
`12`	Identity group join application form
`13`	Subcode edit system form
`21`	QR message system form
`22`	QR collaboration system form

`org` / `project`

Object	Field	Type	Description
`org`	`id`	integer	Org ID
`project`	`id`	integer	Project ID

`groups[]`

Each item is a field group. Supports page-break groups: a break group carries no fields and only separates pages.

Group fields

Field	Type	Description
`group_id`	integer	Group ID
`group_title`	string	Title; may be `""`
`show_group_title`	boolean	Show title or not
`is_page_break_group`	boolean	Page break; `fields` usually `[]`
`fields`	array	Fields in the group

Pagination notes:

is_page_break_group=true marks a page boundary.
The following normal group usually holds fields for that page.
Do not assume titled groups always contain fields—check is_page_break_group.

`groups[].fields[]`

Field	Type	Description
`field_id`	integer	Field ID
`field_title`	string	Title
`field_desc`	string	Hint text
`field_type`	string	Type
`field_short_name`	string	Short name / alias
`group_id`	integer	Group ID
`settings`	object	Generic and type-specific settings

Filtering:

Sub-fields are not returned.
Disabled fields are omitted.
ocr_* describes OCR main fields without internal implementation detail.

Common `settings` booleans

All field types include:

Field	Type	Description
`is_required`	boolean	Required
`is_hidden`	boolean	Hidden
`is_result`	boolean	Result field
`is_masked`	boolean	Privacy masking enabled
`is_unique`	boolean	Uniqueness check
`is_highlight`	boolean	Highlight

Extended `settings` by type

Types not listed only have the six booleans above.

Date/time: `date` / `time`

Field	Type	Description
`format`	string	Date/time format
`default_to_current`	boolean	Default to now

Number: `number`

Field	Type	Description
`unit`	string	Unit label; `""` if none
`unit_enabled`	boolean	Show unit
`range`	object	Numeric range
`range.minimum`	number \| null	Min
`range.maximum`	number \| null	Max
`allow_negative`	boolean	Allow negatives

Options: `sex` / `radio` / `checkbox`

Field	Type	Description
`options`	array	Options
`options[].option_id`	integer	Option ID
`options[].option_text`	string	Label
`options[].is_custom`	boolean	Allow custom text

Checklist: `checklist`

Field	Type	Description
`is_allow_entry_desc`	boolean	Allow note text
`checklist_items`	array	Items
`checklist_items[].item_id`	integer	Item ID
`checklist_items[].item_title`	string	Item title
`checklist_result_options`	array	Result options
`checklist_result_options[].option_id`	integer	Option ID
`checklist_result_options[].option_value`	string	Value
`checklist_result_options[].option_text`	string	Label

Table: `matrix` / `dynamic_matrix`

Field	Type	Description
`columns`	array	Column defs
`columns[].column_id`	integer	Column ID
`columns[].column_title`	string	Title
`columns[].column_type`	string	Column type
`columns[].format`	string	Date/time format for some types
`columns[].options`	array	For `sex` / `radio` etc.
`columns[].options[].option_uuid`	string	Option UUID
`columns[].options[].option_text`	string	Label
`columns[].options[].is_custom`	boolean	Custom input allowed

Cascaded: `chained_selects`

Field	Type	Description
`chained_options`	array	Tree
`chained_options[].option_id`	integer	Option ID
`chained_options[].option_text`	string	Label
`chained_options[].level`	integer	Depth from `1`
`chained_options[].children`	array	Children; `[]` at leaves

OCR: `ocr_*`

Field	Type	Description
`ocr_items`	array	Recognition items
`ocr_items[].item_id`	integer	Item ID
`ocr_items[].item_title`	string	Title
`ocr_items[].unit`	string	Unit
`ocr_items[].unit_enabled`	boolean	Show unit

Description: `description`

Field	Type	Description
`description_html`	string	Rich HTML

`audit_config`

Field	Type	Description
`enabled`	boolean	Approval enabled
`stages`	array	Stages; empty when disabled
`stages[].id`	integer	Stage ID
`stages[].title`	string	Stage title
`stages[].level`	integer	Level from `1`

`process_status_config`

Field	Type	Description
`enabled`	boolean	Processing status enabled
`options`	array	Status options
`options[].text`	string	Label
`options[].color`	string	Hex color

`rules`

Time limits, per-user submission limits, and total submission limits.

Field	Type	Description
`time_limit_record`	array	Time windows
`tpl_limit_record`	object \| null	Per-user limit
`owner_tpl_limit_record`	object \| null	Total form limit

`time_limit_record[]`

Field	Type	Description
`start_time`	integer \| string	Start; may be Unix timestamp—do not rely on a single format
`end_time`	integer \| string	End
`time_limit_type`	integer	`0` none, `1` datetime range, `2` daily window

`tpl_limit_record` / `owner_tpl_limit_record`

Field	Type	Description
`limit_type`	integer	`0` none, `1` once, `2` custom period
`custom_type`	integer	Period: `0` day, `1` week, `2` month, `3` year
`custom_limit`	integer	Allowed submissions per period
`custom_type_limit`	integer	Period span value

`field_type` reference

Overview: Form component types overview.

In forms/getTemplate, field_type mainly determines which settings keys appear:

Category	Common `field_type`	Config focus
Text / identity	`name`, `tel`, `recorder`, `identity`, `job_number`, `text`, `textarea`, `customer_name`, `customer_mobile`, `customer_number`, `carnumber`	Usually only the six booleans
Choice	`sex`, `radio`, `checkbox`	`options[]`
Number / time	`number`, `date`, `time`	`unit`, `range`, `format`, `default_to_current`
Composite	`checklist`, `matrix`, `dynamic_matrix`, `chained_selects`	Nested: `checklist_items`, `columns`, `chained_options`
Media / display / OCR	`image`, `audio`, `video`, `file`, `signature`, `description`, `ocr_*`	Media flags, `description_html`, `ocr_items`

For record values, see Get a single record (field_type → field_value).

Other conventions

Empty values

Case	Rule
Optional rule not set	`tpl_limit_record`, `owner_tpl_limit_record` may be `null`
Empty string	Often `""`
Empty array	Often `[]`
Open range	`range.minimum` / `maximum` may be `null`

Masking

Case	Description
Live API	Masking depends on org permission and field config
Examples	Sanitized or synthetic
`settings.is_masked`	Masking enabled; does not imply the sample matches live data

Error response

json

{
  "code": 400,
  "error_code": 100300,
  "message": "System error",
  "message_detail": ""
}

Field	Type	Description
`code`	integer	HTTP or platform status
`error_code`	integer	Business error code
`message`	string	Summary
`message_detail`	string	Detail; may be empty

Full error codes: Error codes.

QR Code

Dynamic QR Code

Forms

QR codes

Forms & records

Installation Guide

WeCom Version Purchase

FAQ

Get form template

Request example

Request parameters

Response overview

`data.data` structure

Top-level fields

`form` object

`form.type` values

`org` / `project`

`groups[]`

Group fields

`groups[].fields[]`

Common `settings` booleans

Extended `settings` by type

Date/time: `date` / `time`

Number: `number`

Options: `sex` / `radio` / `checkbox`

Checklist: `checklist`

Table: `matrix` / `dynamic_matrix`

Cascaded: `chained_selects`

OCR: `ocr_*`

Description: `description`

`audit_config`

`process_status_config`

`rules`

`time_limit_record[]`

`tpl_limit_record` / `owner_tpl_limit_record`

`field_type` reference

Other conventions

Empty values

Masking

Error response

Get form template ​

Request example ​

Request parameters ​

Response overview ​

data.data structure ​

Top-level fields ​

form object ​

form.type values ​

org / project ​

groups[] ​

Group fields ​

groups[].fields[] ​

Common settings booleans ​

Extended settings by type ​

Date/time: date / time ​

Number: number ​

Options: sex / radio / checkbox ​

Checklist: checklist ​

Table: matrix / dynamic_matrix ​

Cascaded: chained_selects ​

OCR: ocr_* ​

Description: description ​

audit_config ​

process_status_config ​

rules ​

time_limit_record[] ​

tpl_limit_record / owner_tpl_limit_record ​

field_type reference ​

Other conventions ​

Empty values ​

Masking ​

Error response ​

Get form template

Request example

Request parameters

Response overview

`data.data` structure

Top-level fields

`form` object

`form.type` values

`org` / `project`

`groups[]`

Group fields

`groups[].fields[]`

Common `settings` booleans

Extended `settings` by type

Date/time: `date` / `time`

Number: `number`

Options: `sex` / `radio` / `checkbox`

Checklist: `checklist`

Table: `matrix` / `dynamic_matrix`

Cascaded: `chained_selects`

OCR: `ocr_*`

Description: `description`

`audit_config`

`process_status_config`

`rules`

`time_limit_record[]`

`tpl_limit_record` / `owner_tpl_limit_record`

`field_type` reference

Other conventions

Empty values

Masking

Error response