跳到主要内容

画布预置文档类型元素

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 REST API 向画布中预置文档元素。在发起插入文档元素前，您需要完成文档的预解析工作。

前提条件​

请求路径​

https://developer.infi.cn/infi/api/v1/boards/documents

请求参数​

基本参数说明如下：

字段
类型
描述
必填
recordId
string
画布 ID
是
userId
string
元素创建者用户 loginName
是
element
Object
对象数据结构，详情见下方元素信息结构说明
是

元素信息结构说明如下：

字段
类型
描述
必填
position.x
number
元素左上角x坐标
是
position.y
number
元素左上角y坐标
是
fileType
1/2/3/4
文件类型，详情见下方说明
是
fileId
string
预解析文件ID
是
name
string
文件名称
是
size
object
放置大小
是
size.width
number
文档宽度
是
size.height
number
文档高度
是
titleHeight
number
标题高度
是
totalPage
integer
总页数
是
scale
number
缩放比例，计算方式见下方说明
是
zIndex
number
元素层级，值为正整数
是
frameId
string
从属帧框 ID
否

说明：

  • 文件类型：1 代表 word；2 代表 excel 格式图片；3 代表 ppt; 4 代表 pdf。
  • 缩放比例的计算方式为：scale = 900/MAX_WH, MAX_WH 是 size.width 与 size.height 中的较大值。
  • zIndex 值会影响到元素见的层级关系，位置相近的情况下，较小 zIndex 的元素很可能会被较大 zIndex 的元素覆盖。

请求参数示例​

{
  "recordId": "SAMPLE_RECORD_ID",
  "userId": "SAMPLE_USER_LOGIN_NAME",
  "element": {
    "position": {
      "x": 100,
      "y": 100
    },
    "fileType": 1,
    "fileId": "SAMPLE_FILE_ID",
    "name": "SAMPLE_NAME",
    "size": {
      "width": 1280,
      "height": 720
    },
    "titleHeight": 0,
    "scale": 1,
    "totalPage": 10,
    "zIndex": 1
  }
}

请求 curl 示例​

curl --location --request POST \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{ PAYLOADS_HERE }' \
      https://developer.infi.cn/infi/api/v1/boards/documents

注意：请确保将 PAYLOADS_HERE 替换为请求参数中列举的数据。

请求成功情况​

响应的 Http 状态码为 200 时表示请求成功，并会带有新创建文档元素的 ID。 请求成功返回数据示例如下:

{
  "elementId": "SAMPLE_ELEMENT_ID"
}

请求失败情况​

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。