根据提供的笔记本 ID 和新名称,重命名一个已存在的笔记本。
此接口需要管理员权限,并且会在只读模式下受限。
请求体为一个 JSON 对象,包含以下字段:
参数名 | 类型 | 必需 | 描述 |
---|---|---|---|
notebook | string | 是 | 要重命名的笔记本的 ID。 |
name | string | 是 | 笔记本的新名称。名称不能为空,且需要符合命名规范。 |
返回标准的 JSON 结构:
参数名 | 类型 | 描述 |
---|---|---|
code | number | 返回码,0 表示成功,其他表示失败。 |
msg | string | 错误信息,成功时为空字符串。 |
data | null | 成功时,此字段通常为 null。 |
{
"notebook": "20200812220409-rng0qan",
"name": "我的日常记录本"
}
{
"code": 0,
"msg": "",
"data": null
}
{
"code": -1,
"msg": "rename box [non-existent-id] failed: notebook [non-existent-id] not found",
"data": {
"closeTimeout": 5000
}
}
{
"code": -1,
"msg": "box name [\\] is invalid: path segments should not be empty",
"data": {
"closeTimeout": 5000
}
}
{
"code": -1,
"msg": "只读模式下无法执行该操作",
"data": {
"closeTimeout": 5000
}
}
注意:这是一个社区维护的文档,可能与官方最新版本存在差异。
如果您觉得本文档有帮助,可以考虑赞助支持:爱发电