思源笔记开发文档

Appearance

本文档非官方出品，主要由 AI 辅助编写，不保证绝对准确。如有疑问，请以 kernel/api/ 中的源码为准。

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

端点 ​

/api/notebook/changeSortNotebook

← 返回 Notebook API 列表

更改笔记本排序 ​

在 GitHub 上查看源码

需要认证 (管理员权限，检查只读模式)

接口描述 ​

根据提供的笔记本 ID 列表的顺序，更改工作空间中笔记本的排序。

此接口会调用内核的 model.ChangeBoxSort 方法来实际执行排序操作。

此接口需要管理员权限，并且会在只读模式下受限。

请求参数 ​

请求体为一个 JSON 对象，包含以下字段：

参数名类型必需描述
notebooksstring[]是笔记本 ID 的有序列表。系统将按照此列表的顺序对笔记本进行排序。

返回值 ​

返回标准的 JSON 结构：

参数名类型描述
codenumber返回码，0 表示成功，其他表示失败。
msgstring错误信息，成功时为空字符串。
datanull成功时，此字段为 null。

请求示例

返回示例

请求示例 (JSON) ​

json
{
  "notebooks": [
    "20200812220409-rng0qan",
    "20210310100000-abcdefg",
    "20220520123456-hijklmn"
  ]
}

成功返回示例 ​

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

失败返回示例 (例如，参数格式错误或权限不足) ​

json
{
  "code": -1, 
  "msg": "Error message describing the failure, e.g., 'readonly mode does not support this operation'",
  "data": null
}

在线测试 ​

注意

此操作会直接修改您工作空间中笔记本的显示顺序。请谨慎操作，并确保您了解参数的含义。 在不完全信任的网站或工具中输入您的 API Token 存在安全风险。本站点的在线测试功能在您的浏览器本地运行，但仍建议您仅在测试环境或使用临时的、权限受限的 Token。

本文档非官方出品，主要由 AI 辅助编写，不保证绝对准确。如有疑问，请以 kernel/api/ 中的源码为准。

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