Document

Een Document vertegenwoordigt een sjabloonconfiguratie in een workflow. Het verwijst naar een Google Drive-bestand dat wordt gekopieerd om elke uitvoer te produceren.

Fields (Velden)

Field	Type	Description
id	String	Het ID van het document.
documentType	String	Het sjabloontype. Ofwel "GOOGLE_DOCS" of "GOOGLE_SLIDES", afhankelijk van het geselecteerde bestand.
file	Google File	Het Google Drive-bestand dat als sjabloon wordt gebruikt. Dit bestand wordt gekopieerd om het uitvoerdocument aan te maken.
outputName	String	Een sjabloonreeks die wordt gebruikt om elke uitvoer die op basis van dit sjabloon wordt aangemaakt een naam te geven.
createPDFCopy	Boolean	Wanneer true (waar), maakt Portant ook een PDF-kopie van het uitvoerdocument aan.
removeOutput	Boolean	Wanneer true (waar), wordt het oorspronkelijke uitvoerdocument (Google Docs of Slides) verwijderd nadat de PDF-kopie is aangemaakt.
enablePdfPassword	Boolean	Wanneer true (waar), wordt de gegenereerde PDF versleuteld met een wachtwoord.
pdfPassword	String	Een sjabloonreeks die wordt gebruikt om het PDF-wachtwoord te genereren. Wordt alleen gebruikt wanneer enablePdfPassword true (waar) is.
PdfPasswordPreventCopy	Boolean	Wanneer true (waar), kan inhoud niet worden gekopieerd uit de met een wachtwoord beveiligde PDF.
previewUrl	String	Een URL naar de ingesloten editor die door niet-Portant-gebruikers wordt gebruikt om via bronvelden wijzigingen aan te brengen in dit document. Er wordt van uitgegaan dat de gebruiker al toegang heeft tot het onderliggende Google-bestand. Opmerking: deze functie is nog niet geïmplementeerd en kan worden gewijzigd.

Example (Voorbeeld)

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

Alle documenten voor een workflow weergeven

GET /workflows/<wkf_id>/documents/

Geef alle documenten voor een specifieke workflow weer.

Responses (Antwoorden)

Status	Body
200 OK	Array<Document>
403 Unauthorised	Error

Een document voor een workflow aanmaken

POST /workflows/<wkf_id>/documents/

Maak een nieuw document voor de workflow aan.

Request (Verzoek)

Een create (aanmaak) Document-object als JSON.

De payload kan een optionele file_id bevatten voor een Google Drive-bestand waartoe de verzoekende gebruiker toegang heeft.

{
    file_id?: "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4"
}

Als u file_id weglaat, wordt een nieuw document van begin af aan aangemaakt.

Responses (Antwoorden)

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

Een document ophalen

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

Haal een specifiek document op binnen een specifieke workflow.

Responses (Antwoorden)

Status	Body
200 OK	Document
403 Unauthorised	Error

Een document bijwerken

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

Werk een specifiek document bij op basis van ID.

Request (Verzoek)

Een partial (gedeeltelijk) Document-object als JSON. De payload kan elk van de bewerkbare velden van het document bevatten. Het geselecteerde bestand kan niet worden gewijzigd nadat een document is aangemaakt.

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

Responses (Antwoorden)

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