获取未折叠父块 ID (`/api/block/getUnfoldedParentID`)

接口描述

获取指定块 ID 的第一个未折叠的父块 ID。

该接口会沿着块的父级链向上查找,直到找到第一个未被折叠的父块并返回其 ID。如果所有父块都被折叠了,或者指定的块本身就是文档的根块(没有父块),则返回空字符串 ""

请求参数

参数名 类型 必选 描述
id string 需要查询的块 ID。

返回值

返回一个标准的 API 响应 JSON 对象。

字段名 类型 描述
code number 0 表示成功,非 0 表示失败。
msg string 如果失败,则包含错误信息。
data object | null 包含父块 ID 的对象。如果查询失败,可能为 null
对象结构如下:
字段名类型描述
parentIDstring第一个未折叠的父块 ID。如果所有父块都已折叠或无父块,则为空字符串 ""
请求示例
成功响应 (找到父块)
成功响应 (未找到/无父块)
失败响应

请求示例

POST /api/block/getUnfoldedParentID HTTP/1.1
Host: 127.0.0.1:6806
Content-Type: application/json
Authorization: Token your-api-token

{
  "id": "20230518110000-uvwxyz12"
}

成功响应示例 (找到未折叠父块)

{
  "code": 0,
  "msg": "",
  "data": {
    "parentID": "20230518105900-abcdefgh"
  }
}

成功响应示例 (所有父块折叠或无父块)

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

失败响应示例 (参数错误)

{
  "code": -1,
  "msg": "json: cannot unmarshal string into Go struct field .id of type string",
  "data": null
}

备注

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

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

在线测试

请填入必需的块 id