重载标签树 (reloadTag)

POST /api/ui/reloadTag

接口描述

此 API 端点 POST /api/ui/reloadTag 用于通知前端重载标签树视图。

当标签信息发生变化(例如通过 API 创建新的标签、重命名或删除标签),并且需要前端的标签面板更新其内容时,可以调用此接口。内核会通过 WebSocket 将 "reloadtag" 事件推送给前端。

请求参数

此接口不需要请求参数。可以发送一个空的 JSON 对象 {} 作为请求体,或者不包含请求体。

请求示例 (空JSON):

{}

响应体

成功响应 (HTTP 200 OK):

成功处理请求后,API 返回:

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

失败响应:

由于此接口不处理复杂的请求参数,主要的失败场景是认证失败。认证失败 (如未提供 API Token、非管理员等) 会由中间件处理,并返回相应的 HTTP 错误状态码 (如 401, 403)。

认证与授权

调用此 API 端点需要有效的用户认证 (通过 Authorization HTTP头部传递 API Token)。

此外,执行此操作需要:

备注

在线测试

您可以使用下面的表单来测试此 API。请输入 API Token。

响应:

点击按钮查看响应

感谢您对思源笔记的关注与支持!

在爱发电上赞助我们