Skip to main content
POST
添加批注

路径参数

noteid
string
必填

卡片的 noteid。取自卡片命令响应的 noteid、POST /notes/batch-get 响应里 items[].noteid,或 GET /ui-state 的 state.focusnoteid。

请求体

application/json
text
string
必填

批注正文。整条写成一个 marginnote4app://note/… 链接时,该条批注成为真正的双向链接。

confirm
boolean
必填

必填。由 MarginNote 自动补上。

format
enum<string>

正文的解析方式。改写现成批注时不接受该项。

可用选项:
text,
markdown,
html,
rich
style
object

只有 format 为 rich 时生效。MarginNote 移除样式时响应里的 styled 为 false。

field
string

标出该条批注所属的字段,便于同一张卡上放多组结构化内容。

fieldLabel
boolean

是否显示字段名。

响应

响应。可能还有未列出的字段。

format
string
noteid
string
styled
boolean

样式是否被保留。为 false 表示 MarginNote 移除了样式。

action
string
storedType
string
storedText
string
bridgeApiVersion
string
index
integer