功能描述
此 API 端点 POST /api/riff/resetRiffCards
用于重置指定范围内的闪卡的复习状态。
重置操作会将卡片的复习进度(如复习次数、间隔、状态等)恢复到初始状态,使其类似于一张新卡。
可以按笔记本、文档树或闪卡包的范围进行重置,并且可以选择性地只重置范围内的部分卡片。
请求参数
请求体必须是 JSON 格式,包含以下参数:
type
(string): 必填。指定重置的范围类型。有效值:"notebook"
: 按笔记本范围重置。"tree"
: 按文档树(以某个块为根)范围重置。"deck"
: 按闪卡包范围重置。
id
(string): 必填。与type
对应的 ID。- 当
type
为"notebook"
时,此为笔记本 ID。 - 当
type
为"tree"
时,此为文档树的根块 ID。 - 当
type
为"deck"
时,此为闪卡包 ID。
- 当
deckID
(string): 必填。目标卡包 ID。即使type
不是"deck"
,也需要提供此参数。通常,当type
为"deck"
时,此 ID 与id
相同。blockIDs
(array of strings): 可选。一个块 ID 列表。- 如果提供此列表,则仅重置列表中属于由
type
,id
,deckID
确定的范围内的闪卡。 - 如果不提供此列表或提供一个空数组 (
[]
),则重置由type
,id
,deckID
确定的范围内的所有闪卡。
- 如果提供此列表,则仅重置列表中属于由
请求示例 (重置卡包 `deck-abc` 中的所有卡片):
{
"type": "deck",
"id": "deck-abc",
"deckID": "deck-abc",
"blockIDs": [] // 或者省略 blockIDs 字段
}
请求示例 (重置笔记本 `nb-xyz` 中,卡包 `deck-123` 内的特定几张卡片):
{
"type": "notebook",
"id": "nb-xyz",
"deckID": "deck-123",
"blockIDs": [
"20240101100000-hijklmn",
"20240102110000-opqrstu"
]
}
请求示例 (重置文档树 `root-doc` 下的所有属于卡包 `deck-learn` 的卡片):
{
"type": "tree",
"id": "root-doc",
"deckID": "deck-learn"
}
响应结果
成功的请求将返回一个 JSON 对象,code
为 0,data
为 null
。
{
"code": 0,
"msg": "",
"data": null
}
如果操作失败(例如参数无效、ID 不存在等),将返回非 0 的 code
和具体的错误信息 msg
。
{
"code": -1,
"msg": "无效的类型参数", // 示例错误信息
"data": null
}
在线测试
您可以在下方输入参数进行在线测试。请谨慎操作,重置卡片状态后可能需要重新学习。