创建字段
请求说明
| 请求地址 | https://openapi.wps.cn/v7/coop/dbsheet/{file_id}/sheets/{sheet_id}/fields |
|---|---|
| 请求方法 | POST |
| 签名方式 | KSO-1 |
| 权限要求 | 管理多维表格（用户授权） kso.dbsheet.readwrite |
请求头（Header）
| Header 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用：application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值，详见《签名方法》 |
| Authorization | string | 是 | 授权凭证，格式为：Bearer {access_token} |
路径参数（Path）
| 名称 | 参数类型 | 说明 |
|---|---|---|
| file_id | string | 文件 id |
| sheet_id | integer | 数据表 id |
请求体（Body）
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| fields | array[object] | 是 | 数据表字段，详见多维表格参数说明 |
| prefer_id | boolean | 否 | 是否使用字段 id 而不是字段名来标识字段，默认值为 false。为 true 时 Lookup 类型 linkField 与 lookupField 需传递字段 id |
请求地址示例
[POST] https://openapi.wps.cn/v7/coop/dbsheet/{file_id}/sheets/{sheet_id}/fields请求体示例
json
{
"fields": [
{
"name": "日期",
"type": "Date",
"data": {
"number_format": "yyyy\"年\"m\"月\"d\"日\";@",
"default_value_type": "Normal",
"default_value": "2024/11/23"
}
},
{
"name": "日期",
"type": "Date",
"data": {
"number_format": "yyyy/mm/dd",
"default_value_type": "RecordCreateTime"
}
},
{
"name": "时间",
"type": "Time",
"data": {
"number_format": "hh:mm:ss;@"
}
},
{
"name": "数字",
"type": "Number",
"data": {
"number_format": "0_ "
}
},
{
"name": "货币",
"type": "Currency",
"data": {
"number_format": "$#,##0.000_ "
}
},
{
"name": "多行文本",
"type": "MultiLineText",
"data": {
"unique_value": false
}
},
{
"name": "百分比",
"type": "Percentage",
"data": {
"number_format": "0.00%"
}
},
{
"name": "身份证",
"type": "Id",
"data": {
"unique_value": true
}
},
{
"name": "电话",
"type": "Phone",
"data": {
"unique_value": false
}
},
{
"name": "最后修改者",
"type": "LastModifiedBy",
"data": {
"watch_all": true
}
},
{
"name": "最后修改时间",
"type": "LastModifiedTime",
"data": {
"number_format": "hh:mm:ss;@",
"watch_all": true
}
},
{
"name": "公式",
"type": "Formula",
"data": {
"formula": "=[数字]+[货币]",
"number_format": "0_ "
}
},
{
"name": "编号",
"type": "AutoNumber",
"data": {
"number_format": "000000"
}
},
{
"name": "创建时间",
"type": "CreatedTime",
"data": {
"number_format": "yyyy-mm-dd hh:mm;@"
}
},
{
"name": "超链接",
"type": "Url",
"data": {
"display_text": "点击访问"
}
},
{
"name": "单选项",
"type": "SingleSelect",
"data": {
"allow_add_item_while_inputting": true,
"items": [
{
"value": "选项1",
"id": "1"
},
{
"value": "选项2",
"id": "2"
}
]
}
},
{
"name": "多选项",
"type": "MultipleSelect",
"data": {
"allow_add_item_while_inputting": false,
"items": [
{
"value": "多选选项1",
"id": "1"
},
{
"value": "多选选项2",
"id": "2"
}
]
}
},
{
"name": "等级",
"type": "Rating",
"data": {
"max": 5
}
},
{
"name": "联系人",
"type": "Contact",
"data": {
"default_value_type": "RecordCreator",
"notice_new_contact": true
}
},
{
"name": "联系人-指定人",
"type": "Contact",
"data": {
"default_value_type": "Normal",
"default_value": "281653414",
"multiple_contacts": true
}
},
{
"name": "附件",
"type": "Attachment",
"data": {
"only_upload_by_camera": false
}
},
{
"name": "地址",
"type": "Address",
"data": {
"address_level": 3,
"detailed_address": true,
"preset_address": {
"detail": "预设地址详情",
"districts": [
"广东省",
"珠海市",
"香洲区"
]
}
}
},
{
"name": "富文本",
"type": "Note"
},
{
"name": "复选框",
"type": "Checkbox"
},
{
"name": "进度",
"type": "Complete"
},
{
"name": "邮箱",
"type": "Email"
},
{
"name": "创建人",
"type": "CreatedBy"
}
],
"prefer_id": false
}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败，参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ fields | array[object] | 数据表字段，详见多维表格参数说明 |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"msg": "",
"data": {
"fields": [
{
"name": "日期",
"type": "Date",
"id": "P",
"data": {
"default_value": "2024/11/23",
"default_value_type": "Normal",
"number_format": "yyyy\"年\"m\"月\"d\"日\";@"
}
},
{
"name": "日期2",
"type": "Date",
"id": "Q",
"data": {
"default_value": "",
"default_value_type": "Normal",
"number_format": "yyyy/mm/dd"
}
},
{
"name": "时间",
"type": "Time",
"id": "R",
"data": {
"number_format": "hh:mm:ss;@"
}
},
{
"name": "数字",
"type": "Number",
"id": "S",
"data": {
"number_format": "0_ "
}
},
{
"name": "货币",
"type": "Currency",
"id": "T",
"data": {
"number_format": "$#,##0.000_ "
}
},
{
"name": "多行文本",
"type": "MultiLineText",
"id": "U",
"data": {
"unique_value": false
}
},
{
"name": "百分比",
"type": "Percentage",
"id": "V",
"data": {
"number_format": "0.00%"
}
},
{
"name": "身份证",
"type": "ID",
"id": "W",
"data": {
"unique_value": false
}
},
{
"name": "电话",
"type": "Phone",
"id": "X",
"data": {
"unique_value": false
}
},
{
"name": "最后修改者",
"type": "LastModifiedBy",
"id": "Y",
"data": {
"watch_all": true
}
},
{
"name": "最后修改时间",
"type": "LastModifiedTime",
"id": "Z",
"data": {
"number_format": "hh:mm:ss;@",
"watch_all": true
}
},
{
"name": "公式",
"type": "Formula",
"id": "a",
"data": {
"formula": "=[数字]+[货币]",
"number_format": "0_ ",
"value_type": ""
}
},
{
"name": "编号",
"type": "AutoNumber",
"id": "b",
"data": {
"number_format": "000000"
}
},
{
"name": "创建时间",
"type": "CreatedTime",
"id": "c",
"data": {
"number_format": "yyyy-mm-dd hh:mm;@"
}
},
{
"name": "超链接",
"type": "Url",
"id": "d",
"data": {
"display_text": "点击访问"
}
},
{
"name": "单选项",
"type": "SingleSelect",
"id": "e",
"data": {
"allow_add_item_while_inputting": true,
"items": [
{
"color": 4283466178,
"id": "G",
"value": "选项1"
},
{
"color": 4281378020,
"id": "H",
"value": "选项2"
}
]
}
},
{
"name": "多选项",
"type": "MultipleSelect",
"id": "f",
"data": {
"allow_add_item_while_inputting": true,
"items": [
{
"color": 4283466178,
"id": "I",
"value": "多选选项1"
},
{
"color": 4281378020,
"id": "J",
"value": "多选选项2"
}
]
}
},
{
"name": "等级",
"type": "Rating",
"id": "g",
"data": {
"max": 5
}
},
{
"name": "联系人",
"type": "Contact",
"id": "h",
"data": {
"default_value": "",
"default_value_type": "Normal",
"multiple_contacts": false,
"notice_new_contact": false,
"support_multi": false
}
},
{
"name": "联系人-指定人",
"type": "Contact",
"id": "i",
"data": {
"default_value": "",
"default_value_type": "Normal",
"multiple_contacts": true,
"notice_new_contact": false,
"support_multi": true
}
},
{
"name": "附件",
"type": "Attachment",
"id": "j",
"data": {
"only_upload_by_camera": false
}
},
{
"name": "地址",
"type": "Address",
"id": "k",
"data": {
"address_level": 3,
"detailed_address": true
}
},
{
"name": "富文本",
"type": "Note",
"id": "l",
"data": null
},
{
"name": "复选框",
"type": "Checkbox",
"id": "m",
"data": null
},
{
"name": "进度",
"type": "Complete",
"id": "n",
"data": null
},
{
"name": "邮箱",
"type": "Email",
"id": "o",
"data": null
},
{
"name": "创建人",
"type": "CreatedBy",
"id": "p",
"data": null
}
]
}
}