# 获取所有节点 获取画板内所有的节点，节点以数组方式返回，可通过 parent_id（父节点）、children（子节点） 关系组装成画板内容。 ## 请求 基本 |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/board/v1/whiteboards/:whiteboard_id/nodes HTTP Method | GET 接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看画板节点(board:whiteboard:node:read) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) ### 路径参数 名称 | 类型 | 描述 ---|---|--- whiteboard_id | string | 画板唯一标识，可通过云文档下的文档接口 [获取文档所有块](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list) 获取，`block_type` 为 43 的 block 即为画板，对应的 block.token 就是画板的whiteboard_id
**示例值**："Ru8nwrWFOhEmaFbEU2VbPRsHcxb"
**数据校验规则**：
- 长度范围：`22` ～ `27` 字符 ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- nodes | whiteboard.node\[\] | 查询结果 id | string | 节点 id type | string | 节点图形类型
**可选值有**：
- image：图片属性
- text_shape：文本
- group：组合
- composite_shape：基础图形
- svg：svg 图形
- connector：连线
- table：表格
- life_line：对象生命线
- activation：控制焦点
- section：分区
- table_uml：类图
- table_er：实体关系图
- sticky_note：便签
- mind_map：思维导图
- paint：画笔
- combined_fragment：组合片段 parent_id | string | 父节点 id，为空是表示根节点 children | string\[\] | 子节点 x | number(float) | 图形相对画布的 x 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px y | number(float) | 图形相对画布的 y 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px angle | number(float) | 图形旋转角度，单位度 height | number(float) | 图形高度，单位为 px text | text | 图形内文字 text | string | 文字内容 font_weight | string | 文字字重
**可选值有**：
- regular：常规
- bold：加粗 font_size | int | 文字大小，单位 px horizontal_align | string | 水平对齐
**可选值有**：
- left：向左对齐
- center：居中对齐
- right：向右对齐 vertical_align | string | 垂直对齐
**可选值有**：
- top：顶部对齐
- mid：垂直居中
- bottom：底部对齐 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 angle | int | 文字旋转角度
**可选值有**：
- 0：文字旋转角度0度
- 90：文字旋转角度90度
- 180：文字旋转角度180度
- 270：文字旋转角度270度 theme_text_color_code | int | 文字颜色主题配色编码值 theme_text_background_color_code | int | 文字背景颜色主题配色编码值 rich_text | rich_text | 富文本 paragraphs | rich_text_paragraph\[\] | 段落列表 paragraph_type | int | 段落类别
**可选值有**：
- 0：普通段落
- 1：无序列表
- 2：有序列表 elements | rich_text_element\[\] | 元素列表 element_type | int | 元素类别
**可选值有**：
- 0：文本
- 1：链接
- 2：@用户
- 3：文档 text_element | rich_text_element_text | 文本类别信息，如果元素类别为文本时需要设置 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重(regular：常规,bold：加粗) font_size | int | 文字大小，单位 px text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 link_element | rich_text_element_link | 超链接类别信息，元素类别为链接时需要设置 herf | string | 链接 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_user_element | rich_text_element_mention_user | @用户类别信息，元素类别是@用户时候需要设置 user_id | string | 用户openID，可通过 [获取指定用户的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) 获取 text_style | rich_text_element_text_style | 文字属性 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_doc_element | rich_text_element_mention_doc | 文档类别信息，元素类别是文档时候需要设置 doc_url | string | 文档超链接 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 indent | int | 缩进 list_begin_index | int | 有序列表开始序号(第一个有序列表的序号为list_begin_index+1)
例如：list_begin_index = 0， 则第一个有序列表的序号为1 quote | boolean | 引用 text_color_type | int | 文字颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 text_background_color_type | int | 文字背景颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 style | style | 图形样式 fill_color | string | 填充颜色，16 进制 rbg 值 fill_opacity | number(float) | 填充透明度 border_style | string | 边框样式
**可选值有**：
- solid：实线
- none：无边框
- dash：虚线
- dot：点状虚线 border_width | string | 边框宽度
**可选值有**：
- extra_narrow：极细
- narrow：细
- medium：中
- bold：粗 border_opacity | number(float) | 边框透明度 h_flip | boolean | 水平翻折 v_flip | boolean | 垂直翻折 border_color | string | 边框颜色，16 进制 rgb 值 theme_fill_color_code | int | 填充颜色主题配色编码值 theme_border_color_code | int | 边框颜色主题配色编码值 fill_color_type | int | 填充颜色类型：0=系统颜色，取theme_fill_color_code，1=自定义颜色，取fill_color
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 border_color_type | int | 边框颜色类型：0=系统颜色，取theme_border_color_code，1=自定义颜色，取border_color
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 image | image | 图片 token | string | 图片 token composite_shape | composite_shape | 基础图形属性 type | string | 基础图形的具体类型
**可选值有**：
- round_rect2：全圆角矩形
- ellipse：圆形
- hexagon：六边形
- cylinder：圆柱体
- parallelogram：平行四边形
- trapezoid：梯形
- triangle：三角形
- round_rect：圆角矩形
- step：步骤
- diamond：菱形
- rect：基础矩形
- star：五角星
- bubble：气泡
- pentagon：五边形
- forward_arrow：单向箭头
- document_shape：文档图形
- condition_shape：组合片段
- cloud：云朵
- cross：十字形
- step2：步骤图形2
- predefined_process：预定义流程
- delay_shape：延迟图形
- off_page_connector：跨页引用
- note_shape：注释图形
- data_process：数据处理
- data_store：数据存储
- data_store2：数据存储2
- data_store3：数据存储3
- star2：爆炸星型
- star3：四角形
- star4：六角形
- actor：角色小人
- brace：花括号
- condition_shape2：组合片段2
- double_arrow：双向箭头
- data_flow_round_rect3：数据处理（正方圆角矩形）
- rect_bubble：矩形气泡
- manual_input：手动输入图形
- flow_chart_round_rect：流程图圆角矩形
- flow_chart_round_rect2：流程图全圆角矩形
- flow_chart_diamond：流程图判定
- flow_chart_parallelogram：流程图数据
- flow_chart_cylinder：流程图数据库
- flow_chart_trapezoid：流程图手动操作
- flow_chart_hexagon：流程图准备
- data_flow_round_rect：数据流外部实体
- data_flow_ellipse：数据流数据处理
- backward_arrow：反向箭头（左箭头）
- brace_reverse：反向花括号（左括号）
- flow_chart_mq：消息队列
- horiz_cylinder：水平方向圆柱体
- class_interface：类图，接口
- classifier：类图，类目
- circular_ring：圆环
- pie：扇形
- right_triangle：直角三角形
- octagon：八边形
- state_start：状态图，开始
- state_end：状态图，结束
- state_concurrence：状态图，并发
- component_shape：组件
- component_shape2：组件2
- component_interface：组件，接口
- component_required_interface：组件，需求接口
- component_assembly：组件，组装
- cube：立方体
- boundary：边界
- control：控制
- entity：实体
- data_base：数据库
- boundary：边界
- queue：队列
- collection：集合
- actor_lifeline：角色生命线
- object_lifeline：对象生命线
- mind_node_full_round_rect：思维导图全圆角矩形
- mind_node_round_rect：思维导图圆角矩形
- mind_node_text：思维导图文本图形 pie | pie | 饼图属性，type=pie时需要设置 start_radial_line_angle | number(float) | 开始径向边角度，水平向右x轴正方向为0度，顺时针方向角度值递增，单位度 central_angle | number(float) | 圆心角角度，角度方向为始径向边逆时针方向，单位度 radius | number(float) | 半径长度，单位 px sector_ratio | number(float) | 扇区占比，0为一个圆周线，1为一个圆盘 circular_ring | pie | 圆环属性，type=circular_ring时需要设置 start_radial_line_angle | number(float) | 开始径向边角度，水平向右x轴正方向为0度，顺时针方向角度值递增 central_angle | number(float) | 圆心角角度，角度方向为始径向边逆时针方向 radius | number(float) | 半径长度 sector_ratio | number(float) | 扇区占比，0为一个圆周线，1为一个圆盘 connector | connector | 连线属性 start_object | connector.attached_object | 开始连接节点信息（兼容线上数据，只读，写操作使用 start 字段，start_object 设置也不会生效） id | string | 连接图形的 id snap_to | string | 连接图形的方向
**可选值有**：
- auto：连接方向自动匹配
- top：连接图形顶部方向
- right：连接图形右边方向
- bottom：连接图形底部方向
- left：连接图形左边方向 position | point | 连接图形的相对坐标，0-1 x | number(float) | 点位置x坐标 y | number(float) | 点位置y坐标 end_object | connector.attached_object | 结束连接点信息（兼容线上数据， 只读，写操作使用 end 字段，写入时设置字段也不会生效） id | string | 连接图形的 id snap_to | string | 连接图形的方向
**可选值有**：
- auto：连接方向自动匹配
- top：连接图形顶部方向
- right：连接图形右边方向
- bottom：连接图形底部方向
- left：连接图形左边方向 position | point | 连接图形的相对坐标，0-1 x | number(float) | 点位置x坐标 y | number(float) | 点位置y坐标 start | connector_info | 连线端点信息 attached_object | connector.attached_object | 连接图形信息 id | string | 连接图形的 id snap_to | string | 连接图形的方向
**可选值有**：
- auto：连接方向自动匹配
- top：连接图形顶部方向
- right：连接图形右边方向
- bottom：连接图形底部方向
- left：连接图形左边方向 position | point | 连接图形的相对坐标，0-1 x | number(float) | 点位置x坐标 y | number(float) | 点位置y坐标 position | point | 连线端点在画布内的坐标，position与attached_object二选一，position与attached_object 同时设置时 attached_object 生效 x | number(float) | 点位置x坐标，单位百分比 y | number(float) | 点位置y坐标，单位百分比 arrow_style | string | 连线端点箭头样式
**可选值有**：
- none：无箭头样式
- line_arrow：线型箭头
- triangle_arrow：三角形箭头
- empty_triangle_arrow：空心三角形箭头
- circle_arrow：圆形箭头
- empty_circle_arrow：空心圆形箭头
- diamond_arrow：菱形箭头
- empty_diamond_arrow：空心菱形箭头
- single_arrow：单箭头
- multi_arrow：多箭头
- exact_single_arrow：精确单箭头
- zero_or_multi_arrow：零个或多个箭头
- zero_or_single_arrow：零个或单个箭头
- single_or_multi_arrow：单个或多个箭头
- x_arrow：x型箭头 end | connector_info | 连线端点信息 attached_object | connector.attached_object | 连接图形信息 id | string | 连接图形的 id snap_to | string | 连接图形的方向
**可选值有**：
- auto：连接方向自动匹配
- top：连接图形顶部方向
- right：连接图形右边方向
- bottom：连接图形底部方向
- left：连接图形左边方向 position | point | 连接图形的相对坐标，0-1 x | number(float) | 点位置x坐标 y | number(float) | 点位置y坐标 position | point | 连线端点在画布内的坐标，position与attached_object二选一，position与attached_object 同时设置时 attached_object 生效 x | number(float) | 点位置x坐标，单位百分比 y | number(float) | 点位置y坐标，单位百分比 arrow_style | string | 连线端点箭头样式
**可选值有**：
- none：无箭头样式
- line_arrow：线型箭头
- triangle_arrow：三角形箭头
- empty_triangle_arrow：空心三角形箭头
- circle_arrow：圆形箭头
- empty_circle_arrow：空心圆形箭头
- diamond_arrow：菱形箭头
- empty_diamond_arrow：空心菱形箭头
- single_arrow：单箭头
- multi_arrow：多箭头
- exact_single_arrow：精确单箭头
- zero_or_multi_arrow：零个或多个箭头
- zero_or_single_arrow：零个或单个箭头
- single_or_multi_arrow：单个或多个箭头
- x_arrow：x型箭头 captions | connector.caption | 连线文本 data | text\[\] | 文本 text | string | 文字内容 font_weight | string | 文字字重
**可选值有**：
- regular：常规
- bold：加粗 font_size | int | 文字大小，单位 px horizontal_align | string | 水平对齐
**可选值有**：
- left：向左对齐
- center：居中对齐
- right：向右对齐 vertical_align | string | 垂直对齐
**可选值有**：
- top：顶部对齐
- mid：垂直居中
- bottom：底部对齐 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 angle | int | 文字旋转角度
**可选值有**：
- 0：文字旋转角度0度
- 90：文字旋转角度90度
- 180：文字旋转角度180度
- 270：文字旋转角度270度 theme_text_color_code | int | 文字颜色主题配色编码值 theme_text_background_color_code | int | 文字背景颜色主题配色编码值 rich_text | rich_text | 富文本 paragraphs | rich_text_paragraph\[\] | 段落列表 paragraph_type | int | 段落类别
**可选值有**：
- 0：普通段落
- 1：无序列表
- 2：有序列表 elements | rich_text_element\[\] | 元素列表 element_type | int | 元素类别
**可选值有**：
- 0：文本
- 1：链接
- 2：@用户
- 3：文档 text_element | rich_text_element_text | 文本类别信息，如果元素类别为文本时需要设置 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 link_element | rich_text_element_link | 超链接类别信息，元素类别为链接时需要设置 herf | string | 链接 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_user_element | rich_text_element_mention_user | @用户类别信息，元素类别是@用户时候需要设置 user_id | string | 用户openID，可通过 [获取指定用户的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) 获取 text_style | rich_text_element_text_style | 文字属性 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_doc_element | rich_text_element_mention_doc | 文档类别信息，元素类别是文档时候需要设置 doc_url | string | 文档超链接 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 indent | int | 缩进 list_begin_index | int | 有序列表开始序号(第一个有序列表的序号为list_begin_index+1)
例如：list_begin_index = 0， 则第一个有序列表的序号为1 quote | boolean | 引用 text_color_type | int | 文字颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 text_background_color_type | int | 文字背景颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 shape | string | 连线类型
**可选值有**：
- straight：直线
- polyline：折线
- curve：曲线
- right_angled_polyline：直角折线 turning_points | point\[\] | 连线转向点 x | number(float) | 点位置x坐标，单位百分比 y | number(float) | 点位置y坐标，单位百分比 caption_auto_direction | boolean | 连线上的文本方向是否自动跟随连线方向 caption_position | number(float) | 文本在连线上的相对位置，范围0-1，0表示在连线的起始点，1表示在连线的终点 width | number(float) | 图形宽度，单位为 px section | section | 分区属性 title | string | 分区标题 table | table | 表格属性 meta | table.meta | 元信息 row_num | int | 行数 col_num | int | 列数 row_sizes | number(float)\[\] | 行高，单位 px col_sizes | number(float)\[\] | 列宽，单位 px style | style | 整个表格的样式 fill_color | string | 填充颜色，16 进制 rbg 值 fill_opacity | number(float) | 填充透明度 border_style | string | 边框样式
**可选值有**：
- solid：实线
- none：无边框
- dash：虚线
- dot：点状虚线 border_width | string | 边框宽度
**可选值有**：
- extra_narrow：极细
- narrow：细
- medium：中
- bold：粗 border_opacity | number(float) | 边框透明度 h_flip | boolean | 水平翻折 v_flip | boolean | 垂直翻折 border_color | string | 边框颜色，16 进制 rgb 值 theme_fill_color_code | int | 填充颜色主题配色编码值 theme_border_color_code | int | 边框颜色主题配色编码值 fill_color_type | int | 填充颜色类型：0=系统颜色，取theme_fill_color_code，1=自定义颜色，取fill_color
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 border_color_type | int | 边框颜色类型：0=系统颜色，取theme_border_color_code，1=自定义颜色，取border_color
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 text | text | 整个表格的文字样式 text | string | 文字内容 font_weight | string | 文字字重
**可选值有**：
- regular：常规
- bold：加粗 font_size | int | 文字大小，单位 px horizontal_align | string | 水平对齐
**可选值有**：
- left：向左对齐
- center：居中对齐
- right：向右对齐 vertical_align | string | 垂直对齐
**可选值有**：
- top：顶部对齐
- mid：垂直居中
- bottom：底部对齐 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 angle | int | 文字旋转角度
**可选值有**：
- 0：文字旋转角度0度
- 90：文字旋转角度90度
- 180：文字旋转角度180度
- 270：文字旋转角度270度 theme_text_color_code | int | 文字颜色主题配色编码值 theme_text_background_color_code | int | 文字背景颜色主题配色编码值 rich_text | rich_text | 富文本 paragraphs | rich_text_paragraph\[\] | 段落列表 paragraph_type | int | 段落类别
**可选值有**：
- 0：普通段落
- 1：无序列表
- 2：有序列表 elements | rich_text_element\[\] | 元素列表 element_type | int | 元素类别
**可选值有**：
- 0：文本
- 1：链接
- 2：@用户
- 3：文档 text_element | rich_text_element_text | 文本类别信息，如果元素类别为文本时需要设置 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 link_element | rich_text_element_link | 超链接类别信息，元素类别为链接时需要设置 herf | string | 链接 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_user_element | rich_text_element_mention_user | @用户类别信息，元素类别是@用户时候需要设置 user_id | string | 用户openID，可通过 [获取指定用户的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) 获取 text_style | rich_text_element_text_style | 文字属性 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_doc_element | rich_text_element_mention_doc | 文档类别信息，元素类别是文档时候需要设置 doc_url | string | 文档超链接 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 indent | int | 缩进 list_begin_index | int | 有序列表开始序号(第一个有序列表的序号为list_begin_index+1)
例如：list_begin_index = 0， 则第一个有序列表的序号为1 quote | boolean | 引用 text_color_type | int | 文字颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 text_background_color_type | int | 文字背景颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 title | string | 标题 cells | table.cell\[\] | 单元格列表 row_index | int | 行下标，从 1 开始 col_index | int | 列下标，从 1 开始 merge_info | table.cell.merge_info | 单元格合并信息 row_span | int | 从当前行索引起被合并的连续行数 col_span | int | 从当前列索引起被合并的连续列数 children | string\[\] | 单元格包含的子节点 id text | text | 单元格内文字 text | string | 文字内容 font_weight | string | 文字字重
**可选值有**：
- regular：常规
- bold：加粗 font_size | int | 文字大小，单位 px horizontal_align | string | 水平对齐
**可选值有**：
- left：向左对齐
- center：居中对齐
- right：向右对齐 vertical_align | string | 垂直对齐
**可选值有**：
- top：顶部对齐
- mid：垂直居中
- bottom：底部对齐 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 angle | int | 文字旋转角度
**可选值有**：
- 0：文字旋转角度0度
- 90：文字旋转角度90度
- 180：文字旋转角度180度
- 270：文字旋转角度270度 theme_text_color_code | int | 文字颜色主题配色编码值 theme_text_background_color_code | int | 文字背景颜色主题配色编码值 rich_text | rich_text | 富文本 paragraphs | rich_text_paragraph\[\] | 段落列表 paragraph_type | int | 段落类别
**可选值有**：
- 0：普通段落
- 1：无序列表
- 2：有序列表 elements | rich_text_element\[\] | 元素列表 element_type | int | 元素类别
**可选值有**：
- 0：文本
- 1：链接
- 2：@用户
- 3：文档 text_element | rich_text_element_text | 文本类别信息，如果元素类别为文本时需要设置 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 link_element | rich_text_element_link | 超链接类别信息，元素类别为链接时需要设置 herf | string | 链接 text | string | 文字 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_user_element | rich_text_element_mention_user | @用户类别信息，元素类别是@用户时候需要设置 user_id | string | 用户openID，可通过 [获取指定用户的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid) 获取 text_style | rich_text_element_text_style | 文字属性 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 mention_doc_element | rich_text_element_mention_doc | 文档类别信息，元素类别是文档时候需要设置 doc_url | string | 文档超链接 text_style | rich_text_element_text_style | 文字样式 font_weight | string | 文字字重 font_size | int | 文字大小 text_color | string | 文字颜色，16 进制 rgb 值 text_background_color | string | 文字背景色，16 进制 rgb 值 line_through | boolean | 是否存在删除线 underline | boolean | 是否存在下划线 italic | boolean | 是否斜体 indent | int | 缩进 list_begin_index | int | 有序列表开始序号(第一个有序列表的序号为list_begin_index+1)
例如：list_begin_index = 0， 则第一个有序列表的序号为1 quote | boolean | 引用 text_color_type | int | 文字颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 text_background_color_type | int | 文字背景颜色类型，0=系统颜色，1=自定义颜色
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 style | style | 单元格样式，设置后会覆盖表格样式 fill_color | string | 填充颜色，16 进制 rbg 值 fill_opacity | number(float) | 填充透明度 border_style | string | 边框样式
**可选值有**：
- solid：实线
- none：无边框
- dash：虚线
- dot：点状虚线 border_width | string | 边框宽度
**可选值有**：
- extra_narrow：极细
- narrow：细
- medium：中
- bold：粗 border_opacity | number(float) | 边框透明度 h_flip | boolean | 水平翻折 v_flip | boolean | 垂直翻折 border_color | string | 边框颜色，16 进制 rgb 值 theme_fill_color_code | int | 填充颜色主题配色编码值 theme_border_color_code | int | 边框颜色主题配色编码值 fill_color_type | int | 填充颜色类型：0=系统颜色，取theme_fill_color_code，1=自定义颜色，取fill_color
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 border_color_type | int | 边框颜色类型：0=系统颜色，取theme_border_color_code，1=自定义颜色，取border_color
**可选值有**：
- 0：系统颜色
- 1：自定义颜色 locked | boolean | 图形是否锁定 z_index | int | 图形在兄弟节点中的层级，层级大的会覆盖层级小的 lifeline | lifeline | 生命对象属性 size | number(float) | 生命线长度，单位 px type | string | 生命线类型 paint | paint | 画笔属性 type | string | 画笔类型
**可选值有**：
- marker：马克笔
- highlight：高亮笔 lines | point\[\] | 画板线段，由系列坐标点表示 x | number(float) | 点位置x坐标，单位 px y | number(float) | 点位置y坐标，单位 px width | int | 画笔粗细，单位px color | string | 画笔颜色 svg | svg | svg图形属性 svg_code | string | svg code sticky_note | sticky_note | 便签图形属性 user_id | string | 用户id show_author_info | boolean | 是否展示用户信息 mind_map_node | mind_map_node | 思维导图节点属性 parent_id | string | 思维导图节点的父节点，必须为思维导图节点 type | string | 思维导图节点图形类型
**可选值有**：
- mind_map_text：思维导图文本节点类型
- mind_map_full_round_rect：思维导图全圆角矩形节点类型
- mind_map_round_rect：思维导图矩形节点类型 z_index | int | 思维导图节点在兄弟节点中的位置index layout_position | string | 子节点相对根节点的方向（根节点下的子节点设置才生效）
**可选值有**：
- left：思维导图节点在根节点左侧
- right：思维导图节点在根节点右侧
- up：思维导图节点在根节点上方
- down：思维导图节点在根节点下方 children | string\[\] | 子节点列表 collapsed | boolean | 是否收起子节点 mind_map_root | mind_map_root | 思维导图根节点属性 layout | string | 思维导图布局方式
**可选值有**：
- up_down：上下布局
- left_right：左右布局
- tree_left：左树布局
- tree_right：右树布局
- tree_balance：左右交替平衡树布局
- vertical_time_line：垂直时间线布局
- horizontal_time_line：水平时间线布局 type | string | 思维导图根节点图形类型
**可选值有**：
- mind_map_text：思维导图文本节点类型
- mind_map_full_round_rect：思维导图全圆角矩形节点类型
- mind_map_round_rect：思维导图矩形节点类型 line_style | string | 思维导图图形连接线样式
**可选值有**：
- curve：曲线
- right_angle：直角折线
- round_angle：圆角折线 up_children | string\[\] | 思维导图上布局子节点关系树 down_children | string\[\] | 思维导图下布局子节点关系树 left_children | string\[\] | 思维导图左布局子节点关系树 right_children | string\[\] | 思维导图右布局子节点关系树 mind_map | mind_map | 思维导图节点（v1版本，只读，写操作请使用mind_map_root/mind_map_node结构） parent_id | string | 父节点id ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "nodes": [ { "id": "o1:1", "type": "composite_shape", "parent_id": "o1:1", "children": [ "o1:1" ], "x": 100, "y": 100, "angle": 100, "height": 100, "text": { "text": "文字内容", "font_weight": "regular", "font_size": 14, "horizontal_align": "center", "vertical_align": "mid", "text_color": "#6db5a3", "text_background_color": "#6db5a3", "line_through": true, "underline": true, "italic": true, "angle": 90, "theme_text_color_code": 0, "theme_text_background_color_code": -1, "rich_text": { "paragraphs": [ { "paragraph_type": 0, "elements": [ { "element_type": 0, "text_element": { "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "link_element": { "herf": "https://bytedance.larkoffice.com", "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_user_element": { "user_id": "ou_da5****************dfe", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_doc_element": { "doc_url": "https://bytedance.larkoffice.com/wiki/xxxxx", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } } } ], "indent": 0, "list_begin_index": 0, "quote": true } ] }, "text_color_type": 0, "text_background_color_type": 0 }, "style": { "fill_color": "#6db5a3", "fill_opacity": 50, "border_style": "solid", "border_width": "narrow", "border_opacity": 50, "h_flip": false, "v_flip": false, "border_color": "#6db5a3", "theme_fill_color_code": 3, "theme_border_color_code": 4, "fill_color_type": 0, "border_color_type": 0 }, "image": { "token": "EeSHb3qs9oSBXoxvw33bqtOsczb" }, "composite_shape": { "type": "circle", "pie": { "start_radial_line_angle": 30.0, "central_angle": 40.0, "radius": 10, "sector_ratio": 1 }, "circular_ring": { "start_radial_line_angle": 30.0, "central_angle": 40.0, "radius": 10, "sector_ratio": 1 } }, "connector": { "start_object": { "id": "o1:1", "snap_to": "auto", "position": { "x": 10, "y": 10 } }, "end_object": { "id": "o1:1", "snap_to": "auto", "position": { "x": 10, "y": 10 } }, "start": { "attached_object": { "id": "o1:1", "snap_to": "auto", "position": { "x": 10, "y": 10 } }, "position": { "x": 0.5, "y": 0.5 }, "arrow_style": "line_arrow" }, "end": { "attached_object": { "id": "o1:1", "snap_to": "auto", "position": { "x": 10, "y": 10 } }, "position": { "x": 0.5, "y": 0.5 }, "arrow_style": "line_arrow" }, "captions": { "data": [ { "text": "文字内容", "font_weight": "regular", "font_size": 14, "horizontal_align": "center", "vertical_align": "mid", "text_color": "#6db5a3", "text_background_color": "#6db5a3", "line_through": true, "underline": true, "italic": true, "angle": 90, "theme_text_color_code": 0, "theme_text_background_color_code": -1, "rich_text": { "paragraphs": [ { "paragraph_type": 0, "elements": [ { "element_type": 0, "text_element": { "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "link_element": { "herf": "https://bytedance.larkoffice.com", "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_user_element": { "user_id": "ou_da5****************dfe", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_doc_element": { "doc_url": "https://bytedance.larkoffice.com/wiki/xxxxx", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } } } ], "indent": 0, "list_begin_index": 0, "quote": true } ] }, "text_color_type": 0, "text_background_color_type": 0 } ] }, "shape": "straight", "turning_points": [ { "x": 0.5, "y": 0.5 } ], "caption_auto_direction": true, "caption_position": 0.5 }, "width": 100, "section": { "title": "分区" }, "table": { "meta": { "row_num": 3, "col_num": 2, "row_sizes": [ 0.5 ], "col_sizes": [ 0.5 ], "style": { "fill_color": "#6db5a3", "fill_opacity": 50, "border_style": "solid", "border_width": "bold", "border_opacity": 50, "h_flip": false, "v_flip": false, "border_color": "#6db5a3", "theme_fill_color_code": 3, "theme_border_color_code": 4, "fill_color_type": 0, "border_color_type": 0 }, "text": { "text": "文字内容", "font_weight": "regular", "font_size": 14, "horizontal_align": "center", "vertical_align": "mid", "text_color": "#6db5a3", "text_background_color": "#6db5a3", "line_through": true, "underline": true, "italic": true, "angle": 90, "theme_text_color_code": 0, "theme_text_background_color_code": -1, "rich_text": { "paragraphs": [ { "paragraph_type": 0, "elements": [ { "element_type": 0, "text_element": { "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "link_element": { "herf": "https://bytedance.larkoffice.com", "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_user_element": { "user_id": "ou_da5****************dfe", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_doc_element": { "doc_url": "https://bytedance.larkoffice.com/wiki/xxxxx", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } } } ], "indent": 0, "list_begin_index": 0, "quote": true } ] }, "text_color_type": 0, "text_background_color_type": 0 } }, "title": "表格", "cells": [ { "row_index": 1, "col_index": 1, "merge_info": { "row_span": 2, "col_span": 2 }, "children": [ "o1:1" ], "text": { "text": "文字内容", "font_weight": "regular", "font_size": 14, "horizontal_align": "center", "vertical_align": "mid", "text_color": "#6db5a3", "text_background_color": "#6db5a3", "line_through": true, "underline": true, "italic": true, "angle": 90, "theme_text_color_code": 0, "theme_text_background_color_code": -1, "rich_text": { "paragraphs": [ { "paragraph_type": 0, "elements": [ { "element_type": 0, "text_element": { "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "link_element": { "herf": "https://bytedance.larkoffice.com", "text": "示例文案", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_user_element": { "user_id": "ou_da5****************dfe", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } }, "mention_doc_element": { "doc_url": "https://bytedance.larkoffice.com/wiki/xxxxx", "text_style": { "font_weight": "bold", "font_size": 14, "text_color": "#000000", "text_background_color": "#000000", "line_through": true, "underline": true, "italic": true } } } ], "indent": 0, "list_begin_index": 0, "quote": true } ] }, "text_color_type": 0, "text_background_color_type": 0 }, "style": { "fill_color": "#6db5a3", "fill_opacity": 50, "border_style": "solid", "border_width": "narrow", "border_opacity": 50, "h_flip": false, "v_flip": false, "border_color": "#6db5a3", "theme_fill_color_code": 3, "theme_border_color_code": 4, "fill_color_type": 0, "border_color_type": 0 } } ] }, "locked": true, "z_index": 1, "lifeline": { "size": 10, "type": "actor_lifeline" }, "paint": { "type": "marker", "lines": [ { "x": 10, "y": 10 } ], "width": 7, "color": "#ffffff" }, "svg": { "svg_code": "code" }, "sticky_note": { "user_id": "1234237", "show_author_info": true }, "mind_map_node": { "parent_id": "12345678", "type": "mind_map_round_rect", "z_index": 2, "layout_position": "left", "children": [ "z2:3" ], "collapsed": true }, "mind_map_root": { "layout": "left_right", "type": "mind_map_text", "line_style": "round_angle", "up_children": [ "z1:1" ], "down_children": [ "z2:1" ], "left_children": [ "z3:1" ], "right_children": [ "z4:1" ] }, "mind_map": { "parent_id": "z1:1" } } ] } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 2890001 | invalid format | 参数格式不正确。请检查传入的参数格式，如 json 字符串是否正确 400 | 2890002 | invalid arg | 参数无效。请检查传入的参数是否有效，如 whiteboard_id 是否正确，可通过云文档下的文档接口[获取文档所有块](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list)获取正确的`whiteboard_id` 400 | 2890003 | record missing | 找不到记录。whiteboard_id 不存在，可能是 whiteboard_id 不存在或拼写错误。请检查传入的 whiteboard_id 是否正确，可通过云文档下的文档接口[获取文档所有块](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list)获取正确的 whiteboard_id（block_type 为 43 的 block 对应的 block.token 即为 whiteboard_id） 401 | 2890004 | auth failed | 认证失败。请检查 Authorization 参数 403 | 2890005 | forbidden | 请求身份没有当前画板的阅读权限。请参考[云文档常见问题 3](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#78a03ee2)开通权限 429 | 2890006 | too many request | 请求超过接口频率限流值。请降低操作频率，稍后再试 500 | 2891001 | server internal error | 服务运行错误。请重试或联系[技术支持](https://applink.feishu.cn/TLJpeNdW)