移动本地闪记 (moveLocalShorthands)

POST /api/filetree/moveLocalShorthands

接口描述

本接口用于将本地闪记(速记)移动到指定笔记本的文档中。闪记是思源笔记中用于快速记录临时想法的功能,存储在特定目录下的Markdown文件。

该API有两种工作模式:

  1. 当提供了路径(path)参数时,会将所有闪记合并到指定路径的文档中;
  2. 当未提供路径参数时,每个闪记会创建为一个独立的文档,文档名为闪记的创建时间。

移动操作同时会处理闪记中引用的资源文件,将它们移动到思源笔记的assets目录中。

请求参数

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

参数名 类型 必需 描述
notebook string 目标笔记本ID,例如 20210808180117-czj9bvb
path string 目标文档的层级路径,例如 /闪记收集。如果提供此参数,所有闪记将被合并到此文档中;如果不提供,则为每个闪记创建单独的文档。
parentID string 目标父文档ID,创建新文档时使用。当未指定path时,用于指定新建文档的父级位置。

响应体

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

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

请求示例


{
  "notebook": "20210808180117-czj9bvb",
  "path": "/闪记收集",
  "parentID": ""
}
            

响应示例

成功响应:


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

失败响应(笔记本ID不存在):


{
  "code": -1,
  "msg": "查询笔记本失败 [ID] [20210808180117-invalid]",
  "data": null
}
            

错误码

错误码 描述
0 成功
-1 失败,可能原因包括:笔记本ID不存在、无权限访问、IO操作错误等

源码定位

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

在线测试

警告:此操作会实际移动闪记到笔记本中,请确保在测试环境操作或使用不重要的闪记。

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

响应:

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

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