Document

Ein Document (Dokument) repräsentiert eine Vorlagenkonfiguration in einem Workflow. Es verweist auf eine Google Drive-Datei, die kopiert wird, um jede Ausgabe zu erzeugen.

Fields (Felder)

Field	Type	Description
id	String	Die ID des Dokuments.
documentType	String	Der Vorlagentyp. Entweder "GOOGLE_DOCS" oder "GOOGLE_SLIDES", abhängig von der ausgewählten Datei.
file	Google File	Die Google Drive-Datei, die als Vorlage verwendet wird. Diese Datei wird kopiert, um das Ausgabedokument zu erstellen.
outputName	String	Eine Vorlagenzeichenkette, die zur Benennung jeder aus dieser Vorlage erstellten Ausgabe verwendet wird.
createPDFCopy	Boolean	Wenn true, erstellt Portant zusätzlich eine PDF-Kopie des Ausgabedokuments.
removeOutput	Boolean	Wenn true, wird das ursprüngliche Ausgabedokument (Google Docs oder Slides) nach der Erstellung der PDF-Kopie entfernt.
enablePdfPassword	Boolean	Wenn true, wird das generierte PDF mit einem Passwort verschlüsselt.
pdfPassword	String	Eine Vorlagenzeichenkette zur Generierung des PDF-Passworts. Wird nur verwendet, wenn enablePdfPassword true ist.
PdfPasswordPreventCopy	Boolean	Wenn true, kann kein Inhalt aus dem passwortgeschützten PDF kopiert werden.
previewUrl	String	Eine URL zum eingebetteten Editor, über den Nicht-Portant-Benutzer Änderungen an diesem Dokument über Quellfelder vornehmen können. Es wird vorausgesetzt, dass der Benutzer bereits Zugriff auf die zugrunde liegende Google-Datei hat. Hinweis: Diese Funktion ist noch nicht implementiert und kann sich ändern.

Example (Beispiel)

{
    "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"
}

Endpoints (Endpunkte)

Alle Dokumente eines Workflows auflisten

GET /workflows/<wkf_id>/documents/

Alle Dokumente eines bestimmten Workflows auflisten.

Responses (Antworten)

Status	Body
200 OK	Array<Document>
403 Unauthorised	Error

Ein Dokument für einen Workflow erstellen

POST /workflows/<wkf_id>/documents/

Ein neues Dokument für den Workflow erstellen.

Request (Anfrage)

Ein create-Document-Objekt als JSON.

Die Nutzlast kann optional eine file_id für eine Google Drive-Datei enthalten, auf die der anfragende Benutzer Zugriff hat.

{
    file_id?: "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4"
}

Wenn Sie file_id weglassen, wird ein neues Dokument von Grund auf erstellt.

Responses (Antworten)

Status	Body
201 Created	Document
400 Bad Request	Error
403 Unauthorised	Error

Ein Dokument abrufen

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

Ein bestimmtes Dokument in einem bestimmten Workflow abrufen.

Responses (Antworten)

Status	Body
200 OK	Document
403 Unauthorised	Error

Ein Dokument aktualisieren

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

Ein bestimmtes Dokument anhand seiner ID aktualisieren.

Request (Anfrage)

Ein partial-Document-Objekt (partielles Dokument-Objekt) als JSON. Die Nutzlast kann beliebige bearbeitbare Felder des Dokuments enthalten. Die ausgewählte Datei kann nach der Erstellung eines Dokuments nicht mehr geändert werden.

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

Responses (Antworten)

Status	Body
200 OK	Document
400 Bad Request	Error
403 Unauthorised	Error