Skip to content

创建画板节点

创建画板节点,支持批量创建、创建含父子关系的节点等。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/board/v1/whiteboards/:whiteboard_id/nodes
HTTP MethodPOST
接口频率限制50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用board:whiteboard:node:create 创建画板节点
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
whiteboard_idstring画板唯一标识,可通过云文档下的文档接口 获取文档所有块 获取,block_type 为 43 的 block 即为画板,对应的 block.token 就是画板的whiteboard_id
示例值:"Ru8nwrWFOhEmaFbEU2VbPRsHcxb"
数据校验规则
- 长度范围:2227 字符

查询参数

名称类型必填描述
client_tokenstring操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作
示例值:fe599b60-450f-46ff-b2ef-9f6675625b9
数据校验规则
- 长度范围:1064 字符
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
nodeswhiteboard.node\[\]子节点数据,不允许传入空数组
数据校验规则
- 长度范围:13000
  └ idstring节点 id,用于唯一标识此节点,不能重复,在创建父子节点、关联其它节点做标记使用
示例值:"o1:1"
数据校验规则
- 长度范围:0100 字符
  └ typestring节点图形类型
示例值:"composite_shape"
可选值有
- 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_idstring父节点 id,必须是已存在的节点或者在本次创建的节点列表内
示例值:"n1:1"
数据校验规则
- 长度范围:0100 字符
  └ xnumber(float)图形相对画布的 x 轴位置信息(存在父容器时为相对父容器的坐标,父容器为组合图形 group 时,坐标是穿透的),单位为 px
示例值:100
默认值0
数据校验规则
- 取值范围:-132070132070
  └ ynumber(float)图形相对画布的 y 轴位置信息(存在父容器时为相对父容器的坐标,父容器为组合图形 group 时,坐标是穿透的),单位为 px
示例值:100
默认值0
数据校验规则
- 取值范围:-132070132070
  └ anglenumber(float)图形旋转角度,单位度
示例值:100
默认值0
数据校验规则
- 取值范围:-180180
  └ heightnumber(float)图形高度,单位为 px
示例值:100
数据校验规则
- 取值范围:0132070
  └ texttext图形内文字(节点类型为 text_shape 时,该字段不能为空)(节点类型为group、section,connector、paint、svg、activation时候,该字段必须为空)
    └ textstring文字内容
示例值:"文字内容"
数据校验规则
- 长度范围:01024 字符
    └ font_weightstring文字字重
示例值:"regular"
可选值有
- regular: 常规 - bold: 加粗
    └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
    └ horizontal_alignstring水平对齐
示例值:"center"
可选值有
- left: 向左对齐 - center: 居中对齐 - right: 向右对齐
    └ vertical_alignstring垂直对齐
示例值:"mid"
可选值有
- top: 顶部对齐 - mid: 垂直居中 - bottom: 底部对齐
    └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
    └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
    └ line_throughboolean是否存在删除线
示例值:true
    └ underlineboolean是否存在下划线
示例值:true
    └ italicboolean是否斜体
示例值:true
    └ angleint文字旋转角度,单位度
示例值:90
可选值有
- 0: 文字旋转角度0度 - 90: 文字旋转角度90度 - 180: 文字旋转角度180度 - 270: 文字旋转角度270度
数据校验规则
- 取值范围:0270
    └ theme_text_color_codeint文字颜色主题配色编码值
示例值:0
数据校验规则
- 取值范围:-2100
    └ theme_text_background_color_codeint文字背景颜色主题配色编码值
示例值:-1
数据校验规则
- 取值范围:-2100
    └ rich_textrich_text富文本(富文本有值时候会覆盖上面的text信息) 如果整段文本只有一个样式,不推荐使用富文本
      └ paragraphsrich_text_paragraph\[\]段落列表
数据校验规则
- 长度范围:01000
        └ paragraph_typeint段落类别
示例值:0
可选值有
- 0: 普通段落 - 1: 无序列表 - 2: 有序列表
        └ elementsrich_text_element\[\]段落的元素列表
数据校验规则
- 长度范围:01000
          └ element_typeint元素类别
示例值:0
可选值有
- 0: 文本 - 1: 超链接 - 2: @用户 - 3: 文档
          └ text_elementrich_text_element_text文本元素信息(当前元素为文本类别时候需要填写当前字段)
            └ textstring文字(文字中不能包含换行符)
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
            └ text_stylerich_text_element_text_style文字样式
              └ font_weightstring文字字重(可选值有:regular:常规, bold:加粗)
示例值:"bold"
数据校验规则
- 长度范围:010 字符
              └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
数据校验规则
- 取值范围:01000
              └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ line_throughboolean是否存在删除线
示例值:true
              └ underlineboolean是否存在下划线
示例值:false
              └ italicboolean是否斜体
示例值:true
          └ link_elementrich_text_element_link超链接类别信息(当前元素为链接类别时候需要有当前字段)
            └ herfstring链接
