# 查询表单字段和约束列表

BASIC

# URL:

POST /api/metadata/v2/template/field/selectTemplateFieldList

# 请求参数:

参数名称	格式	说明
body	object
\|─templateApiName	string	表单templateApiName
\|─needFieldApiNames	array	前端需要的字段信息
\|─	string
\|─needConstraint	boolean	是否需要约束信息默认值: Boolean.FALSE

# 请求示例:

{
  "body": {
    "templateApiName": "",
    "needFieldApiNames": [
      ""
    ],
    "needConstraint": false
  }
}

# 响应体:

参数名称	格式	说明
data	object
\|─entity	object	对象类型数据
\|─list	array	对象数组类型
\|─	object
\|─id	integer
\|─templateApiName	string	表单apiName
\|─name	string	表单名称
\|─apiName	string	表单apiName
\|─defaultValue	string	默认值
\|─dataType	string	数据类型 NUM_CODE :编号 0 5 TEXT :单行文本 1 1 MULTI_TEXT :多行文本 2 10 NUM :数字 3 2 BOOLEAN :开关 4 14 DATE :日期 5 3 DATE_INTERVAL :日期区间 6 19 SELECT :单选 7 4 MULTI_SELECT :复选 8 15 OBJECT :关联表单 9 9 OBJECT_ATTRIBUTE :关联表单字段 10 6 MULTI_OBJECT :复选关联表单 11 12 SOURCE_OBJECT :选单来源 12 7 SOURCE_OBJECT_LINE :选单来源行号 13 8 AREA :国家地区 14 17 LOCATION :地理位置 15 18 ATTACHMENT :附件 16 11 PICTURE :图片 17 16 BASE :基础数据 18 13 PROGRESS_BAR :进度条 19 20 DICT :字典 20 21
\|─orderNum	integer	排序字段
\|─objectApiName	string	冗余的关联字段的objectApiName
\|─objectFieldApiName	string	冗余的关联字段的objectFieldApiName
\|─system	boolean	冗余的关联字段的system
\|─domain	boolean	指示字段是否属于领域实体
\|─dataTypeConstraintValues	array	字段约束
\|─	object
\|─name	string	展示文案
\|─dataType	string	所属数据类型 NUM_CODE :编号 0 5 TEXT :单行文本 1 1 MULTI_TEXT :多行文本 2 10 NUM :数字 3 2 BOOLEAN :开关 4 14 DATE :日期 5 3 DATE_INTERVAL :日期区间 6 19 SELECT :单选 7 4 MULTI_SELECT :复选 8 15 OBJECT :关联表单 9 9 OBJECT_ATTRIBUTE :关联表单字段 10 6 MULTI_OBJECT :复选关联表单 11 12 SOURCE_OBJECT :选单来源 12 7 SOURCE_OBJECT_LINE :选单来源行号 13 8 AREA :国家地区 14 17 LOCATION :地理位置 15 18 ATTACHMENT :附件 16 11 PICTURE :图片 17 16 BASE :基础数据 18 13 PROGRESS_BAR :进度条 19 20 DICT :字典 20 21
\|─dataTypeConstraint	string	数据类型下校验项 FIELD_NAME :ConstraintType.SHOW 字段名称 1 API_NAME :ConstraintType.SHOW API NAME 2 MAX_LENGTH :ConstraintType.VALIDATE 最大长度 3 DEFAULT_VALUE :ConstraintType.SHOW 默认值 4 REQUIRED :ConstraintType.VALIDATE 必填 5 NUM_DIGIT :ConstraintType.VALIDATE 小数位数 6 NUM_PADDING_ZERO :ConstraintType.SHOW 小数补零 7 NUM_ZERO_DONT_SHOW :ConstraintType.SHOW 为零不显示 8 NUM_SHOW_SUM :ConstraintType.SHOW 显示合计 9 SETTING_SELECT :ConstraintType.SHOW 选项设置 11 GENERATION_MODE :ConstraintType.SHOW 生成方式 12 MANUAL_CHANGE :ConstraintType.SHOW 手动编辑 13 OBJECT_FIELD :ConstraintType.VALIDATE 表单字段 14 INPUT :ConstraintType.SHOW 是否录入 15 OBJECT :ConstraintType.VALIDATE 表单 16 TIME :ConstraintType.SHOW 选择时间 17 SET_TIME_RANGE :ConstraintType.SHOW 预设范围 18 VALUE_UPDATE :ConstraintType.VALIDATE 值更新 19 SELECT :ConstraintType.VALIDATE 筛选 20 SORT :ConstraintType.VALIDATE 排序 21 STATUS :ConstraintType.SHOW 状态 22 MAX_UPLOADED_NUM :ConstraintType.SHOW 最大上传数 23 KEY :ConstraintType.SHOW 关键字 24 ALTERNATION :ConstraintType.SHOW 正反选项 25 PLACEHOLDER :ConstraintType.SHOW 占位提示 26 EXPLANATION :ConstraintType.SHOW 说明 27 UNIQUE :ConstraintType.VALIDATE 唯一 28 LIMITED_FORMAT :ConstraintType.VALIDATE 限定格式 29 DATA_SAVE :ConstraintType.SHOW 数据保存 30 MAX_SELECT :ConstraintType.VALIDATE 最大选择数 31 VIEW_TYPE :ConstraintType.SHOW 展示形态 32 SHOW_API_NAMES :ConstraintType.SHOW 下拉显示 33 POPUP_SHOW_API_NAMES :ConstraintType.SHOW 弹窗显示 34 DATA_CONDITION :ConstraintType.SHOW 数据过滤 35 AUTO_FILL :ConstraintType.SHOW 自动填充 36 CAN_UPDATE :ConstraintType.SHOW 支持新增 37 CAN_SCAN_INPUT :ConstraintType.SHOW 支持扫码录入 38 ACCURACY :ConstraintType.SHOW 精准度 39 MULTI_OBJECT_TYPE :ConstraintType.SHOW 复选关联表单组件类型 40 SINGLE_SELECT :ConstraintType.SHOW 是否是单选 41 DATA_SOURCE :ConstraintType.VALIDATE 数据源 42 INTERVAL :ConstraintType.SHOW 间隔 43 COLOR :ConstraintType.SHOW 颜色 44 CALIBRATION :ConstraintType.SHOW 刻度 45 PROGRESS :ConstraintType.SHOW 进度显示 46 SERIAL_NUMBER :ConstraintType.SHOW 流水号开启 47 LIMIT_UP :ConstraintType.VALIDATE 上限 48 LIMIT_LOW :ConstraintType.VALIDATE 下限 49 SPLIT :ConstraintType.SHOW 支持拆分 50 DICT_KV :ConstraintType.VALIDATE 键值 51 DICT_COUNT :ConstraintType.VALIDATE 个数 52
\|─value	string	具体值：true/false 最大数值4 提示信息
\|─attributeType	string	字段所属类型 OBJECT :实体 1 TEMPLATE :模板 2
\|─tenantId	string	租户id
\|─templateApiName	string	表单apiName
\|─fieldApiName	string	表单字段apiName
\|─templateName	string	templateName
\|─bossTemplateApiName	string	boss 表单apiname
\|─bossFieldApiName	string	boss 表单字段apiname
\|─interactSourceField	boolean	NOSP 是否为融合字段
\|─start	integer	对象数组分页
\|─length	integer
\|─recordsTotal	integer
code	integer
cpsErrorCode	string
message	string

# 响应示例:

{
  "data": {
    "entity": null,
    "list": [
      {
        "id": 0,
        "templateApiName": "",
        "name": "",
        "apiName": "",
        "defaultValue": "",
        "dataType": "",
        "orderNum": 0,
        "objectApiName": "",
        "objectFieldApiName": "",
        "system": false,
        "domain": false,
        "dataTypeConstraintValues": [
          {
            "name": "",
            "dataType": "",
            "dataTypeConstraint": "",
            "value": "",
            "attributeType": "",
            "tenantId": "",
            "templateApiName": "",
            "fieldApiName": ""
          }
        ],
        "templateName": "",
        "bossTemplateApiName": "",
        "bossFieldApiName": "",
        "interactSourceField": false
      }
    ],
    "start": 0,
    "length": 0,
    "recordsTotal": 0
  },
  "code": 0,
  "cpsErrorCode": "",
  "message": ""
}

← 表单信息查询数据格式限定 →