查询下拉列表设置

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

使用限制

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

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/dataValidation
HTTP Method	GET
接口频率限制	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== - 调用获取文件夹中的文件清单

查询参数

参数	类型	必须	说明
range	string	是	查询范围。格式为 !<开始位置>:<结束位置>。其中： - sheetId 为工作表 ID，通过获取工作表 获取 - <开始位置>:<结束位置> 为工作表中单元格的范围，数字表示行索引，字母表示列索引。如 A2:B2 表示该工作表第 2 行的 A 列到 B 列。range支持四种写法，详情参考电子表格概述
dataValidationType	string	是	数据验证类型。取固定值 "list"，表示下拉列表。

cURL 请求示例

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	下拉列表数组， 不存在时为空
└ ranges	array<string>	下拉列表所属的范围，按照列进行聚合。 例如 4d30c6 子表中，A1、A2、A4、B1、B2 都是该下拉列表，则该下拉列表对应的 Ranges 为["4d30c6!A1:A2","4d30c6!A4:A4","4d30c6!B1:B2"]
└ dataValidationType	string	数据验证的类型。下拉列表为 "list"。
└ conditionValues	array<string>	下拉列表选项的值
└ options	``	下拉选项其它配置，包括是否支持多选、是否设置下拉选项样式等。
└ multipleValues	bool	是否支持多选选项。可选值： - false：不支持多选 - true：支持多选
└ highlightValidData	bool	是否为下拉选项设置颜色。可选值： - false：不设置颜色 - true：为下拉选项设置颜色
└ colorValueMap	map<string,string>	指定的下拉选项的颜色。格式为 RGB 十六进制，如 "#fffd00"。颜色将与 conditionValues 中的值按顺序一一对应。

响应体示例

{
    "code": 0,
    "data": {
        "dataValidations": [
            {
                "conditionValues": [
                    "true",
                    "2",
                    "1",
                    "33.3333",
                    "ss"
                ],
                "dataValidationType": "list",
                "options": {
                    "colorValueMap": {
                        "1": "#b1e8fc",
                        "2": "#fed4a4",
                        "33.3333": "#f8e6ab",
                        "ss": "#a9efe6",
                        "true": "#bacefd"
                    },
                    "highlightValidData": true,
                    "multipleValues": true
                }，
        		"ranges":[
        			"4d30c6!A1:A2",
        			"4d30c6!A4:A4",
        			"4d30c6!B1:B2"
        		]
            }
        ],
        "revision": 78,
        "sheetId": "4d30c6",
        "spreadsheetToken": "shtbckBcolBlRfkcMVZbolMdADe"
    },
    "msg": "Success"
}

错误码

具体可参考：服务端错误码说明