Objekty

PushDocument

Pole

• external_idstringpovinné

  Váš stálý identifikátor dokumentu. Odeslání stejného identifikátoru dokument nahradí.

  length ≤ 512

• titlestringpovinné

  length ≤ 500

• urlstring

  Odkaz na dokument ve vašem systému (http nebo https).

• contentstring

  Obsah (nejvýše 5 MB).

• content_typestring

  Povolené hodnoty: htmlmarkdowntext

  Výchozí: "html"

• patharray of string | string

  Složky dokumentu: pole JSON názvů nebo řetězec oddělený „/“ (nejvýše 10 úrovní).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  Autor. Pokud je uživatelem Sursy, stane se vlastníkem karty.

• updated_atstring (date-time)

  Čas úpravy ve vašem systému (součást verze dokumentu).

• metadataMetadataPatch

  metadata karty dokumentu (od verze 1.62.0): objekt nahradí předchozí objekt karty, {} odstraní všechny dvojice; bez pole metadata se metadata karty nemění.

• categorystring

  Kategorie karty: klíč kategorie organizace (GET /v1/categories), od verze 1.62.0.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  Interval ověřování karty ve dnech (od verze 1.62.0); bez něj platí interval zdroje.

  ≥ 1, ≤ 3650

• upload_idstring

  Soubor dokumentu z vícedílného nahrávání (upl_…, od verze 1.62.0) místo content. Nahrávání se použije jednou; opětovné odeslání stejného dokumentu se stejným upload_id ho nespotřebuje. Dokud vícedílné nahrávání není v instalaci dostupné, dokument se odmítne s důvodem file_rejected.

  length ≤ 64

• attachmentsarray of string

  Přílohy dokumentu jako vícedílná nahrávání (upl_…, od verze 1.62.0): z každé se stane samostatná karta zdroje se stejnou složkou, oprávněními a poli karty. Příloha, která v nové verzi dokumentu chybí, se archivuje.

  items ≤ 20

Používá

• POST/v1/push/sources/{source_id}/documentsOdeslat dokument (vytvořit nebo nahradit)

Součást

PushDocumentBatch