オブジェクト

PushDocument

フィールド

• external_idstring必須

  ドキュメントの安定したID。同じIDを送ると、ドキュメントが置き換えられます。

  length ≤ 512

• titlestring必須

  length ≤ 500

• urlstring

  自社のシステムでのドキュメントへのリンク（httpまたはhttps）。

• contentstring

  内容（最大5MB）。

• 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

  contentの代わりに、マルチパートアップロードによるドキュメントのファイル（upl_…、1.62.0以降）。アップロードは一度だけ使用されます。同じドキュメントを同じupload_idで再送しても、アップロードは消費されません。インストール環境でマルチパートアップロードが利用できない間は、ドキュメントは理由file_rejectedで拒否されます。

  length ≤ 64

• attachmentsarray of string

  マルチパートアップロードとして渡すドキュメントの添付ファイル（upl_…、1.62.0以降）：それぞれが、同じフォルダー、権限、カードのフィールドを持つ、ソースの個別のカードになります。新しいバージョンのドキュメントに含まれなくなった添付ファイルは、アーカイブされます。

  items ≤ 20

使用箇所

• POST/v1/push/sources/{source_id}/documentsドキュメントを送信する（作成または置換）

参照元

PushDocumentBatch