Skip to main content
GET
按文档顺序列出卡片

路径参数

topicid
string
必填

学习集的 topicid。取自 GET /ui-state 的 state.topicid、GET /library/study-sets,或 GET /writing/context 响应里的 window.topicid。

查询参数

root
string

指定子脑图根卡的 noteid,只读其中一张。取自 GET /study-sets/{topicid}/sub-maps。

limit
integer
默认值:5000

一次返回的节点数上限。

必填范围: 1 <= x <= 5000
cursor
string

下一页的起点,取上一页响应里的 nextCursor。

sort
enum<string>

按文档顺序排列。排序在分页切片之前对整条序列做,跨页顺序因此是对的。

可用选项:
document
withNotes
enum<integer>

带 withNotes=1 时,一并返回每个标签下直接存有该条完整路径的卡片 id。

可用选项:
1

响应

200 - application/json

脑图。节点是扁平数组,父子关系靠 parent 字段表示。

整个学习集的脑图。节点是扁平数组,父子关系由每项的 parent 写出,没有嵌套的 children。 翻页时带 limit 与 cursor;要按文档顺序排列时带 sort=document,此时顶层多出 sort, 节点上多出 docPage 与 docBookmd5。

topicid
string
bridgeApiVersion
string
nodeTotal
number

整棵树的节点数。翻页之前该数值已经可用。

nodes
object[]
nextCursor
string | null

下一页的起点。为 null 表示已到末尾。

truncation
boolean
walkLimitReached
boolean

撞上了遍历硬顶。只有该字段为 true 才表示即使读到末页也取不全。

truncated
boolean

该响应不是全部:还有下一页,或撞上了硬顶。

sort
string

只在带 sort=document 时出现。