对象

PushDocument

字段

• external_idstring必填

  您的文档的稳定 ID。发送相同的 ID 会替换该文档。

  length ≤ 512

• titlestring必填

  length ≤ 500

• urlstring

  文档在您系统中的链接（http 或 https）。

• contentstring

  内容（最大 5 MB）。

• content_typestring

  可选值: htmlmarkdowntext

  默认值："html"

• patharray of string | string

  文档所在的文件夹：名称数组或以“/”分隔的字符串（最多 10 层）。

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  作者。如果是 Sursa 用户，则成为卡片的负责人。

• updated_atstring (date-time)

  在您系统中的修改时间（文档版本的一部分）。

• metadataMetadataPatch

  文档卡片的 metadata（自 1.62.0 起）：该对象替换卡片原有的元数据，{} 删除所有键值对；不传 metadata 字段时，卡片的元数据不变。

• categorystring

  卡片的分类：组织分类的键（GET /v1/categories），自 1.62.0 起。

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  卡片的核实周期（天）（自 1.62.0 起）；不传时使用数据源的周期。

  ≥ 1, ≤ 3650

• upload_idstring

  来自分段上传的文档文件（upl_…，自 1.62.0 起），代替 content。每个上传只能使用一次；以相同的 upload_id 再次发送同一文档不会消耗它。在部署尚不支持分段上传时，文档会以原因 file_rejected 被拒绝。

  length ≤ 64

• attachmentsarray of string

  以分段上传形式提供的文档附件（upl_…，自 1.62.0 起）：每个附件成为该数据源的一张独立卡片，具有相同的文件夹、权限和卡片字段。文档新版本中缺少的附件会被归档。

  items ≤ 20

使用方

• POST/v1/push/sources/{source_id}/documents发送文档（创建或替换）

所属对象

PushDocumentBatch