Document

Un Document (documento) representa una configuración de plantilla en un flujo de trabajo. Apunta a un archivo de Google Drive que se copia para producir cada resultado.

Fields

Field	Type	Description
id	String	El ID del documento.
documentType	String	El tipo de plantilla. Puede ser "GOOGLE_DOCS" o "GOOGLE_SLIDES", según el archivo seleccionado.
file	Google File	El archivo de Google Drive utilizado como plantilla. Este archivo se copia para crear el documento de salida.
outputName	String	Una cadena de texto con plantilla que se usa para nombrar cada resultado creado a partir de esta plantilla.
createPDFCopy	Boolean	Cuando es true (verdadero), Portant también crea una copia en PDF del documento de salida.
removeOutput	Boolean	Cuando es true (verdadero), el documento de salida original (Google Docs o Slides) se elimina después de que se crea la copia en PDF.
enablePdfPassword	Boolean	Cuando es true (verdadero), el PDF generado se cifra con una contraseña.
pdfPassword	String	Una cadena de texto con plantilla que se usa para generar la contraseña del PDF. Solo se utiliza cuando enablePdfPassword es true.
PdfPasswordPreventCopy	Boolean	Cuando es true (verdadero), no es posible copiar contenido del PDF protegido con contraseña.
previewUrl	String	Una URL al editor integrado que permite a usuarios que no son de Portant realizar cambios en este documento a través de los campos de origen. Supone que el usuario ya tiene acceso al archivo de Google subyacente. Nota: esta función aún no está implementada y puede cambiar.

Example

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

List all documents for a workflow

GET /workflows/<wkf_id>/documents/

Lista todos los documentos de un flujo de trabajo específico.

Responses

Status	Body
200 OK	Array<Document>
403 Unauthorised	Error

Create a document for a workflow

POST /workflows/<wkf_id>/documents/

Crea un nuevo documento para el flujo de trabajo.

Request

Un objeto Document de tipo create (creación) en formato JSON.

El payload puede incluir un file_id opcional correspondiente a un archivo de Google Drive al que el usuario solicitante tenga acceso.

{
    file_id?: "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4"
}

Si omite file_id, se crea un nuevo documento desde cero.

Responses

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

Get a document

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

Recupera un documento específico de un flujo de trabajo específico.

Responses

Status	Body
200 OK	Document
403 Unauthorised	Error

Update a document

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

Actualiza un documento específico por ID.

Request

Un objeto Document partial (parcial) en formato JSON. El payload puede incluir cualquiera de los campos editables del documento. El archivo seleccionado no puede cambiarse una vez que se ha creado el documento.

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

Responses

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