获取画板主题
获取画板主题，不同主题下有不同的默认配色，具体主题介绍可以参考主题简介 。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/board/v1/whiteboards/:whiteboard_id/theme |
| HTTP Method | GET |
| 接口频率限制 | 20 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | board:whiteboard:node:read 查看画板节点 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
whiteboard_id | string | 画板标识，可通过云文档下的文档接口 获取文档所有块 获取，block_type 为 43 的 block 即为画板，对应的 block.token 就是画板的whiteboard_id示例值："Ud8xwWH01hO5mwbakqHbHeqmcCI" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ theme | string | 主题 可选值有： - classic: 经典主题 - minimalist_gray: 简约灰主题 - retro: 复古主题 - vibrant_color: 炫彩主题 - minimalist_blue: 简约蓝主题 - default: 默认主题 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"theme": "classic"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 2890001 | invalid format | 参数格式不正确。请检查传入的参数格式，如 json 字符串是否正确 |
| 400 | 2890002 | invalid arg | 参数无效。请检查传入的参数是否有效，如 whiteboard_id 是否正确 |
| 400 | 2890003 | record missing | 找不到记录。whiteboard_id 不存在，确认 whiteboard_id 正确性，可通过云文档下的文档接口获取文档所有块获取正确的whiteboard_id |
| 401 | 2890004 | auth failed | 认证失败。请检查 Authorization 参数 |
| 403 | 2890005 | forbidden | 请求身份没有当前画板的阅读权限。请参考云文档常见问题 3开通权限 |
| 429 | 2890006 | too many request | 请求超过接口频率限流值。请稍后再试 |
| 500 | 2891001 | server internal error | 服务运行错误。请重试或联系技术支持 |