根据ID重命名文档 (renameDocByID)

POST /api/filetree/renameDocByID

接口描述

本接口用于根据文档ID重命名文档。与renameDoc接口不同,该接口使用文档ID来指定要重命名的文档,而不是文档路径。

重命名文档会更新文档的标题,同时保持文档的所有内容和属性不变。

请求参数

请求体为一个 JSON 对象,包含以下字段:

参数名 类型 必需 描述
id string 要重命名的文档ID,例如 20210808180117-czj9bvb
title string 新的文档标题。

响应体

成功时,响应体为一个 JSON 对象,包含以下字段:

参数名 类型 描述
code number 状态码,0 表示成功。
msg string 错误信息,成功时为空字符串。
data null 此接口无返回数据,成功时为 null

请求示例


{
  "id": "20210808180117-czj9bvb",
  "title": "新文档标题"
}
            

响应示例

成功响应:


{
  "code": 0,
  "msg": "",
  "data": null
}
            

失败响应(ID不存在):


{
  "code": -1,
  "msg": "加载文档树失败 id [20210808180117-xxxxxx]: 文档块不存在",
  "data": {
    "closeTimeout": 7000
  }
}
            

错误码

错误码 描述
0 成功
-1 失败,可能原因包括:文档ID不存在、无权限、标题格式无效等

源码定位

后端实现相关的核心逻辑可以在以下文件中找到:

在线测试

警告:此操作会实际重命名文档,请确保在测试环境操作或使用不重要的文档。

请在下方输入请求 JSON,然后点击"发送请求"按钮。

响应:

注意:这是一个社区维护的文档,可能与官方最新版本存在差异。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电