Объекты

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