服务端 API/云文档/多维表格/字段/字段编辑指南
# 字段编辑指南
字段即多维表格数据表中的“列”，是一个`object`结构类型。在多维表格数据表中新增或更新字段时，你可以参考本文档了解如何选择字段类型、设置字段属性。
字段的基本结构如下所示：
```json
{
"field_id": "fldYWaldeW", // 字段的 ID
"field_name": "文本", // 字段名称
"type": 1, // 字段的类型，详情参考下文
"description": "字段的描述", // 对字段的更多说明
"is_primary": true, // 该字段是否是初始的索引字段
"property": null, // 字段的属性，详情参考下文
"ui_type": "Text", // 字段在界面上的展示类型，例如进度字段是数字的一种展示形态
"is_hidden": false // 字段是否是隐藏字段
}
```
参数描述如下所示：
名称 | 类型 | 描述
---|---|---
field_id | string | 字段 ID
field_name | string | 字段名称
type | int | 字段类型：相同类型用 ui_type 区分：
- 1：文本（默认值）、条码（需声明 "ui_type": "Barcode"）、邮箱（需声明"ui_type": "Email")
- 2：数字（默认值）、进度（需声明 "ui_type": "Progress"）、货币（需声明 "ui_type": "Currency"）、评分（需声明 "ui_type": "Rating")
- 3：单选
- 4：多选
- 5：日期
- 7：复选框
- 11：人员
- 13：电话号码
- 15：超链接
- 17：附件
- 18：单向关联
- 19：查找引用
- 20：公式
- 21：双向关联
- 22：地理位置
- 23：群组
- 24：流程
- 1001：创建时间
- 1002：最后更新时间
- 1003：创建人
- 1004：修改人
- 1005：自动编号
- 3001：按钮
description | string | 对字段的更多说明。
is_primary | true/false | 该字段是否是初始的索引字段。
property | object | 字段属性，因字段类型而异。详情参考[字段编辑指南](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/guide)。
ui_type | string | 字段的 UI 类型：
- "Text"：文本
- "Email"：邮箱
- "Barcode"：条码
- "Number"：数字
- "Progress"：进度
- "Currency"：货币
- "Rating"：评分
- "SingleSelect"：单选
- "MultiSelect"：多选
- "DateTime"：日期
- "Checkbox"：复选框
- "User"：人员
- "GroupChat"：群组
- "Stage"：流程
- "Phone"：电话号码
- "Url"：超链接
- "Attachment"：附件
- "SingleLink"：单向关联
- "Formula"：公式
- "Lookup": 查找引用
- "DuplexLink"：双向关联
- "Location"：地理位置
- "CreatedTime"：创建时间
- "ModifiedTime"：最后更新时间
- "CreatedUser"：创建人
- "ModifiedUser"：修改人
- "AutoNumber"：自动编号
- "Button"：按钮
is_hidden | true/false | 字段是否是隐藏字段。
## 索引字段说明
数据表中，第一列为索引列，即索引字段。`"is_primary": true` 表示该字段为索引字段。索引不能被删除、移动或隐藏，且仅支持以下字段类型（type）：
- 1：多行文本
- 2：数字
- 5：日期
- 13：电话号码
- 15：超链接
- 20：公式
- 22：地理位置
## 字段的类型 type
多维表格提供丰富的字段类型，对应参数为 `type`。一个字段类型，在界面上可能有多个展示类型，对应参数为`ui_type`。例如，当 字段类型 type 枚举为 1 时，表示文本类型，对应的 UI 展示类型 `ui_type` 可以是：
- `Text`：文本展示类型
- `Barcode`：条码展示类型
- `Email`：邮箱展示类型
以下为字段类型和字段的 UI 展示类型的枚举值：
不同接口支持的字段类型不同，具体请以对应接口文档的字段类型可选值为准。
字段类型 type 的枚举值 | 字段 UI 展示类型 ui_type 的枚举值
---|---
- 1：文本（默认值）、条码（需声明 "ui_type": "Barcode"）、邮箱（需声明"ui_type": "Email")
- 2：数字（默认值）、进度（需声明 "ui_type": "Progress"）、货币（需声明 "ui_type": "Currency"）、评分（需声明 "ui_type": "Rating")
- 3：单选
- 4：多选
- 5：日期
- 7：复选框
- 11：人员
- 13：电话号码
- 15：超链接
- 17：附件
- 18：单向关联
- 19：查找引用
- 20：公式
- 21：双向关联
- 22：地理位置
- 23：群组
- 24：流程（不支持通过写接口新增或编辑，仅支持读接口）
- 1001：创建时间
- 1002：最后更新时间
- 1003：创建人
- 1004：修改人
- 1005：自动编号
- 3001：按钮（不支持通过写接口新增或编辑，仅支持读接口） | - "Text"：文本
- "Email"：邮箱
- "Barcode"：条码
- "Number"：数字
- "Progress"：进度
- "Currency"：货币
- "Rating"：评分
- "SingleSelect"：单选
- "MultiSelect"：多选
- "DateTime"：日期
- "Checkbox"：复选框
- "User"：人员
- "GroupChat"：群组
- "Stage"：流程
- "Phone"：电话号码
- "Url"：超链接
- "Attachment"：附件
- "SingleLink"：单向关联
- "Formula"：公式
- "Lookup": 查找引用
- "DuplexLink"：双向关联
- "Location"：地理位置
- "CreatedTime"：创建时间
- "ModifiedTime"：最后更新时间
- "CreatedUser"：创建人
- "ModifiedUser"：修改人
- "AutoNumber"：自动编号
- "Button"：按钮
## 字段的属性 property
字段的属性指指定字段类型的更多功能属性。例如，对于人员类型的字段，是否要开启允许添加多个成员的功能属性。不同类型的字段对应的 `property` 结构不同。以下类型字段没有其他功能属性，其 `property` 均为 `null`：
- 1：文本（默认值）、邮箱（需声明`"ui_type": "Email"`）
- 7：复选框
- 13：电话号码
- 15：超链接
- 17：附件
- 19：查找引用
- 1003：创建人
- 1004：修改人
例如，当字段的类型为文本，字段 UI 展示的类型为邮箱时，其`property` 应设为 `null`：
```json
{
"field_name": "邮箱",
"type": 1,
"ui_type": "Email",
"property": null
}
```
其它类型字段均有更多功能属性，你可参考下文了解和使用不同类型字段的 `property` 结构。
### 条码字段
条码字段的类型 `type` 为 `1` ，UI 展示类型 `ui_type` 为 `"Barcode"`。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
allowed_edit_modes | allowed_edit_modes | 否 | 条码字段的配置
manual | bool | 否 | 是否允许手动录入。默认为 true。
scan | bool | 否 | 是否允许移动端录入。默认为 true。
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "条码",
"type": 1,
"ui_type": "Barcode",
"property": {
"allowed_edit_modes": {
"scan": true,
"manual": true
}
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldQoEj2p3",
"field_name": "条码",
"is_primary": false,
"property": {
"allowed_edit_modes": {
"manual": true,
"scan": true
}
},
"type": 1,
"ui_type": "Barcode"
}
},
"msg": "success"
}
```
### 数字字段
数字字段的类型 `type` 为 `2`，无需声明 UI 展示类型 `ui_type` 。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
formatter | string | 否 | 数字的格式，默认为 "0.0"，枚举值如下所示：
- "0"：整数
- "0.0"：保留 1 位小数
-"0.00"：保留 2 位小数
- "0.000"：保留 3 位小数
- "0.0000"：保留 4 位小数
- "1,000"：千分位
- "1,000.00"：千分位（小数点）
- "%"：百分比
- "0.00%"：百分比（小数点）
- "¥"：人民币
- "¥0.00"：人民币（小数点）
- "$"：美元
- "$0.00"：美元（小数点）
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "数字",
"type": 2,
"property": {
"formatter": "0.00"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldP9gzwe7",
"field_name": "数字",
"is_primary": false,
"property": {
"formatter": "0.00"
},
"type": 2,
"ui_type": "Number"
}
},
"msg": "success"
}
```
### 货币字段
货币字段的类型 `type` 为 `2`，UI 展示类型 `ui_type` 为 `"Currency"` 。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
formatter | string | 是 | 货币的小数位数，枚举值如下所示： - "0"：整数 - "0.0"：1 位 - "0.00"：2 位 - "0.000"：3 位 - "0.0000"：4 位
currency_code | string | 是 | 货币的具体类型，枚举值如下所示：
- "CNY"：人民币，货币符号为 ¥
- "USD"：美元，货币符号为 $
- "EUR"：欧元，货币符号为 €
- "GBP"：英镑，货币符号为 £
- "AED"：阿联酋迪拉姆，货币符号为 dh
- "AUD"：澳大利亚元，货币符号为 $
- "BRL"：巴西雷亚尔，货币符号为 R$
- "CAD"：加拿大元，货币符号为 $
- "CHF"：瑞士法郎，货币符号为 CHF
- "HKD"：港元，货币符号为 $
- "INR"：印度卢比，货币符号为 ₹
- "IDR"：印尼盾，货币符号为 Rp
- "JPY"：日元，货币符号为 ¥
- "KRW"：韩元，货币符号为 ₩
- "MOP"：澳门元，货币符号为 MOP$
- "MXN"：墨西哥比索，货币符号为 $
- "MYR"：马来西亚令吉，货币符号为 RM
- "PHP"：菲律宾比索，货币符号为 ₱
- "PLN"：波兰兹罗提，货币符号为 zł
- "RUB"：俄罗斯卢布，货币符号为 ₽
- "SGD"：新加坡元，货币符号为 $
- "THB"：泰国铢，货币符号为 ฿
- "TRY"：土耳其里拉，货币符号为 ₺
- "TWD"：新台币，货币符号为 NT$
- "VND"：越南盾，货币符号为 ₫
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "货币",
"type": 2,
"ui_type": "Currency",
"property": {
"formatter": "0",
"currency_code": "MOP"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fld6vPlPZ1",
"field_name": "货币",
"is_primary": false,
"property": {
"currency_code": "MOP",
"formatter": "0"
},
"type": 2,
"ui_type": "Currency"
}
},
"msg": "success"
}
```
### 进度字段
进度字段的类型 `type` 为 `2`，UI 展示类型 `ui_type` 为 `"Progress"` 。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
formatter | string | 是 | 进度的格式，枚举值如下所示：
- "0"：整数，不保留小数
- "0.0"：数值，保留一位小数
- "0.00"：数值，保留两位小数
- "0%"：百分比，保留整数
- "0.0%"：百分比，保留一位小数
- "0.00%"：百分比，保留两位小数
range_customize | bool | 否 | 是否允许自定义进度条值，默认为 false。
min | number | range_customize 为 true 时必填 | 进度的最小值
max | number | range_customize 为 true 时必填 | 进度的最大值
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "进度",
"type": 2,
"ui_type": "Progress",
"property": {
"formatter": "0.00%",
"min": 0.1,
"max": 4,
"range_customize": true
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldANhA0do",
"field_name": "进度",
"is_primary": false,
"property": {
"formatter": "0.00%",
"max": 100,
"min": 0.1,
"range_customize": true
},
"type": 2,
"ui_type": "Progress"
}
},
"msg": "success"
}
```
### 评分字段
评分字段的类型 `type` 为 `2`，UI 展示类型 `ui_type` 为 `"Rating"` 。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
formatter | string | 是 | 评分的格式，固定为 "0"
rating | rating | 否 | 评分设置
symbol | string | 否 | 评分的图标，默认为 "star"。枚举值如下所示：
- "star"：星星
- "heart"：爱心
- "thumbsup"：赞
- "fire"：火
- "smile"：笑脸
- "lightning"：闪电
- "flower"：花
- "number"：数字
min | number | 是 | 评分的最小值，可以是 0 或 1。
max | number | 是 | 评分的最大值，为 1~10 之间的整数，包括 1 和 10。
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "评分",
"type": 2,
"ui_type": "Rating",
"property": {
"formatter": "0",
"min": 0,
"max": 10,
"rating": {
"symbol": "lightning"
}
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldTOLqnni",
"field_name": "评分",
"is_primary": false,
"property": {
"formatter": "0",
"max": 10,
"min": 0,
"rating": {
"symbol": "lightning"
}
},
"type": 2,
"ui_type": "Rating"
}
},
"msg": "success"
}
```
### 单选字段
单选字段的类型 `type` 为 `3`。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
options | app.table.field.property.option<string>[] | 否 | 选项列表
id | string | 否 | 选项 ID。对于新增字段接口，无需指定选项 ID
name | string | 否 | 选项名称
color | int | 否 | 选项颜色，默认从上一个选项的 color 开始依次递增。取值范围：0~54
#### 新增字段的请求体示例
```json
{
"field_name": "单选",
"type": 3,
"property": {
"options": [
{
"name": "选项 A"
},
{
"name": "选项 B"
},
{
"name": "选项 C",
"color": 5
},
{
"name": "选项 D"
}
]
}
}
```
#### 新增字段的响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldQrcCPFs",
"field_name": "单选",
"is_primary": false,
"property": {
"options": [
{
"color": 0,
"id": "optQQM0hOZ",
"name": "选项 A"
},
{
"color": 1,
"id": "opt6wdUh3n",
"name": "选项 B"
},
{
"color": 5,
"id": "optazha8oD",
"name": "选项 C"
},
{
"color": 6,
"id": "optLdIy4nl",
"name": "选项 D"
}
]
},
"type": 3,
"ui_type": "SingleSelect"
}
},
"msg": "success"
}
```
#### 更新字段的请求体示例
要更新选项 A 的名称为 `a++`，选项 B 保持不变，删除选项 C 和选项 D，新增选项 Z，请求体示例如下所示：
```json
{
"field_name": "单选",
"type": 3,
"property": {
"options": [
{
"color": 0,
"id": "optQQM0hOZ",
"name": "a++"
},
{
"color": 1,
"id": "opt6wdUh3n",
"name": "选项 B"
},
{
"color": 6,
"name": "选项 Z"
}
]
}
}
```
#### 更新字段的响应体示例
更新字段为全量更新，选项 C 和选项 D 已删除，响应体如下所示：
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldQrcCPFs",
"field_name": "单选",
"property": {
"options": [
{
"color": 0,
"id": "optQQM0hOZ",
"name": "a++"
},
{
"color": 1,
"id": "opt5g3xLFT",
"name": "选项 B"
},
{
"color": 6,
"id": "opt558YmTi",
"name": "选项 Z"
}
]
},
"type": 3
}
},
"msg": "Success"
}
```
### 多选字段
多选字段的类型 `type` 为 `4`。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
options | app.table.field.property.option<string>[] | 否 | 选项列表
id | string | 否 | 选项 ID。对于新增字段接口，无需指定选项 ID
name | string | 否 | 选项名称
color | int | 否 | 选项颜色，默认从上一个选项的 color 开始依次递增。取值范围：0~54
#### 新增字段的请求体示例
```json
{
"field_name": "多选",
"type": 4,
"property": {
"options": [
{
"name": "a"
},
{
"name": "b"
},
{
"name": "c",
"color": 5
},
{
"name": "d"
}
]
}
}
```
#### 新增字段的响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldLyDzkdA",
"field_name": "多选",
"is_primary": false,
"property": {
"options": [
{
"color": 0,
"id": "opt2H40Z1F",
"name": "a"
},
{
"color": 1,
"id": "optYQrPhiq",
"name": "b"
},
{
"color": 5,
"id": "opt0xiSsy9",
"name": "c"
},
{
"color": 6,
"id": "optNudypoa",
"name": "d"
}
]
},
"type": 4,
"ui_type": "MultiSelect"
}
},
"msg": "success"
}
```
#### 更新字段的请求体示例
要更新选项 `a` 的选项名为 `a++`，选项 `b` 保持不变，删除选项`c`和选项`d`，新增选项`z`，请求体如下搜索：
```json
{
"field_name": "单选",
"type": 3,
"property": {
"options": [
{
"color": 0,
"id": "optpeuQVqp",
"name": "a++"
},
{
"color": 1,
"id": "opt5g3xLFT",
"name": "b"
},
{
"color": 6,
"name": "z"
}
]
}
}
```
#### 更新字段的响应体示例
更新字段为全量更新，选项 `c` 和选项 `d` 已删除，响应体如下所示：
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fld2RxOyB8",
"field_name": "单选",
"property": {
"options": [
{
"color": 0,
"id": "optpeuQVqp",
"name": "a++"
},
{
"color": 1,
"id": "opt5g3xLFT",
"name": "b"
},
{
"color": 6,
"id": "opt558YmTi",
"name": "z"
}
]
},
"type": 3
}
},
"msg": "Success"
}
```
### 日期字段
日期字段的类型 `type` 为 `5` 。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
date_formatter | string | 否 | 日期格式，默认为 "yyyy/MM/dd"，枚举值如下所示：
- "yyyy/MM/dd"：格式如 2021/01/30
- "yyyy-MM-dd HH:mm"：2021-01-30 14:00
- "MM-dd"：01-30
- "MM/dd/yyyy"：01/30/2021
- "dd/MM/yyyy"：30/01/2021
auto_fill | boolean | 否 | 对于新记录，是否自动填写创建时间。默认为 false。
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "日期",
"type": 5,
"property": {
"date_formatter": "yyyy/MM/dd HH:mm",
"auto_fill": false
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldHBDkAfH",
"field_name": "日期",
"property": {
"auto_fill": false,
"date_formatter": "yyyy/MM/dd HH:mm"
},
"type": 5
}
},
"msg": "Success"
}
```
### 人员字段
人员字段的类型 `type` 为 `11` 。其功能属性如下所示：
| 名称 | 类型 | 必填 | 描述 |
| -------- | ------- | -- | -------------------- |
| multiple | boolean | 否 | 是否允许添加多个成员，默认为 true。 |
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "人员",
"type": 11,
"property": {
"multiple": true
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldlQDzjyK",
"field_name": "人员",
"property": {
"multiple": true
},
"type": 11
}
},
"msg": "Success"
}
```
### 单向关联字段
单向关联的类型 `type` 为 `18` 。其功能属性如下所示：
| 名称 | 类型 | 必填 | 描述 |
| -------- | ------- | -- | -------------------- |
| multiple | boolean | 否 | 是否允许添加多个记录，默认为 true。 |
| table_id | string | 是 | 关联的数据表的 ID |
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "单向关联",
"type": 18,
"property": {
"multiple": true,
"table_id": "tblw92ErelmCmgHc"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldNdr8VNW",
"field_name": "单向关联",
"property": {
"multiple": true,
"table_id": "tblw92ErelmCmgHc",
"table_name": "数据表 2"
},
"type": 18
}
},
"msg": "Success"
}
```
### 双向关联字段
双向关联的类型 `type` 为 `21`。其功能属性如下所示：
| 名称 | 类型 | 必填 | 描述 |
| --------------- | ------- | -- | ---------------------------------- |
| back_field_name | string | 否 | 关联数据表中双向关联字段的 ID，默认为 “关联的数据表名-字段名” |
| multiple | boolean | 否 | 是否允许添加多个记录，默认为 true。 |
| table_id | string | 是 | 关联的数据表的 ID |
#### 请求体示例
新增、更新字段的请求体示例如下所示：
```json
{
"field_name": "双向关联",
"type": 21,
"property": {
"multiple": true,
"table_id": "tblw92ErelmCmgHc",
"back_field_name": "双向关联表-自动生成"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldpfIDIi0",
"field_name": "双向关联",
"property": {
"back_field_id": "fldmQGUnWh", // 关联数据表中双向关联字段的 ID
"back_field_name": "双向关联表-自动生成",
"multiple": true,
"table_id": "tblw92ErelmCmgHc",
"table_name": "数据表2" // 关联数据表的名称
},
"type": 21
}
},
"msg": "Success"
}
```
### 公式字段
公式字段的类型 `type` 为 `20`。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
formatter | string | 否 | 公式格式，默认为空。可以是数值、货币、或日期。可选值如下所示：
- "0"：整数
- "0.0"：保留 1 位小数
- "0.00"：保留 2 位小数
- "1,000"：千分位
- "1,000.00"：千分位（小数点）
- "%"：百分比
- "0.00%"：百分比（小数点）
- "¥"：人民币
- "¥0.00"：人民币（小数点）
- "$"：美元
- "$0.00"：美元（小数点）
- "yyyy/MM/dd HH:mm"：2021/01/30 14:00
- "yyyy/MM/dd"：2021/01/30
- "yyyy-MM-dd"：2021-01-30
- "MM-dd"：01-30
formula_expression | string | 否 | 公式表达式。
#### 请求体示例
新增或更新字段的请求体示例如下所示：
```json
{
"field_name": "公式",
"type": 20,
"property": {
"formatter": "0.00%",
"formula_expression": "IF(bitable::$table[tblxxxxxxxxxxxxx].$field[fldxxxxxxx].CONTAIN("Lark"),"aaa","bbb")"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldFuAdYEI",
"field_name": "公式",
"property": {
"formatter": "0.00%",
"formula_expression": "IF(bitable::$table[tblxxxxxxxxxxxxx].$field[fldxxxxxxx].CONTAIN("Lark"),"aaa","bbb")"
},
"type": 20
}
},
"msg": "Success"
}
```
### 地理位置字段
地理位置的类型 `type` 为 `22`。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
location | app.field.property.location | 否 | 地理位置输入方式
input_type | string | 是 | 地理位置输入限制，可选值有：
- only_mobile：仅允许移动端实时定位
- not_limit：无限制，可输入任意地理位置
#### 请求体示例
新增或更新字段的请求体示例如下所示：
```json
{
"field_name": "位置",
"type": 22,
"property": {
"location": {
"input_type": "not_limit"
}
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldc7JNkVa",
"field_name": "置",
"is_primary": false,
"property": {
"location": {
"input_type": "not_limit"
}
},
"type": 22,
"ui_type": "Location"
}
},
"msg": "success"
}
```
### 群组字段
群组字段的类型 `type` 为 `23`。其功能属性如下所示：
| 名称 | 类型 | 必填 | 描述 |
| -------- | ------- | -- | -------------------- |
| multiple | boolean | 否 | 是否允许添加多个群组，默认为 true。 |
#### 请求体示例
新增或更新字段的请求体示例如下所示：
```json
{
"field_name": "群组字段-允许添加多个群组",
"type": 23,
"property": {
"multiple": true
},
"description": {
"disable_sync": false,
"text": "群组字段-允许添加多个群组"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"description": {
"disable_sync": false,
"text": "群组字段-允许添加多个群组"
},
"field_id": "fldw6fSubT",
"field_name": "群组字段-允许添加多个群组",
"is_primary": false,
"property": {
"multiple": true
},
"type": 23,
"ui_type": "GroupChat"
}
},
"msg": "success"
}
```
### 创建时间、最后更新时间字段
创建时间字段的类型 `type` 为 `1001`。最后更新时间字段的类型 `type` 为 `1002`。其功能属性相同，如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
date_formatter | string | 否 | 日期格式，默认为 "yyyy/MM/dd"，枚举值如下所示：
- "yyyy/MM/dd"：格式如 2021/01/30
- "yyyy-MM-dd HH:mm"：2021-01-30 14:00
- "MM-dd"：01-30
- "MM/dd/yyyy"：01/30/2021
- "dd/MM/yyyy"：30/01/2021
#### 请求体示例
调用新增或更新“创建时间”字段的请求体示例如下所示：
```json
{
"field_name": "创建时间",
"type": 1001,
"property": {
"date_formatter": "yyyy/MM/dd"
}
}
```
#### 响应体示例
```json
{
"code": 0,
"data": {
"field": {
"field_id": "fldoblwmUC",
"field_name": "创建时间",
"property": {
"date_formatter": "yyyy/MM/dd"
},
"type": 1001
}
},
"msg": "Success"
}
```
### 自动编号字段
自动编号字段的类型 `type` 为 `1005`。其功能属性如下所示：
名称 | 类型 | 必填 | 描述
---|---|---|---
auto_serial | app.field.property.auto_serial | 否 | 自动编号
type | string | 是 | 自动编号类型，可选值如下所示： - "custom"：自定义编号 - "auto_increment_number"：自增数字
reformat_existing_records | bool | 否 | 是否将修改应用于已有编号，默认为 false。
options | app.field.property.auto_serial.options[] | 否 | 自定义编号规则列表
type | string | 是 | 规则类型，可选值如下所示： - "system_number"：自增数字的位数，范围为 1-9 - "fixed_text"：固定字符，最大字符长度为 20 - "created_time"：创建日期
value | string | 是 | 规则类型对应的值。 - 若规则类型为 `"type": "system_number"`，value 为范围在 1-9 的整数，表示自增数字的位数 - 若规则类型为 `"type": "fixed_text"`，value 为范围在 20 个字符以内的固定字符 - 若规则类型为 "type": "created_time"，value 用于指定日期的格式。可选值如下所示： - "yyyyMMdd"：日期为 20220130 的格式 - "yyyyMM"：日期为 202201 的格式 - "yyyy"：日期为 2022 的格式 - "MMdd"：日期为 130 的格式，表示 1 月 30 日 - "MM"：日期为 1 的格式，表示月份 - "dd"：日期为 30 的格式
#### 添加“自定义编号（custom）”示例
调用新增或更新字段，添加“自定义编号（custom）”类型的自动编号字段，请求体示例如下所示：
```json
{
"field_name": "自定义编号",
"property": {
"auto_serial": {
"type": "custom",
"reformat_existing_records": true,
"options": [
{
"type": "system_number",
"value": "3"
},
{
"type": "fixed_text",
"value": "keyword"
},
{
"type": "created_time",
"value": "yyyyMMdd"
}
]
}
},
"type": 1005
}
```
对应的响应体示例如下所示：
```json
{
"code": 0,
"msg": "success",
"data": {
"field": {
"property": {
"auto_serial": {
"type": "custom",
"options": [
{
"type": "system_number",
"value": "3"
},
{
"value": "keyword",
"type": "fixed_text"
},
{
"type": "created_time",
"value": "yyyyMMdd"
}
]
}
},
"field_id": "fldmVunQuc",
"field_name": "自定义编号",
"type": 1005
}
}
}
```
#### 添加“自增数字（auto_increment_number）”示例
调用新增或更新字段，添加“自增数字（auto_increment_number）”类型的自动编号字段，请求体示例如下所示：
```json
{
"field_name": "自增数字自动编号",
"property": {
"auto_serial": {
"type": "auto_increment_number",
"reformat_existing_records": true
}
},
"type": 1005
}
```
对应的响应体示例如下所示：
```json
{
"code": 0,
"msg": "success",
"data": {
"field": {
"field_name": "自增数字自动编号",
"type": 1005,
"property": {
"auto_serial": {
"type": "auto_increment_number"
}
},
"field_id": "fldwq16vz2"
}
}
}
```