Skip to main content
GET
核对一份文档

路径参数

bookmd5
string
必填

文档的内容标识。取自 GET /study-sets/{topicid}/documents 响应里各项的 bookmd5、GET /ui-state 的 state.bookmd5,或 GET /search?scope=documents。

查询参数

verifyHash
enum<integer>

计算内容 hash。默认不算。开启后要扫描整份已实体化的文件,大文档很慢。

可用选项:
1

响应

核对结果。

单个文档的同步核对。

state
enum<string>

核对结论。available_local_only 与 available_and_published 表示可用; waiting_for_icloud_download 与 mapped_but_not_materialized 表示内容尚未取得; 其余表示映射缺失、内容不一致或提供方未核实。

可用选项:
database_reference_without_document_mapping,
waiting_for_icloud_download,
library_record_without_document_mapping,
available_local_only,
available_and_published,
verified_mismatch,
icloud_error,
mapped_but_not_materialized,
unverified_external_provider
database
object
databaseQueryErrors
string[]

非空表示数据库一侧的结论只是部分证据。

originalDocument
object
remainingUnverifiedMaterializedMappingCount
number

不为零时,该结论不能推广到其他映射上。

activeDirectNoteReferenceCount
number
studySetWithActiveNotesCount
number