Pièces jointes

La liste attachments intègre des fichiers dans le PDF généré. Chaque fichier est stocké dans le PDF, associé au document, et peut être extrait par les lecteurs qui prennent en charge les pièces jointes PDF (la plupart des lecteurs PDF de bureau).

Propriétés

Chaque entrée de attachments accepte :

Propriété	Type	Description
filePath	string	Le fichier à intégrer, un chemin à côté du document. Obligatoire
fileName	string	Le nom que porte le fichier dans le document. Absent, le nom du fichier lui-même
description	string	Ce qu'est le fichier, affiché dans le panneau des pièces jointes du lecteur
relationship	string	Ce qu'est le fichier pour ce document : source, data (derrière un tableau ou un graphique), alternative (un autre rendu, comme le XML d'une facture électronique), supplement, schema, formData ou unspecified
mimeType	string	Type de média du fichier, comme "text/csv". Absent, déduit de l'extension du fichier

Exemples

Joindre un fichier de données CSV

{
  "document": {
    "attachments": [
      {
        "fileName": "revenue_data.csv",
        "filePath": "attachments/revenue_data.csv",
        "description": "Raw revenue data used to generate this report"
      }
    ],
    "content": [
      { "p": "Consultez le fichier CSV joint pour les données sous-jacentes." }
    ]
  }
}

Joindre de la documentation complémentaire

{
  "document": {
    "metadata": {
      "title": "Bon de livraison",
      "author": "Équipe logistique"
    },
    "attachments": [
      {
        "fileName": "customs_declaration.pdf",
        "filePath": "attachments/customs_declaration.pdf",
        "description": "Customs declaration form for cross-border shipment"
      }
    ],
    "content": [
      { "p": "Ce bon de livraison inclut la déclaration douanière en tant que pièce jointe." }
    ]
  }
}

Téléversement des fichiers

Téléversez un fichier à joindre dans le dossier attachments de votre espace de travail, puis nommez-le par ce chemin :

POST /v1/{tenantId}/assets/attachments
Content-Type: multipart/form-data

file: revenue_data.csv

Le dossier accepte les fichiers .xml, .xsd, .csv, .json, .txt et .pdf jusqu'à 5 Mo. Un fichier introuvable est signalé par ATTACHMENT_NOT_EMBEDDED dans le champ errorCodes de la réponse.

Où les pièces jointes apparaissent

Les fichiers joints sont accessibles via le panneau des pièces jointes du lecteur PDF (parfois appelé panneau « trombone »). Dans Adobe Acrobat, accédez à Affichage > Afficher/Masquer > Volets de navigation > Pièces jointes.