获取工作空间下的自定义枚举列表

获取工作空间下的自定义枚举列表

请求

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

请求头

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

路径参数

名称	类型	描述
workspace_id	string	工作空间id，可以从数据平台的 URL 中获取，如 https://apaas.feishu.cn/suda/workspace/workspace_aadimx5uzpsls/table-manage/main?tableId=table_1846786627963081&tab=objectManage 中的 workspace_aadimx5uzpsls 就是 workspace_id 示例值："workspace_aadimx5uzpsls"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小，用于限制一次请求所返回的数据条目数 示例值：10 默认值：10 数据校验规则： - 取值范围：0 ～ 500
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ+G8JG6tK7+ZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ items	workspace_enum\[\]	枚举列表
└ name	string	枚举名称
└ description	string	枚举描述
└ options	string\[\]	枚举值列表
└ created_at	int	创建时间，毫秒时间戳
└ created_by	workspace_user_info	创建人
└ id	string	用户 id，如 1693861178143800
└ name	string	用户姓名，如王小小
└ avatar	string	用户头像 URL

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": true,
        "page_token": "AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ+G8JG6tK7+ZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR",
        "items": [
            {
                "name": "enum_demo",
                "description": "enum_demo的描述",
                "options": [
                    "enum_a"
                ],
                "created_at": 1765524810744,
                "created_by": {
                    "id": "1693861178143800",
                    "name": "王小小",
                    "avatar": "https://xxx.image_url.com"
                }
            }
        ]
    }
}

错误码

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