Objekte

PushDocument

Felder

• external_idstringerforderlich

  Ihre stabile Dokument-ID. Das Senden derselben ID ersetzt das Dokument.

  length ≤ 512

• titlestringerforderlich

  length ≤ 500

• urlstring

  Link zum Dokument in Ihrem System (http oder https).

• contentstring

  Inhalt (bis zu 5 MB).

• content_typestring

  Zulässige Werte: htmlmarkdowntext

  Standard: "html"

• patharray of string | string

  Ordner des Dokuments: ein Array von Namen oder eine durch „/“ getrennte Zeichenkette (bis zu 10 Ebenen).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  Autor. Wird zur verantwortlichen Person der Karte, wenn es sich um einen Benutzer von Sursa handelt.

• updated_atstring (date-time)

  Änderungszeitpunkt in Ihrem System (Teil der Dokumentversion).

• metadataMetadataPatch

  metadata der Karte des Dokuments (seit 1.62.0): Das Objekt ersetzt das bisherige der Karte, {} entfernt alle Paare; ohne das Feld metadata ändern sich die Metadaten der Karte nicht.

• categorystring

  Kategorie der Karte: der Schlüssel einer Kategorie der Organisation (GET /v1/categories), seit 1.62.0.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  Prüfintervall der Karte in Tagen (seit 1.62.0); ohne Angabe das Intervall der Quelle.

  ≥ 1, ≤ 3650

• upload_idstring

  Datei des Dokuments aus einem Multipart-Upload (upl_…, seit 1.62.0) statt content. Ein Upload wird einmal verwendet; ein erneutes Senden desselben Dokuments mit derselben upload_id verbraucht ihn nicht. Solange Multipart-Uploads in der Installation nicht verfügbar sind, wird das Dokument mit dem Grund file_rejected abgelehnt.

  length ≤ 64

• attachmentsarray of string

  Anhänge des Dokuments als Multipart-Uploads (upl_…, seit 1.62.0): Jeder Anhang wird zu einer eigenen Karte der Quelle mit demselben Ordner, denselben Berechtigungen und Kartenfeldern. Ein Anhang, der in einer neuen Version des Dokuments fehlt, wird archiviert.

  items ≤ 20

Verwendet von

• POST/v1/push/sources/{source_id}/documentsDokument senden (erstellen oder ersetzen)

Teil von

PushDocumentBatch