Objecten

PushDocument

Velden

• external_idstringverplicht

  Je stabiele ID van het document. Met dezelfde ID wordt het document vervangen.

  length ≤ 512

• titlestringverplicht

  length ≤ 500

• urlstring

  Link naar het document in je systeem (http of https).

• contentstring

  Inhoud (maximaal 5 MB).

• content_typestring

  Toegestane waarden: htmlmarkdowntext

  Standaard: "html"

• patharray of string | string

  Mappen van het document: een array met namen of een string gescheiden door “/” (maximaal 10 niveaus).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  Auteur. Wordt eigenaar van de kaart als dit een gebruiker van Sursa is.

• updated_atstring (date-time)

  Tijdstip van wijziging in je systeem (onderdeel van de documentversie).

• metadataMetadataPatch

  metadata van de kaart van het document (sinds 1.62.0): het object vervangt de vorige metadata van de kaart, {} verwijdert alle paren; zonder het veld metadata verandert de metadata van de kaart niet.

• categorystring

  Categorie van de kaart: de sleutel van een categorie van de organisatie (GET /v1/categories), sinds 1.62.0.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  Verificatie-interval van de kaart in dagen (sinds 1.62.0); zonder dit veld het interval van de bron.

  ≥ 1, ≤ 3650

• upload_idstring

  Bestand van het document uit een upload in delen (upl_…, sinds 1.62.0) in plaats van content. Een upload wordt één keer gebruikt; hetzelfde document opnieuw sturen met dezelfde upload_id verbruikt hem niet. Zolang uploads in delen niet beschikbaar zijn op de installatie, wordt het document afgewezen met de reden file_rejected.

  length ≤ 64

• attachmentsarray of string

  Bijlagen van het document als uploads in delen (upl_…, sinds 1.62.0): elke bijlage wordt een eigen kaart van de bron met dezelfde map, rechten en kaartvelden. Een bijlage die in een nieuwe versie van het document ontbreekt, wordt gearchiveerd.

  items ≤ 20

Gebruikt door

• POST/v1/push/sources/{source_id}/documentsDocument versturen (aanmaken of vervangen)

Onderdeel van

PushDocumentBatch