删除下拉列表设置
注意:该接口于 2025 年 9 月 20 号起不可用,请使用最新接口删除下拉列表设置,更多详情可查看表格数据校验下拉列表相关接口变更。
删除电子表格工作表指定范围中下拉列表的设置,但仍保留选项文本。
使用限制
单次删除请求可指定多个范围,单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation |
| HTTP Method | DELETE |
| 接口频率限制 | 100 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 通过访问凭证(access_token)对调用者身份进行鉴权。可选值: - tenant_access_token: 租户授权凭证。应用代表租户(即企业或团队)执行对应操作。示例值:"Bearer t-7f1bcd13fc57d46bac21793aabcef" - user_access_token:用户授权凭证。应用代表用户执行对应操作。示例值:"Bearer u-7f1bcd13fc57d46bac21793aabcef" 了解更多,参考获取访问凭证。 |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| spreadsheetToken | string | 电子表格的 token。可通过以下两种方式获取。了解更多,参考电子表格概述。 - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 |
请求体
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| dataValidationRanges | array | 是 | 指定要删除的下拉列表的范围和 ID。可指定多个范围。 注意: - 删除某个范围失败不影响其它范围的执行。响应体中将返回每个范围的执行结果。 - 单个范围指定的单元格不可超过 5,000 个,范围的总数不可超过 100 个。 |
| └ range | string | 是 | 要删除的下拉列表的范围。格式为 !<开始位置>:<结束位置>。其中: - sheetId 为工作表 ID,通过获取工作表 获取 - <开始位置>:<结束位置> 为工作表中单元格的范围,数字表示行索引,字母表示列索引。如 A2:B2 表示该工作表第 2 行的 A 列到 B 列。range支持四种写法,详情参考电子表格概述 |
| └ dataValidationIds | array<int> | 是 | 要删除的下拉列表的 ID。可通过调用查询下拉列表设置获取 |
请求体示例
json
{
"dataValidationRanges":[
{
"range": "4d30c6!A10:C10",
"dataValidationIds": [1,2]
}
]
}cURL 请求示例
bash
curl --location --request DELETE 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/dataValidation' \
--header 'Authorization: Bearer t-ce3540c5f02ac074535f1f14d64fa90fa49621c0' \
--header 'Content-Type: application/json' \
--data-raw '{
"dataValidationRanges":[
{
"range": "BzY8T5!A1:A1",
"dataValidationIds": [2]
}
]
}'响应
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 状态码,0 代表成功 |
| msg | string | 状态信息 |
| data | / | 响应数据 |
| └ rangeResults | array | 删除下拉列表设置的结果 |
| └ range | string | 要删除的范围,与请求参数中 range 的值对应。 |
| └ msg | string | 结果信息 |
| └ success | bool | 是否成功删除该范围中的下拉列表设置。 |
| └ updatedCells | int | 影响的单元格总数 |
响应体示例
json
{
"code": 0,
"data": {
"rangeResults": [
{
"msg": "",
"range": "4d30c6!A10:C10",
"success": true,
"updatedCells": 3
}
]
},
"msg": "Success"
}错误码
具体可参考:服务端错误码说明