示例值:"https://bytedance.larkoffice.com"
数据校验规则
- 长度范围:01000 字符
            └ textstring超链接的文字(为空时会默认文字为超链接)
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
            └ text_stylerich_text_element_text_style文字样式
              └ font_weightstring文字字重 (regular:常规,bold:加粗)
示例值:"bold"
数据校验规则
- 长度范围:010 字符
              └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
数据校验规则
- 取值范围:01000
              └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ line_throughboolean是否存在删除线
示例值:true
              └ underlineboolean是否存在下划线
示例值:true
              └ italicboolean是否斜体
示例值:true
          └ mention_user_elementrich_text_element_mention_user@用户类别信息(当前元素为@用户类别时候需要有当前字段)
            └ user_idstring用户openID,可通过 获取指定用户的 Open ID 获取
示例值:"ou_da5****************dfe"
            └ text_stylerich_text_element_text_style文字属性
              └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
              └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
数据校验规则
- 取值范围:01000
              └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ line_throughboolean是否存在删除线
示例值:true
              └ underlineboolean是否存在下划线
示例值:true
              └ italicboolean是否斜体
示例值:true
          └ mention_doc_elementrich_text_element_mention_doc文档类别信息(当前元素为文档类别时候需要有当前字段)
            └ doc_urlstring文档超链接
示例值:"https://bytedance.larkoffice.com/wiki/xxxxx"
数据校验规则
- 长度范围:01000 字符
            └ text_stylerich_text_element_text_style文字样式
              └ font_weightstring文字字重(regular:常规,bold:加粗)
示例值:"bold"
数据校验规则
- 长度范围:010 字符
              └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
              └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
              └ line_throughboolean是否存在删除线
示例值:true
              └ underlineboolean是否存在下划线
示例值:true
              └ italicboolean是否斜体
示例值:true
        └ indentint缩进(单位:字符)
示例值:0
数据校验规则
- 取值范围:0100
        └ list_begin_indexint有序列表开始序号(第一个有序列表的序号为list_begin_index+1) 例如:list_begin_index = 0, 则第一个有序列表的序号为1
示例值:0
数据校验规则
- 取值范围:010000
        └ quoteboolean引用
