Objets

PushDocument

Champs

• external_idstringobligatoire

  Identifiant stable de votre document. Envoyer le même identifiant remplace le document.

  length ≤ 512

• titlestringobligatoire

  length ≤ 500

• urlstring

  Lien vers le document dans votre système (http ou https).

• contentstring

  Contenu (jusqu’à 5 Mo).

• content_typestring

  Valeurs autorisées: htmlmarkdowntext

  Par défaut : "html"

• patharray of string | string

  Dossiers du document : un tableau de noms ou une chaîne séparée par « / » (jusqu’à 10 niveaux).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  Auteur. Devient le responsable de la fiche s’il s’agit d’un utilisateur de Sursa.

• updated_atstring (date-time)

  Date de modification dans votre système (fait partie de la version du document).

• metadataMetadataPatch

  metadata de la fiche du document (depuis la version 1.62.0) : l’objet remplace le précédent de la fiche, {} supprime toutes les paires ; sans le champ metadata, les métadonnées de la fiche ne changent pas.

• categorystring

  Catégorie de la fiche : la clé d’une catégorie de l’organisation (GET /v1/categories), depuis la version 1.62.0.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  Intervalle de validation de la fiche en jours (depuis la version 1.62.0) ; sans lui, l’intervalle de la source.

  ≥ 1, ≤ 3650

• upload_idstring

  Fichier du document issu d’un téléversement en plusieurs parties (upl_…, depuis la version 1.62.0) à la place de content. Un téléversement ne sert qu’une fois ; renvoyer le même document avec le même upload_id ne le consomme pas. Tant que les téléversements en plusieurs parties ne sont pas disponibles sur l’installation, le document est rejeté avec le motif file_rejected.

  length ≤ 64

• attachmentsarray of string

  Pièces jointes du document sous forme de téléversements en plusieurs parties (upl_…, depuis la version 1.62.0) : chacune devient une fiche distincte de la source, avec le même dossier, les mêmes permissions et les mêmes champs de fiche. Une pièce jointe absente d’une nouvelle version du document est archivée.

  items ≤ 20

Utilisé par

• POST/v1/push/sources/{source_id}/documentsEnvoyer un document (créer ou remplacer)

Fait partie de

PushDocumentBatch