删除画布

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

英飞画布服务端支持基于 Restful API 批量删除指定 recordId 对应的画布。

前提条件

• 已经完成英飞画布应用的创建动作，详见新人指引文档。
• 了解 REST API 请求的认证方式，详见获取 Access Token 文档。
• 持有创建画布接口返回的画布 ID。

请求路径

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

请求参数

字段

类型

描述

recordIds

Array<string>

待删除的画布 ID 数组

请求 curl 示例

curl --location --request DELETE \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{ "recordIds": ["SAMPLE_ID"] }' \
      https://developer.infi.cn/infi/api/v1/boards

请求成功情况

响应的 Http 状态码为 200 时表示请求成功，并会反馈删除删除失败的画布 ID。

注意： 正在被使用的画布无法被删除，所以在调用删除画布接口时，部分画布可能会删除失败。 返回体中的 failedRecordIds 字段会提供删除失败的画布 ID。您需要记录这些 ID，并另寻时机重新尝试删除。

请返回数据示例如下:

{
  "failedRecordIds": [],
}

请求失败情况

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