示例值:true
    └ text_color_typeint文字颜色类型,0=系统颜色(取theme_text_color_code),1=自定义颜色(取text_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
    └ text_background_color_typeint文字背景颜色类型,0=系统颜色(取theme_text_background_color_code),1=自定义颜色(取text_background_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
  └ stylestyle图形样式(节点类型为group、paint时,该字段必须为空)
    └ fill_colorstring填充颜色,16 进制 rbg 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
    └ fill_opacitynumber(float)填充透明度,百分比
示例值:50
数据校验规则
- 取值范围:0100
    └ border_stylestring边框样式
示例值:"solid"
可选值有
- solid: 实线 - none: 无边框 - dash: 虚线 - dot: 点状虚线
    └ border_widthstring边框宽度
示例值:"narrow"
可选值有
- extra_narrow: 极细 - narrow: 细 - medium: 中 - bold: 粗
    └ border_opacitynumber(float)边框透明度,百分比
示例值:50
数据校验规则
- 取值范围:0100
    └ h_flipboolean水平翻折
示例值:false
    └ v_flipboolean垂直翻折
示例值:false
    └ border_colorstring边框颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
    └ theme_fill_color_codeint填充颜色主题配色编码值
示例值:3
数据校验规则
- 取值范围:-2100
    └ theme_border_color_codeint边框颜色主题配色编码值
示例值:4
数据校验规则
- 取值范围:-2100
    └ fill_color_typeint填充颜色类型:0=系统颜色,取theme_fill_color_code,1=自定义颜色,取fill_color
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
    └ border_color_typeint边框颜色类型:0=系统颜色,取theme_border_color_code,1=自定义颜色,取border_color
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
  └ imageimage图片
    └ tokenstring图片 token,通过云文档下的素材上传接口 上传素材 上传图片后返回的 token
示例值:"EeSHb3qs9oSBXoxvw33bqtOsczb"
数据校验规则
- 长度范围:2227 字符
  └ composite_shapecomposite_shape基础图形属性(节点的 type 为 composite_shape 时不可为空)
    └ typestring基础图形的具体类型
示例值:"circle"
可选值有
- 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: 思维导图文本图形
    └ piepie饼图属性,type=pie时需要设置
      └ start_radial_line_anglenumber(float)开始径向边角度,水平向右x轴正方向为0度,顺时针方向角度值递增,单位度
示例值:30.0
数据校验规则
- 取值范围:0.0360.0
      └ central_anglenumber(float)圆心角角度,角度方向为始径向边逆时针方向,单位度
示例值:40.0
数据校验规则
- 取值范围:0.0360.0
      └ radiusnumber(float)半径长度,单位 px
示例值:10
数据校验规则
- 取值范围:110000000000
      └ sector_rationumber(float)扇区占比,0为一个圆周线,1为一个圆盘
示例值:1
默认值1
数据校验规则
- 取值范围:01
    └ circular_ringpie圆环属性,type=circular_ring时需要设置
      └ start_radial_line_anglenumber(float)开始径向边角度,水平向右x轴正方向为0度,顺时针方向角度值递增
示例值:30.0
数据校验规则
- 取值范围:0.0360.0
      └ central_anglenumber(float)圆心角角度,角度方向为始径向边逆时针方向
示例值:40.0
数据校验规则
- 取值范围:0.0360.0
      └ radiusnumber(float)半径长度
示例值:10
数据校验规则
- 取值范围:110000000000
      └ sector_rationumber(float)扇区占比,0为一个圆周线,1为一个圆盘
示例值:1
默认值1
数据校验规则
- 取值范围:01
  └ connectorconnector连线属性(节点类型为connector时,该字段不可为空)
    └ startconnector_info连线端点信息
      └ attached_objectconnector.attached_object连接图形信息,与position参数二选一,同时设置时attached_object生效
        └ idstring连接图形的 id
示例值:"o1:1"
数据校验规则
- 长度范围:0100 字符
        └ snap_tostring连接图形的方向
示例值:"auto"
可选值有
- auto: 连接方向自动匹配 - top: 连接图形顶部方向 - right: 连接图形右边方向 - bottom: 连接图形底部方向 - left: 连接图形左边方向
数据校验规则
- 长度范围:0100 字符
        └ positionpoint连接图形的相对坐标,0-1
          └ xnumber(float)点位置x坐标,单位百分比
示例值:0.5
数据校验规则
- 取值范围:-10000000000000000001000000000000000000
          └ ynumber(float)点位置y坐标,单位百分比
示例值:0.5
数据校验规则
- 取值范围:-10000000000000000000100000000000000000000
      └ positionpoint连线端点在画布内的坐标,position与attached_object二选一,position与attached_object 同时设置时 attched_object 生效
        └ xnumber(float)点位置x坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000001000000000000000000
        └ ynumber(float)点位置y坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000000100000000000000000000
      └ arrow_stylestring连线端点箭头样式
示例值:"line_arrow"
可选值有
- 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型箭头
数据校验规则
- 长度范围:0100 字符
    └ endconnector_info连线端点信息
      └ attached_objectconnector.attached_object连接图形信息,与position参数二选一,同时设置时attached_object生效
        └ idstring连接图形的 id
示例值:"o1:1"
数据校验规则
- 长度范围:0100 字符
        └ snap_tostring连接图形的方向
示例值:"auto"
可选值有
- auto: 连接方向自动匹配 - top: 连接图形顶部方向 - right: 连接图形右边方向 - bottom: 连接图形底部方向 - left: 连接图形左边方向
数据校验规则
- 长度范围:0100 字符
        └ positionpoint连接图形的相对坐标,0-1
          └ xnumber(float)点位置x坐标,单位百分比
示例值:0.5
数据校验规则
- 取值范围:-10000000000000000001000000000000000000
          └ ynumber(float)点位置y坐标,单位百分比
示例值:0.5
数据校验规则
- 取值范围:-10000000000000000000100000000000000000000
      └ positionpoint连线端点在画布内的坐标,position与attached_object二选一,position与attached_object 同时设置时 attached_object 生效
        └ xnumber(float)点位置x坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000001000000000000000000
        └ ynumber(float)点位置y坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000000100000000000000000000
      └ arrow_stylestring连线端点箭头样式
示例值:"line_arrow"
可选值有
- 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型箭头
数据校验规则
- 长度范围:0100 字符
    └ captionsconnector.caption连线文本
      └ datatext\[\]文本
数据校验规则
- 长度范围:01024
        └ textstring文字内容
示例值:"文字内容"
数据校验规则
- 长度范围:01024 字符
        └ font_weightstring文字字重
示例值:"regular"
可选值有
- regular: 常规 - bold: 加粗
        └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
        └ horizontal_alignstring水平对齐
示例值:"center"
可选值有
- left: 向左对齐 - center: 居中对齐 - right: 向右对齐
        └ vertical_alignstring垂直对齐
示例值:"mid"
可选值有
- top: 顶部对齐 - mid: 垂直居中 - bottom: 底部对齐
        └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ line_throughboolean是否存在删除线
示例值:true
        └ underlineboolean是否存在下划线
示例值:true
        └ italicboolean是否斜体
示例值:true
        └ angleint文字旋转角度,单位度
示例值:90
可选值有
- 0: 文字旋转角度0度 - 90: 文字旋转角度90度 - 180: 文字旋转角度180度 - 270: 文字旋转角度270度
数据校验规则
- 取值范围:0270
        └ theme_text_color_codeint文字颜色主题配色编码值
示例值:0
数据校验规则
- 取值范围:-2100
        └ theme_text_background_color_codeint文字背景颜色主题配色编码值
示例值:-1
数据校验规则
- 取值范围:-2100
        └ rich_textrich_text富文本
          └ paragraphsrich_text_paragraph\[\]段落列表
数据校验规则
- 长度范围:01000
            └ paragraph_typeint段落类别
示例值:0
可选值有
- 0: 普通段落 - 1: 无序列表 - 2: 有序列表
            └ elementsrich_text_element\[\]元素列表
数据校验规则
- 长度范围:01000
              └ element_typeint元素类别
示例值:0
可选值有
- 0: 文本 - 1: 链接 - 2: @用户 - 3: 文档
              └ text_elementrich_text_element_text文本类别信息
                └ textstring文字
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ link_elementrich_text_element_link超链接类别信息
                └ herfstring链接
示例值:"https://bytedance.larkoffice.com"
数据校验规则
- 长度范围:01000 字符
                └ textstring文字
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ mention_user_elementrich_text_element_mention_user@用户类别信息
                └ user_idstring用户openID,可通过 获取指定用户的 Open ID 获取
示例值:"ou_da5****************dfe"
                └ text_stylerich_text_element_text_style文字属性
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ mention_doc_elementrich_text_element_mention_doc文档类别信息
                └ doc_urlstring文档超链接
示例值:"https://bytedance.larkoffice.com/wiki/xxxxx"
数据校验规则
- 长度范围:01000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
            └ indentint缩进(单位:字符)
示例值:0
数据校验规则
- 取值范围:0100
            └ list_begin_indexint有序列表开始序号(第一个有序列表的序号为list_begin_index+1) 例如:list_begin_index = 0, 则第一个有序列表的序号为1
示例值:0
数据校验规则
- 取值范围:010000
            └ quoteboolean引用
示例值:true
        └ text_color_typeint文字颜色类型,0=系统颜色(取theme_text_color_code),1=自定义颜色(取text_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
        └ text_background_color_typeint文字背景颜色类型,0=系统颜色(取theme_text_background_color_code),1=自定义颜色(取text_background_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
    └ shapestring连线类型
示例值:"straight"
可选值有
- straight: 直线 - polyline: 折线 - curve: 曲线 - right_angled_polyline: 直角折线
数据校验规则
- 长度范围:0100 字符
    └ turning_pointspoint\[\]连线转向点
数据校验规则
- 长度范围:01000000
      └ xnumber(float)点位置x坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000001000000000000000000
      └ ynumber(float)点位置y坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000000100000000000000000000
    └ caption_auto_directionboolean连线上的文本方向是否自动跟随连线方向
示例值:true
    └ caption_positionnumber(float)文本在连线上的相对位置,范围0-1,0表示在连线的起始点,1表示在连线的终点
示例值:0.5
数据校验规则
- 取值范围:01
  └ widthnumber(float)图形宽度,单位为 px
示例值:100
数据校验规则
- 取值范围:0132070
  └ sectionsection分区属性
    └ titlestring分区标题
示例值:"分区"
数据校验规则
- 长度范围:01024 字符
  └ tabletable表格属性(节点类型为table、table_er、table_uml、combined_fragment时,该字段不可为空)
    └ metatable.meta元信息
      └ row_sizesnumber(float)\[\]行高,单位 px
示例值:[10]
数据校验规则
- 长度范围:1100
      └ col_sizesnumber(float)\[\]列宽,单位 px
示例值:[10]
数据校验规则
- 长度范围:11000000
      └ stylestyle整个表格的样式
        └ fill_colorstring填充颜色,16 进制 rbg 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ fill_opacitynumber(float)填充透明度,百分比
示例值:50
数据校验规则
- 取值范围:0100
        └ border_stylestring边框样式
示例值:"solid"
可选值有
- solid: 实线 - none: 无边框 - dash: 虚线 - dot: 点状虚线
        └ border_widthstring边框宽度
示例值:"narrow"
可选值有
- extra_narrow: 极细 - narrow: 细 - medium: 中 - bold: 粗
        └ border_opacitynumber(float)边框透明度,百分比
示例值:50
数据校验规则
- 取值范围:0100
        └ h_flipboolean水平翻折
示例值:false
        └ v_flipboolean垂直翻折
示例值:false
        └ border_colorstring边框颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ theme_fill_color_codeint填充颜色主题配色编码值
示例值:3
数据校验规则
- 取值范围:-2100
        └ theme_border_color_codeint边框颜色主题配色编码值
示例值:4
数据校验规则
- 取值范围:-2100
        └ fill_color_typeint填充颜色类型:0=系统颜色,取theme_fill_color_code,1=自定义颜色,取fill_color
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
        └ border_color_typeint边框颜色类型:0=系统颜色,取theme_border_color_code,1=自定义颜色,取border_color
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
      └ texttext整个表格的文字样式
        └ textstring文字内容
示例值:"文字内容"
数据校验规则
- 长度范围:01024 字符
        └ font_weightstring文字字重
示例值:"regular"
可选值有
- regular: 常规 - bold: 加粗
        └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
        └ horizontal_alignstring水平对齐
示例值:"center"
可选值有
- left: 向左对齐 - center: 居中对齐 - right: 向右对齐
        └ vertical_alignstring垂直对齐
示例值:"mid"
可选值有
- top: 顶部对齐 - mid: 垂直居中 - bottom: 底部对齐
        └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ line_throughboolean是否存在删除线
示例值:true
        └ underlineboolean是否存在下划线
示例值:true
        └ italicboolean是否斜体
示例值:true
        └ angleint文字旋转角度,单位度
示例值:90
可选值有
- 0: 文字旋转角度0度 - 90: 文字旋转角度90度 - 180: 文字旋转角度180度 - 270: 文字旋转角度270度
数据校验规则
- 取值范围:0270
        └ theme_text_color_codeint文字颜色主题配色编码值
示例值:0
数据校验规则
- 取值范围:-2100
        └ theme_text_background_color_codeint文字背景颜色主题配色编码值
示例值:-1
数据校验规则
- 取值范围:-2100
        └ rich_textrich_text富文本
          └ paragraphsrich_text_paragraph\[\]段落列表
数据校验规则
- 长度范围:01000
            └ paragraph_typeint段落类别
示例值:0
可选值有
- 0: 普通段落 - 1: 无序列表 - 2: 有序列表
            └ elementsrich_text_element\[\]元素列表
数据校验规则
- 长度范围:01000
              └ element_typeint元素类别
示例值:0
可选值有
- 0: 文本 - 1: 链接 - 2: @用户 - 3: 文档
              └ text_elementrich_text_element_text文本类别信息
                └ textstring文字
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ link_elementrich_text_element_link超链接类别信息
                └ herfstring链接
示例值:"https://bytedance.larkoffice.com"
数据校验规则
- 长度范围:01000 字符
                └ textstring文字
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ mention_user_elementrich_text_element_mention_user@用户类别信息
                └ user_idstring用户openID,可通过 获取指定用户的 Open ID 获取
示例值:"ou_da5****************dfe"
                └ text_stylerich_text_element_text_style文字属性
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ mention_doc_elementrich_text_element_mention_doc文档类别信息
                └ doc_urlstring文档超链接
示例值:"https://bytedance.larkoffice.com/wiki/xxxxx"
数据校验规则
- 长度范围:01000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
            └ indentint缩进(单位:字符)
示例值:0
数据校验规则
- 取值范围:0100
            └ list_begin_indexint有序列表开始序号(第一个有序列表的序号为list_begin_index+1) 例如:list_begin_index = 0, 则第一个有序列表的序号为1
示例值:0
数据校验规则
- 取值范围:010000
            └ quoteboolean引用
示例值:true
        └ text_color_typeint文字颜色类型,0=系统颜色(取theme_text_color_code),1=自定义颜色(取text_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
        └ text_background_color_typeint文字背景颜色类型,0=系统颜色(取theme_text_background_color_code),1=自定义颜色(取text_background_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
    └ titlestring标题
示例值:"表格"
数据校验规则
- 长度范围:01024 字符
    └ cellstable.cell\[\]单元格列表
数据校验规则
- 长度范围:010000
      └ row_indexint行下标,从 1 开始
示例值:1
数据校验规则
- 取值范围:110000
      └ col_indexint列下标,从 1 开始
示例值:1
数据校验规则
- 取值范围:110000
      └ merge_infotable.cell.merge_info单元格合并信息
        └ row_spanint从当前行索引起被合并的连续行数
示例值:2
数据校验规则
- 取值范围:110000
        └ col_spanint从当前列索引起被合并的连续列数
示例值:2
数据校验规则
- 取值范围:110000
      └ childrenstring\[\]单元格包含的子节点 id
示例值:["o1:1"]
数据校验规则
- 长度范围:03000
      └ texttext单元格内文字
        └ textstring文字内容
示例值:"文字内容"
数据校验规则
- 长度范围:01024 字符
        └ font_weightstring文字字重
示例值:"regular"
可选值有
- regular: 常规 - bold: 加粗
        └ font_sizeint文字大小,单位 px,默认为 14 px
示例值:14
        └ horizontal_alignstring水平对齐
示例值:"center"
可选值有
- left: 向左对齐 - center: 居中对齐 - right: 向右对齐
        └ vertical_alignstring垂直对齐
示例值:"mid"
可选值有
- top: 顶部对齐 - mid: 垂直居中 - bottom: 底部对齐
        └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ line_throughboolean是否存在删除线
示例值:true
        └ underlineboolean是否存在下划线
示例值:true
        └ italicboolean是否斜体
示例值:true
        └ angleint文字旋转角度,单位度
示例值:90
可选值有
- 0: 文字旋转角度0度 - 90: 文字旋转角度90度 - 180: 文字旋转角度180度 - 270: 文字旋转角度270度
数据校验规则
- 取值范围:0270
        └ theme_text_color_codeint文字颜色主题配色编码值
示例值:0
数据校验规则
- 取值范围:-2100
        └ theme_text_background_color_codeint文字背景颜色主题配色编码值
示例值:-1
数据校验规则
- 取值范围:-2100
        └ rich_textrich_text富文本
          └ paragraphsrich_text_paragraph\[\]段落列表
数据校验规则
- 长度范围:01000
            └ paragraph_typeint段落类别
示例值:0
可选值有
- 0: 普通段落 - 1: 无序列表 - 2: 有序列表
            └ elementsrich_text_element\[\]元素列表
数据校验规则
- 长度范围:01000
              └ element_typeint元素类别
示例值:0
可选值有
- 0: 文本 - 1: 链接 - 2: @用户 - 3: 文档
              └ text_elementrich_text_element_text文本类别信息
                └ textstring文字
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ link_elementrich_text_element_link超链接类别信息
                └ herfstring链接
示例值:"https://bytedance.larkoffice.com"
数据校验规则
- 长度范围:01000 字符
                └ textstring文字
示例值:"示例文案"
数据校验规则
- 长度范围:010000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ mention_user_elementrich_text_element_mention_user@用户类别信息
                └ user_idstring用户openID,可通过 获取指定用户的 Open ID 获取
示例值:"ou_da5****************dfe"
                └ text_stylerich_text_element_text_style文字属性
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
              └ mention_doc_elementrich_text_element_mention_doc文档类别信息
                └ doc_urlstring文档超链接
示例值:"https://bytedance.larkoffice.com/wiki/xxxxx"
数据校验规则
- 长度范围:01000 字符
                └ text_stylerich_text_element_text_style文字样式
                  └ font_weightstring文字字重
示例值:"bold"
数据校验规则
- 长度范围:010 字符
                  └ font_sizeint文字大小
示例值:14
数据校验规则
- 取值范围:01000
                  └ text_colorstring文字颜色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ text_background_colorstring文字背景色,16 进制 rgb 值
示例值:"#000000"
数据校验规则
- 长度范围:77 字符
                  └ line_throughboolean是否存在删除线
示例值:true
                  └ underlineboolean是否存在下划线
示例值:true
                  └ italicboolean是否斜体
示例值:true
            └ indentint缩进(单位:字符)
示例值:0
数据校验规则
- 取值范围:0100
            └ list_begin_indexint有序列表开始序号(第一个有序列表的序号为list_begin_index+1) 例如:list_begin_index = 0, 则第一个有序列表的序号为1
示例值:0
数据校验规则
- 取值范围:010000
            └ quoteboolean引用
示例值:true
        └ text_color_typeint文字颜色类型,0=系统颜色(取theme_text_color_code),1=自定义颜色(取text_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
        └ text_background_color_typeint文字背景颜色类型,0=系统颜色(取theme_text_background_color_code),1=自定义颜色(取text_background_color)
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
      └ stylestyle单元格样式,设置后会覆盖表格样式
        └ fill_colorstring填充颜色,16 进制 rbg 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ fill_opacitynumber(float)填充透明度,百分比
示例值:50
数据校验规则
- 取值范围:0100
        └ border_stylestring边框样式
示例值:"solid"
可选值有
- solid: 实线 - none: 无边框 - dash: 虚线 - dot: 点状虚线
        └ border_widthstring边框宽度
示例值:"narrow"
可选值有
- extra_narrow: 极细 - narrow: 细 - medium: 中 - bold: 粗
        └ border_opacitynumber(float)边框透明度,百分比
示例值:50
数据校验规则
- 取值范围:0100
        └ h_flipboolean水平翻折
示例值:false
        └ v_flipboolean垂直翻折
示例值:false
        └ border_colorstring边框颜色,16 进制 rgb 值
示例值:"#6db5a3"
数据校验规则
- 长度范围:710 字符
        └ theme_fill_color_codeint填充颜色主题配色编码值
示例值:3
数据校验规则
- 取值范围:-2100
        └ theme_border_color_codeint边框颜色主题配色编码值
示例值:4
数据校验规则
- 取值范围:-2100
        └ fill_color_typeint填充颜色类型:0=系统颜色,取theme_fill_color_code,1=自定义颜色,取fill_color
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
        └ border_color_typeint边框颜色类型:0=系统颜色,取theme_border_color_code,1=自定义颜色,取border_color
示例值:0
可选值有
- 0: 系统颜色 - 1: 自定义颜色
  └ lockedboolean图形是否锁定,锁定后无法编辑图形,默认false
示例值:true
  └ z_indexint图形在兄弟节点中的层级,层级大的会覆盖层级小的
示例值:1
数据校验规则
- 取值范围:010000
  └ lifelinelifeline生命对象属性(节点类型为life_line时,该字段不可为空)
    └ sizenumber(float)生命线长度,单位 px
示例值:10
数据校验规则
- 取值范围:01000000000
    └ typestring生命线类型
示例值:"actor_lifeline"
数据校验规则
- 长度范围:01000000 字符
  └ paintpaint画笔属性(节点类型为paint时,该字段不可为空)
    └ typestring画笔类型
示例值:"marker"
可选值有
- marker: 马克笔 - highlight: 高亮笔
数据校验规则
- 长度范围:0100 字符
    └ linespoint\[\]画板线段,由系列坐标点表示
数据校验规则
- 长度范围:1100000000
      └ xnumber(float)点位置x坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000001000000000000000000
      └ ynumber(float)点位置y坐标,单位 px
示例值:10
数据校验规则
- 取值范围:-10000000000000000000100000000000000000000
    └ widthint画笔粗细,单位px
示例值:7
数据校验规则
- 取值范围:123
    └ colorstring画笔颜色
示例值:"#ffffff"
数据校验规则
- 长度范围:77 字符
  └ svgsvgsvg图形属性(节点类型为svg时,该字段不可为空)
    └ svg_codestringsvg 代码
示例值:""
数据校验规则
- 长度范围:110000000000000000 字符
  └ sticky_notesticky_note便签图形属性
    └ user_idstring用户id
示例值:"12345678"
    └ show_author_infoboolean是否展示用户信息
示例值:true
  └ mind_map_nodemind_map_node思维导图节点属性
    └ parent_idstring思维导图节点的父节点,必须为思维导图节点
示例值:"z1:1"
数据校验规则
- 长度范围:010000000 字符
    └ typestring思维导图节点图形类型
示例值:"mind_map_text"
可选值有
- mind_map_text: 思维导图文本节点类型 - mind_map_full_round_rect: 思维导图全圆角矩形节点类型 - mind_map_round_rect: 思维导图矩形节点类型
    └ z_indexint思维导图节点在兄弟节点中的位置index
示例值:2
数据校验规则
- 取值范围:010000
    └ layout_positionstring子节点相对根节点的方向(根节点下的子节点设置才生效)
示例值:"left"
可选值有
- left: 思维导图节点在根节点左侧 - right: 思维导图节点在根节点右侧 - up: 思维导图节点在根节点上方 - down: 思维导图节点在根节点下方
    └ collapsedboolean是否收起子节点
示例值:true
  └ mind_map_rootmind_map_root思维导图根节点属性
    └ layoutstring思维导图布局方式
示例值:"left_right"
可选值有
- up_down: 上下布局 - left_right: 左右布局 - tree_left: 左树布局 - tree_right: 右树布局 - tree_balance: 左右交替平衡树布局 - vertical_time_line: 垂直时间线布局 - horizontal_time_line: 水平时间线布局
    └ typestring思维导图根节点图形类型
示例值:"mind_map_round_rect"
可选值有
- mind_map_text: 思维导图文本节点类型 - mind_map_full_round_rect: 思维导图全圆角矩形节点类型 - mind_map_round_rect: 思维导图矩形节点类型
    └ line_stylestring思维导图图形连接线样式
示例值:"round_angle"
可选值有
- curve: 曲线 - right_angle: 直角折线 - round_angle: 圆角折线

请求体示例

json
{
    "nodes": [
        {
            "id": "o1:3",
            "type": "composite_shape",
            "parent_id": "n1:1",
            "x": 347.1015625,
            "y": 267.15234375,
            "angle": 0,
            "height": 61.796875,
            "text": {
                "text": "基础图形",
                "font_weight": "regular",
                "font_size": 14,
                "horizontal_align": "center",
                "vertical_align": "mid",
                "text_color": "#1f2329",
                "line_through": false,
                "underline": false,
                "italic": false,
                "angle": 0,
                "theme_text_color_code": -1,
                "theme_text_background_color_code": -1,
                "text_color_type": 0,
                "text_background_color_type": 0
            },
            "style": {
                "fill_color": "#e1eaff",
                "fill_opacity": 100,
                "border_width": "narrow",
                "border_color": "#4e83fd",
                "border_opacity": 100,
                "border_style": "solid",
                "theme_fill_color_code": -1,
                "theme_border_color_code": -1,
                "fill_color_type": 0,
                "border_color_type": 0
            },
            "composite_shape": {
                "type": "round_rect"
            },
            "width": 114,
            "z_index": 0
        },
        {
            "id": "a1:1",
            "type": "text_shape",
            "x": 596.00390625,
            "y": 287.914794921875,
            "angle": 0,
            "height": 20.27199935913086,
            "text": {
                "text": "文本图形",
                "font_weight": "regular",
                "font_size": 14,
                "horizontal_align": "left",
                "vertical_align": "top",
                "text_color": "#1f2329",
                "line_through": false,
                "underline": false,
                "italic": false,
                "angle": 0,
                "theme_text_color_code": -1,
                "theme_text_background_color_code": -1,
                "text_color_type": 0,
                "text_background_color_type": 0
            },
            "width": 56,
            "z_index": 0
        },
        {
            "id": "c1:1",
            "type": "connector",
            "x": 461.1015625,
            "y": 298.05078125,
            "angle": 0,
            "height": 0,
            "style": {
                "border_width": "narrow",
                "border_color": "#bbbfc4",
                "border_opacity": 100,
                "border_style": "solid",
                "theme_border_color_code": -1,
                "border_color_type": 0
            },
            "connector": {
                "start_object": {
                    "id": "o1:3",
                    "snap_to": "right",
                    "position": {
                        "x": 1,
                        "y": 0.5
                    }
                },
                "end_object": {
                    "id": "a1:1",
                    "snap_to": "left",
                    "position": {
                        "x": 0,
                        "y": 0.49999934434890747
                    }
                },
                "captions": {
                    "data": [
                        {
                            "text": "连线",
                            "font_weight": "regular",
                            "font_size": 14,
                            "horizontal_align": "center",
                            "vertical_align": "mid",
                            "text_color": "#1f2329",
                            "line_through": false,
                            "underline": false,
                            "italic": false,
                            "angle": 0,
                            "theme_text_color_code": -1,
                            "theme_text_background_color_code": -1,
                            "text_color_type": 0,
                            "text_background_color_type": 0
                        }
                    ]
                },
                "shape": "straight",
                "turning_points": [],
                "start": {
                    "attached_object": {
                        "id": "o1:3",
                        "snap_to": "right",
                        "position": {
                            "x": 1,
                            "y": 0.5
                        }
                    },
                    "arrow_style": "none"
                },
                "end": {
                    "attached_object": {
                        "id": "a1:1",
                        "snap_to": "left",
                        "position": {
                            "x": 0,
                            "y": 0.49999934434890747
                        }
                    },
                    "arrow_style": "line_arrow"
                },
                "caption_auto_direction": false,
                "caption_position": 0.5051159262657166,
                "specified_coordinate": true,
                "caption_position_type": 0
            },
            "width": 134.90234375,
            "z_index": 1
        },
        {
            "id": "t1:2",
            "type": "section",
            "x": 685.78125,
            "y": 196.0703125,
            "angle": 0,
            "height": 151.83984375,
            "style": {
                "fill_color": "#f5f6f7",
                "fill_opacity": 100,
                "border_width": "extra_narrow",
                "border_opacity": 100,
                "border_style": "solid",
                "theme_fill_color_code": -1,
                "theme_border_color_code": -1,
                "fill_color_type": 0,
                "border_color_type": 0
            },
            "width": 331.6875,
            "section": {
                "title": "分区"
            },
            "z_index": 2
        },
        {
            "id": "n1:1",
            "type": "group",
            "x": 344.1015625,
            "y": 159.76953125,
            "angle": 0,
            "height": 169.17999267578125,
            "width": 120,
            "z_index": 3
        },
        {
            "id": "o1:7",
            "type": "composite_shape",
            "parent_id": "n1:1",
            "x": 344.1015625,
            "y": 159.76953125,
            "angle": 0,
            "height": 80,
            "text": {
                "text": "椭圆",
                "font_weight": "regular",
                "font_size": 14,
                "horizontal_align": "center",
                "vertical_align": "mid",
                "text_color": "#1f2329",
                "line_through": false,
                "underline": false,
                "italic": false,
                "angle": 0,
                "theme_text_color_code": -1,
                "theme_text_background_color_code": -1,
                "text_color_type": 0,
                "text_background_color_type": 0
            },
            "style": {
                "fill_color": "#eff0f1",
                "fill_opacity": 100,
                "border_width": "narrow",
                "border_color": "#bbbfc4",
                "border_opacity": 100,
                "border_style": "solid",
                "theme_fill_color_code": -1,
                "theme_border_color_code": -1,
                "fill_color_type": 0,
                "border_color_type": 0
            },
            "composite_shape": {
                "type": "round_rect2"
            },
            "width": 120,
            "z_index": 1
        }
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ idsstring\[\]所创建的节点 id 列表
  └ client_tokenstring操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "ids": [
            "o2:27",
            "a2:4",
            "c2:10",
            "t2:8",
            "n2:4",
            "o2:28"
        ],
        "client_token": "fe599b60-450f-46ff-b2ef-9f6675625b97"
    }
}

错误码

HTTP状态码错误码描述排查建议
4002890001invalid format参数格式不正确。请检查传入的参数格式,如 json 字符串是否正确
4002890002invalid arg参数无效。请检查传入的参数是否有效,如 whiteboard_id 是否正确,可通过云文档下的文档接口获取文档所有块获取正确的whiteboard_id
4002890003record missing找不到记录。whiteboard_id 不存在,请检查传入的whiteboard_id是否正确;或通过云文档下的文档接口获取文档所有块确认该画板是否存在
4012890004auth failed认证失败。请检查 Authorization 参数
4032890005forbidden请求身份没有当前画板的阅读权限。请参考云文档常见问题 3开通权限
4292890006too many request请求超过接口频率限流值。请降低操作频率,稍后再试
5002891001server internal error服务运行错误。请重试或联系技术支持

内容来源:飞书开放平台 · 自动爬取整理