# ~~查询下拉列表设置~~

**注意：该接口于 2025 年 9 月 20 号起不可用，请使用最新接口[查询下拉列表设置](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/datavalidation/query-datavalidation)，更多详情可查看[表格数据校验下拉列表相关接口变更](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/breaking-change/datavalidation-dropdown-udpate)**。

查询电子表格工作表中指定范围的下拉列表的设置信息。

## 使用限制

单次查询范围不得超过 5000 行、100列。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation
HTTP Method | GET
接口频率限制 | [100 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 查看、评论、编辑和管理云空间中所有文件(drive:drive)<br>查看、评论、编辑和管理电子表格(sheets:spreadsheet)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | 通过访问凭证（access_token）对调用者身份进行鉴权。可选值：<br>- `tenant_access_token`：	租户授权凭证。应用代表租户（即企业或团队）执行对应操作。示例值："Bearer t-7f1bcd13fc57d46bac21793aabcef"<br>- `user_access_token`：用户授权凭证。应用代表用户执行对应操作。示例值："Bearer u-7f1bcd13fc57d46bac21793aabcef"<br>了解更多，参考[获取访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)。
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 路径参数

名称 | 类型 | 描述
---|---|---
spreadsheetToken | string | 电子表格的 token。可通过以下两种方式获取。了解更多，参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)。<br>-  电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef==<br>- 调用[获取文件夹中的文件清单](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) | **示例值**："Iow7sNNEphp3WbtnbCscPqabcef"

### 查询参数

参数 | 类型 | 必须 | 说明
---|---|---|---
range | string | 是 | 查询范围。格式为 `<sheetId>!<开始位置>:<结束位置>`。其中：<br>- `sheetId` 为工作表 ID，通过[获取工作表](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query) 获取<br>- `<开始位置>:<结束位置>` 为工作表中单元格的范围，数字表示行索引，字母表示列索引。如 `A2:B2` 表示该工作表第 2 行的 A 列到 B 列。`range`支持四种写法，详情参考[电子表格概述](https://open.feishu.cn/document/ukTMukTMukTM/uATMzUjLwEzM14CMxMTN/overview)
dataValidationType | string | 是 | 数据验证类型。取固定值 "list"，表示下拉列表。

###  cURL 请求示例
```bash
curl --location --request GET 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/dataValidation?&range=BzY8T5!A2:A100' \
--header 'Authorization: Bearer t-5be16bd570d0437444c40d5e6b5584109e61b0b1' \
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 状态码，0 代表成功
msg | string | 状态信息
data | / | 响应数据
spreadsheetToken | string | 电子表格的 token
sheetId | string | 工作表的 ID
revision | int | 工作表的版本号。从 0 开始计数，更新一次版本号加一。
dataValidations | array | 下拉列表数组， 不存在时为空
dataValidationId | int | 下拉列表的 ID
dataValidationType | string | 数据验证的类型。下拉列表为 "list"。
conditionValues | array&lt;string&gt; | 下拉列表选项的值
options | <md-text type="field-type"></md-text> | 下拉选项其它配置，包括是否支持多选、是否设置下拉选项样式等。
multipleValues | bool | 是否支持多选选项。可选值：<br>- false：不支持多选<br>- true：支持多选
highlightValidData | bool | 是否为下拉选项设置颜色。可选值：<br>- false：不设置颜色<br>- true：为下拉选项设置颜色
colorValueMap | map&lt;string,string&gt; | 指定的下拉选项的颜色。格式为 RGB 十六进制，如 "#fffd00"。颜色将与 conditionValues 中的值按顺序一一对应。

### 响应体示例

```json
{
    "code": 0,
    "data": {
        "dataValidations": [
            {
                "conditionValues": [
                    "true",
                    "2",
                    "1",
                    "33.3333",
                    "ss"
                ],
                "dataValidationId": 3,
                "dataValidationType": "list",
                "options": {
                    "colorValueMap": {
                        "1": "#b1e8fc",
                        "2": "#fed4a4",
                        "33.3333": "#f8e6ab",
                        "ss": "#a9efe6",
                        "true": "#bacefd"
                    },
                    "highlightValidData": true,
                    "multipleValues": true
                }
            }
        ],
        "revision": 78,
        "sheetId": "4d30c6",
        "spreadsheetToken": "shtbckBcolBlRfkcMVZbolMdADe"
    },
    "msg": "Success"
}
```  

### 错误码

具体可参考：[服务端错误码说明](https://open.feishu.cn/document/ukTMukTMukTM/ugjM14COyUjL4ITN)