Об’єкти

PushDocument

Поля

• external_idstringобов’язково

  Ваш сталий ID документа. Надсилання того самого ID замінює документ.

  length ≤ 512

• titlestringобов’язково

  length ≤ 500

• urlstring

  Посилання на документ у вашій системі (http або https).

• contentstring

  Вміст (до 5 МБ).

• 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