登录
基础
连接微信
办公目录
本接口用于在智能表中的某个子表里添加一列或多列新字段。单表最多允许有150个字段。
请求方式：POST(HTTPS)
请求地址：https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartsheet/add_fields?access_token=ACCESS_TOKEN
请求包体：
{
"docid": "DOCID",
"sheet_id": "SHEETID",
"fields": [{
"field_title": "TITLE",
"field_type": "FIELD_TYPE_TEXT"
}]
}参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| docid | string | 是 | 文档的docid |
| sheet_id | string | 是 | 表格ID |
| fields | object [] (AddFiled) | 是 | 字段详情 |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok",
"fields": [{
"field_id": "FIELDID",
"field_title": "TITLE",
"field_type": "FIELD_TYPE_TEXT"
}]
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 错误码 |
| errmsg | string | 错误码说明 |
| fields | object [] (Filed) | 字段详情 |
注意
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| field_id | string | 是 | 字段 ID，更新字段属性时需要填写该字段，但字段 ID 不能被更新 |
| field_title | string | 否 | 字段标题，需要更新为的字段标题 |
| field_type | string | 是 | 字段类型，见FieldType ，必须为原属性 |
| property_number | object(NumberFieldProperty) | 是 | 数字 类型的字段属性 |
| property_checkbox | object(CheckboxFieldProperty) | 否 | 复选框 类型的字段属性 |
| property_date_time | object(DateTimeFieldProperty) | 是 | 日期 类型的字段属性 |
| property_attachment | object(AttachmentFieldProperty) | 否 | 文件 类型的字段属性 |
| property_user | object(UserFieldProperty) | 否 | 人员 类型的字段属性 |
| property_url | object(UrlFieldProperty) | 是 | 超链接 类型的字段属性 |
| property_select | object(SelectFieldProperty) | 是 | 多选 类型的字段属性 |
| property_created_time | object(CreatedTimeFieldProperty) | 是 | 创建时间 类型的字段属性 |
| property_modified_time | object(ModifiedTimeFieldProperty) | 是 | 最后编辑时间 类型的字段属性 |
| property_progress | object(ProgressFieldProperty) | 是 | 进度 类型的字段属性 |
| property_single_select | object(SingleSelectFieldProperty) | 是 | 单选 类型的字段属性 |
| property_reference | object(ReferenceFieldProperty) | 是 | 引用 类型的字段属性 |
| property_location | object(LocationFieldProperty) | 是 | 地理位置 类型的字段属性 |
| property_auto_number | object(AutoNumberFieldProperty) | 是 | 自动编号 类型的字段属性 |
| property_currency | object(CurrencyFieldProperty) | 是 | 货币 类型的字段属性 |
| property_ww_group | object(WwGroupFieldProperty) | 否 | 群 类型的字段属性 |
| 字段类型 | 说明 |
|---|---|
| FIELD_TYPE_TEXT | 文本 |
| FIELD_TYPE_NUMBER | 数字 |
| FIELD_TYPE_CHECKBOX | 复选框 |
| FIELD_TYPE_DATE_TIME | 日期 |
| FIELD_TYPE_IMAGE | 图片 |
| FIELD_TYPE_ATTACHMENT | 文件 |
| FIELD_TYPE_USER | 成员 |
| FIELD_TYPE_URL | 超链接 |
| FIELD_TYPE_SELECT | 多选 |
| FIELD_TYPE_CREATED_USER | 创建人 |
| FIELD_TYPE_MODIFIED_USER | 最后编辑人 |
| FIELD_TYPE_CREATED_TIME | 创建时间 |
| FIELD_TYPE_MODIFIED_TIME | 最后编辑时间 |
| FIELD_TYPE_PROGRESS | 进度 |
| FIELD_TYPE_PHONE_NUMBER | 电话 |
| FIELD_TYPE_EMAIL | 邮件 |
| FIELD_TYPE_SINGLE_SELECT | 单选 |
| FIELD_TYPE_REFERENCE | 关联 |
| FIELD_TYPE_LOCATION | 地理位置 |
| FIELD_TYPE_CURRENCY | 货币 |
| FIELD_TYPE_WWGROUP | 群 |
| FIELD_TYPE_AUTONUMBER | 自动编号 |
数字类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| decimal_places | int(DecimalPlaces) | 表示小数点的位数，即数字精度 |
| use_separate | bool | 是否使用千位符，设置此属性后数字字段将以英文逗号分隔千分位，如 1,000 |
复选框类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| checked | bool | 新增时是否默认勾选 |
日期类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| format | string(Format) | 设置日期格式 |
| auto_fill | bool | 新建记录时，是否自动填充时间 |
文件类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| display_mode | string(DisplayMode) | 设置日期格式 |
成员类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| is_multiple | bool | 允许添加多个人员 |
| is_notified | bool | 添加人员时通知用户，关闭后不通知 |
超链接类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| type | string(LinkType) | 超链接展示样式 |
多选类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| is_quick_add | bool | 是否允许填写时新增选项，用户不需要设置该参数 |
| options | object [] ](Option) | 多选选项的格式设置 |
创建时间类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| format | string(Format) | 设置日期格式 |
最后编辑时间类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| format | string(Format) | 设置日期格式 |
进度类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| decimal_places | int(DecimalPlaces) | 小数位数 |
单选类型字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| is_quick_add | bool | 是否允许填写时新增选项，用户不需要设置该参数 |
| options | object [] (Option) | 单选选项的格式设置 |
关联字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| sub_id | string | 关联的子表id，为空时，表示关联本子表 |
| filed_id | string | 关联的字段id |
| is_multiple | bool | 是否允许多选 |
| view_id | string | 视图id |
地理位置字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| input_type | string(LocationInputType) | 输入类型 |
地理位置字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| input_type | string(LocationInputType) | 输入类型 |
自动编号字段属性信息：
| 参数名 | 类型 | 描述 |
|---|---|---|
| type | string(NumberType) | 输入类型 |
| rules | object[] (NumberRule) | 自定义规则 |
| reformat_existing_record | bool | 是否应用于已有编号 |
货币类型字段属性
| 参数名 | 类型 | 描述 |
|---|---|---|
| currency_type | string(CurrencyType) | 输入类型 |
| decimal_places | int(DecimalPlaces) | 表示小数点的位数，即数字精度 |
| use_separate | bool | 是否使用千位符，设置此属性后数字字段将以英文逗号分隔千分位，如 1,000 |
群类型的字段属性
| 参数名 | 类型 | 描述 |
|---|---|---|
| allow_multiple | bool | 是否允许多个群聊 |
基础连接微信办公基础连接微信办公基础连接微信办公