获取自定义枚举详细信息

获取应用下的自定义枚举详细信息，包括枚举名称、描述、枚举值列表等字段信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/spark/v1/apps/:app_id/enums/:enum_name
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	spark:app.table:read 读取数据表相关信息 spark:app.table:write 修改数据表相关信息

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
app_id	string	妙搭应用 id，可从妙搭应用 URL 中获取，如 https://miaoda.feishu.cn/app/app_4jcn5n11bpf5v 中的 app_4jcn5n11bpf5v 即为 app_id 示例值："app_4jcn5n11bpf5v"
enum_name	string	枚举名称，可以从获取自定义枚举列表接口返回列表中，获取到枚举名称。 示例值："enum_demo_1"

查询参数

名称	类型	必填	描述
env	string	否	访问的 database 环境，默认为 online（线上环境） 示例值：online、dev 默认值：online

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ name	string	枚举名称
└ description	string	枚举描述
└ options	string\[\]	枚举值列表
└ created_at	string	创建时间，毫秒时间戳

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "name": "enum_name",
        "description": "enum描述",
        "options": [
            "enum_1"
        ],
        "created_at": "1765441837625"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	3340001	param is invalid	请检查请求参数的类型、格式或值是否符合接口要求，具体可参考请求参数说明中的数据校验规则。