Document

Um Document representa uma configuração de modelo em um workflow. Ele aponta para um arquivo do Google Drive que é copiado para produzir cada saída.

Fields (Campos)

Field	Type	Description
id	String	O ID do documento.
documentType	String	O tipo do modelo. Pode ser "GOOGLE_DOCS" ou "GOOGLE_SLIDES", dependendo do arquivo selecionado.
file	Google File	O arquivo do Google Drive utilizado como modelo. Esse arquivo é copiado para criar o documento de saída.
outputName	String	Uma string com variáveis utilizada para nomear cada saída criada a partir deste modelo.
createPDFCopy	Boolean	Quando verdadeiro, o Portant também cria uma cópia em PDF do documento de saída.
removeOutput	Boolean	Quando verdadeiro, o documento de saída original (Google Docs ou Slides) é removido após a criação da cópia em PDF.
enablePdfPassword	Boolean	Quando verdadeiro, o PDF gerado é protegido com uma senha.
pdfPassword	String	Uma string com variáveis utilizada para gerar a senha do PDF. Utilizada apenas quando enablePdfPassword é verdadeiro.
PdfPasswordPreventCopy	Boolean	Quando verdadeiro, o conteúdo não pode ser copiado do PDF protegido por senha.
previewUrl	String	Uma URL para o editor incorporado utilizado por usuários que não são do Portant para fazer alterações neste documento por meio de campos de origem. Pressupõe que o usuário já tem acesso ao arquivo Google subjacente. Observação: este recurso ainda não está implementado e pode sofrer alterações.

Example (Exemplo)

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

Listar todos os documentos de um workflow

GET /workflows/<wkf_id>/documents/

Lista todos os documentos de um workflow específico.

Responses (Respostas)

Status	Body
200 OK	Array<Document>
403 Unauthorised	Error

Criar um documento para um workflow

POST /workflows/<wkf_id>/documents/

Cria um novo documento para o workflow.

Request (Requisição)

Um objeto Document do tipo create (criação) em formato JSON.

O payload pode incluir um file_id opcional referente a um arquivo do Google Drive ao qual o usuário solicitante tem acesso.

{
    file_id?: "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4"
}

Caso file_id seja omitido, um novo documento é criado do zero.

Responses (Respostas)

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

Obter um documento

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

Recupera um documento específico em um workflow específico.

Responses (Respostas)

Status	Body
200 OK	Document
403 Unauthorised	Error

Atualizar um documento

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

Atualiza um documento específico pelo ID.

Request (Requisição)

Um objeto Document parcial em formato JSON. O payload pode incluir qualquer um dos campos editáveis do documento. O arquivo selecionado não pode ser alterado após a criação de um documento.

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

Responses (Respostas)

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