Document

Un Document représente la configuration d'un modèle dans un workflow. Il pointe vers un fichier Google Drive qui est copié pour produire chaque sortie.

Champs

Champ	Type	Description
id	String	L'identifiant du document.
documentType	String	Le type de modèle. Soit "GOOGLE_DOCS" soit "GOOGLE_SLIDES", selon le fichier sélectionné.
file	Google File	Le fichier Google Drive utilisé comme modèle. Ce fichier est copié pour créer le document de sortie.
outputName	String	Une chaîne de caractères templatisée utilisée pour nommer chaque sortie créée à partir de ce modèle.
createPDFCopy	Boolean	Lorsque cette valeur est true (vrai), Portant crée également une copie PDF du document de sortie.
removeOutput	Boolean	Lorsque cette valeur est true (vrai), le document de sortie original (Google Docs ou Slides) est supprimé après la création de la copie PDF.
enablePdfPassword	Boolean	Lorsque cette valeur est true (vrai), le PDF généré est chiffré avec un mot de passe.
pdfPassword	String	Une chaîne de caractères templatisée utilisée pour générer le mot de passe du PDF. Utilisée uniquement lorsque enablePdfPassword est true (vrai).
PdfPasswordPreventCopy	Boolean	Lorsque cette valeur est true (vrai), le contenu ne peut pas être copié depuis le PDF protégé par mot de passe.
previewUrl	String	Une URL vers l'éditeur intégré utilisé par les utilisateurs non-Portant pour apporter des modifications à ce document via les champs source. Suppose que l'utilisateur peut déjà accéder au fichier Google Drive sous-jacent. Remarque : cette fonctionnalité n'est pas encore implémentée et est susceptible d'évoluer.

Exemple

{
    "id": "doc_5LGGqC5S78RNS0",
    "documentType": "GOOGLE_DOCS",
    "file": {
        "id": "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4",
        "name": "Complete Workflow Please - [Template]",
        "url": "https://docs.google.com/document/d/1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4/edit?usp=drivesdk",
        "mimeType": "application/vnd.google-apps.document"
    },
    "outputName": "Document for {{First Name}}",
    "createPdfCopy": true,
    "removeOutput": false,
    "enablePdfPassword": false,
    "pdfPassword": "Password-{{Secret Number}}",
    "pdfPasswordPreventCopy": false,
    "previewUrl": "https://preview.portant.co/doc_5LGGqC5S78RNS0"
}

Points de terminaison

Lister tous les documents d'un workflow

GET /workflows/<wkf_id>/documents/

Lister tous les documents associés à un workflow spécifique.

Réponses

Statut	Corps
200 OK	Array<Document>
403 Unauthorised	Error

Créer un document pour un workflow

POST /workflows/<wkf_id>/documents/

Créer un nouveau document pour le workflow.

Requête

Un objet Document de type create (création) au format JSON.

La charge utile peut inclure un file_id optionnel correspondant à un fichier Google Drive auquel l'utilisateur effectuant la requête a accès.

{
    file_id?: "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4"
}

Si vous omettez file_id, un nouveau document est créé de zéro.

Réponses

Statut	Corps
201 Created	Document
400 Bad Request	Error
403 Unauthorised	Error

Obtenir un document

GET /workflows/<wkf_id>/documents/<doc_id>/

Récupérer un document spécifique dans un workflow spécifique.

Réponses

Statut	Corps
200 OK	Document
403 Unauthorised	Error

Mettre à jour un document

PATCH /workflows/<wkf_id>/documents/<doc_id>/

Mettre à jour un document spécifique par son identifiant.

Requête

Un objet Document partiel au format JSON. La charge utile peut inclure n'importe lequel des champs modifiables du document. Le fichier sélectionné ne peut pas être modifié une fois le document créé.

{
    "outputName"?: "New outputName for {{First Name}}",
    "pdfPassword"?: "NewPassword-{{Secret Number}}",
    "enablePdfPassword"?: true,
    "enablePdfPreventCopy"?: true,
}

Réponses

Statut	Corps
200 OK	Document
400 Bad Request	Error
403 Unauthorised	Error