getRefText

getRefText

POST /api/block/getRefText

获取指定块的引用文本(Ref Text)。

引用文本是当其他块通过 `((块ID))` 语法引用此块时,默认显示的文本内容。通常是块内容的纯文本表示,但也可能受到命名(Name)属性的影响。

鉴权:需要认证 Token。

请求体参数

参数 类型 描述
id string 必需。目标块的 ID。

返回值

成功时返回块的引用文本字符串:

{
    "code": 0,
    "msg": "",
    "data": "块的引用文本"
}

注意:

失败时(例如 ID 格式无效):

{
    "code": -1, // 或其他错误码
    "msg": "错误信息",
    "data": null
}

请求示例

获取 ID 为 `20230101...` 的块的引用文本:

{
    "id": "20230101120000-abcdefgh"
}

在线测试

服务器地址:

API Token:

API 路径:

请求方法:

请求体:

响应结果:

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

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