{ "swagger": "2.0", "info": { "title": "Encodian - PDF", "description": "The 'Encodian - PDF' connector provides an extensive collection of actions which facilitate the manipulation and creation of PDF documents. This connector is one of nine connectors which form 'Encodian Flowr'; a complete solution for end-to-end document automation used by over 75,000 organizations. 'Encodian Flowr' powers everything from templated document creation to complex document manipulation.", "termsOfService": "https://support.encodian.com/hc/en-gb/articles/360010642813-Terms-of-Service", "contact": { "name": "Encodian Support", "url": "https://support.encodian.com", "email": "support@encodian.com" }, "license": { "name": "Create an 'Encodian Flowr' subscription", "url": "https://www.encodian.com/apikey" }, "version": "v1.0" }, "host": "api.apps-encodian.com", "schemes": [ "https" ], "paths": { "/api/v1/PDF/AddAttachmentsToPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddAttachmentsToPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoResponseAddAttachmentsToPdf", "schema": { "$ref": "#/definitions/DtoAddAttachmentsToPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Add Attachments", "description": "Add one or more attachments to the PDF file provided - https://support.encodian.com/hc/en-gb/articles/8087678202653" } }, "/api/v1/PDF/AddHtmlHeaderFooter": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddHtmlHeaderFooter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAddHtmlHeaderFooter", "schema": { "$ref": "#/definitions/DtoAddHtmlHeaderFooter" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" } } }, "x-ms-visibility": "important", "summary": "PDF - Add HTML Header or Footer", "description": "Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614" } }, "/api/v1/PDF/AddImageWatermark": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddImageWatermark", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAddImageWatermark", "schema": { "$ref": "#/definitions/DtoAddImageWatermark" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermark" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermark" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermark" } } }, "x-ms-visibility": "important", "summary": "PDF - Add Image Watermark", "description": "Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094" } }, "/api/v1/PDF/AddImageWatermarkAdvanced": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddImageWatermarkAdvanced", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAddImageWatermarkAdv", "schema": { "$ref": "#/definitions/DtoAddImageWatermarkAdv" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" } } }, "x-ms-visibility": "important", "summary": "PDF - Add Image Watermark (Advanced)", "description": "Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874" } }, "/api/v1/PDF/AddPageNumbers": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddPageNumbers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAddPageNumbers", "schema": { "$ref": "#/definitions/DtoAddPageNumbers" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddPageNumbers" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddPageNumbers" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddPageNumbers" } } }, "x-ms-visibility": "important", "summary": "PDF - Add Page Numbers", "description": "Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534" } }, "/api/v1/PDF/AddTextWatermark": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddTextWatermark", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAddTextWatermark", "schema": { "$ref": "#/definitions/DtoAddTextWatermark" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddTextWatermark" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddTextWatermark" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddTextWatermark" } } }, "x-ms-visibility": "important", "summary": "PDF - Add Text Watermark", "description": "Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494" } }, "/api/v1/PDF/AddTextWatermarkAdvanced": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AddTextWatermarkAdvanced", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAddTextWatermarkAdv", "schema": { "$ref": "#/definitions/DtoAddTextWatermarkAdv" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" } } }, "x-ms-visibility": "important", "summary": "PDF - Add Text Watermark (Advanced)", "description": "Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813" } }, "/api/v1/PDF/AIOcrPdfDocument": { "post": { "tags": [ "PDF" ], "operationId": "PDF_AIOcrPdfDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoAIOcrPdfDocument", "schema": { "$ref": "#/definitions/DtoAIOcrPdfDocument" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAIOcrPdfDocument" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAIOcrPdfDocument" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAIOcrPdfDocument" } }, "406": { "description": "Not accepted" } }, "x-ms-visibility": "important", "summary": "PDF - Apply OCR (AI)", "description": "Perform OCR on an existing PDF document using AI - https://support.encodian.com/hc/en-gb/articles/14286080106908" } }, "/api/v1/PDF/OcrPdfDocument": { "post": { "tags": [ "PDF" ], "operationId": "PDF_OcrPdfDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoOcrPdf", "schema": { "$ref": "#/definitions/DtoOcrPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseOcrPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseOcrPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseOcrPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Apply OCR (Standard)", "description": "Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653" } }, "/api/v1/PDF/PdfCheckPassword": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfCheckPassword", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfCheckPassword", "schema": { "$ref": "#/definitions/DtoPdfCheckPassword" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfCheckPassword" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfCheckPassword" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfCheckPassword" } } }, "x-ms-visibility": "important", "summary": "PDF - Check Password Protection", "description": "Check if the PDF document provided is password protected - https://support.encodian.com/hc/en-gb/articles/19822372411676" } }, "/api/v1/PDF/CompressPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_CompressPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoCompressPdf", "schema": { "$ref": "#/definitions/DtoCompressPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseCompressPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseCompressPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseCompressPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Compress", "description": "Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857-Compress-PDF" } }, "/api/v1/PDF/PdfCreateZUGFeRDInvoice": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfCreateZUGFeRDInvoice", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfCreateZUGFeRDInvoice", "schema": { "$ref": "#/definitions/DtoPdfCreateZUGFeRDInvoice" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfCreateZUGFeRDInvoice" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfCreateZUGFeRDInvoice" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfCreateZUGFeRDInvoice" } } }, "x-ms-visibility": "important", "summary": "PDF - Create ZUGFeRD Invoice", "description": "Creates a ZUGFeRD Invoice PDF document- https://support.encodian.com/hc/en-gb/articles/25232785892380" } }, "/api/v1/PDF/PdfDeleteBlankPages": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfDeleteBlankPages", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfDeleteBlankPages", "schema": { "$ref": "#/definitions/DtoPdfDeleteBlankPages" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfDeleteBlankPages" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfDeleteBlankPages" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfDeleteBlankPages" } } }, "x-ms-visibility": "important", "summary": "PDF - Delete Blank Pages", "description": "Delete blank pages from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/20692191381788" } }, "/api/v1/PDF/DeletePdfPages": { "post": { "tags": [ "PDF" ], "operationId": "PDF_DeletePdfPages", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoDeletePdfPages", "schema": { "$ref": "#/definitions/DtoDeletePdfPages" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseDeletePdfPages" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseDeletePdfPages" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseDeletePdfPages" } } }, "x-ms-visibility": "important", "summary": "PDF - Delete Pages", "description": "Delete specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13690317983132/" } }, "/api/v1/PDF/ExtractAttachmentsFromPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ExtractAttachmentsFromPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoExtractAttachmentsFromPdf", "schema": { "$ref": "#/definitions/DtoExtractAttachmentsFromPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Attachments", "description": "Extract attachments from the PDF provided - https://support.encodian.com/hc/en-gb/articles/9896328763932" } }, "/api/v1/PDF/GetPdfFormData": { "post": { "tags": [ "PDF" ], "operationId": "PDF_GetPdfFormData", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoGetPdfFormData", "schema": { "$ref": "#/definitions/DtoGetPdfFormData" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseGetPdfFormData" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseGetPdfFormData" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseGetPdfFormData" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Form Data", "description": "Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433" } }, "/api/v1/PDF/PdfExtractHyperlinks": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfExtractHyperlinks", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfExtractHyperlinks", "schema": { "$ref": "#/definitions/DtoPdfExtractHyperlinks" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractHyperlinks" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractHyperlinks" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractHyperlinks" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Hyperlinks", "description": "Extract hyperlinks from a PDF Document - https://support.encodian.com/hc/en-gb/articles/19321854618268" } }, "/api/v1/PDF/ExtractImagesAll": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ExtractImagesAll", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoExtractImagesAll", "schema": { "$ref": "#/definitions/DtoExtractImagesAll" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractImagesAll" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractImagesAll" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractImagesAll" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Images", "description": "Extract images from PDF using specified pages - https://support.encodian.com/hc/en-gb/articles/15865358154268" } }, "/api/v1/PDF/ExtractImages": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ExtractImages", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoExtractTextRegion", "schema": { "$ref": "#/definitions/DtoExtractImage" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractImage" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractImage" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractImage" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Images from Regions", "description": "Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058" } }, "/api/v1/PDF/GetPdfDocumentInfo": { "post": { "tags": [ "PDF" ], "operationId": "PDF_GetPdfDocumentInfo", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoGetPdfDocumentInfo", "schema": { "$ref": "#/definitions/DtoGetPdfDocumentInfo" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Metadata", "description": "Extract PDF Metadata information from the PDF docucment provided (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358" } }, "/api/v1/PDF/ExtractPdfPages": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ExtractPdfPages", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoExtractPdfPages", "schema": { "$ref": "#/definitions/DtoExtractPdfPages" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractPdfPages" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractPdfPages" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractPdfPages" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Pages", "description": "Extract specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13958097048732" } }, "/api/v1/PDF/ExtractPdfPagesByText": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ExtractPdfPagesByText", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoExtractPdfPagesByText", "schema": { "$ref": "#/definitions/DtoExtractPdfPagesByText" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractPdfPagesByText" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractPdfPagesByText" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractPdfPagesByText" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Pages by Text", "description": "Extract pages which contain the specified text value from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/15848695360028" } }, "/api/v1/PDF/PdfExtractTableData": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfExtractTableData", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfExtractTableData", "schema": { "$ref": "#/definitions/DtoPdfExtractTableData" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTableData" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTableData" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTableData" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Table Data", "description": "Extract structured table data from the PDF docucment provided - https://support.encodian.com/hc/en-gb/articles/15064945594268" } }, "/api/v1/PDF/GetPdfTextLayer": { "post": { "tags": [ "PDF" ], "operationId": "PDF_GetPdfTextLayer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoGetPdfTextLayer", "schema": { "$ref": "#/definitions/DtoGetPdfTextLayer" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseGetPdfTextLayer" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseGetPdfTextLayer" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseGetPdfTextLayer" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Text", "description": "Extract the text layer from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373" } }, "/api/v1/PDF/PdfExtractTextByPage": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfExtractTextByPage", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfExtractTextByPage", "schema": { "$ref": "#/definitions/DtoPdfExtractTextByPage" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTextByPage" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTextByPage" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTextByPage" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Text by Page", "description": "Extract the text layer from the PDF document provided by page - https://support.encodian.com/hc/en-gb/articles/20683984513180" } }, "/api/v1/PDF/ExtractTextRegions": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ExtractTextRegions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoExtractTextRegion", "schema": { "$ref": "#/definitions/DtoExtractTextRegion" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractTextRegion" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractTextRegion" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractTextRegion" } } }, "x-ms-visibility": "important", "summary": "PDF - Extract Text from Regions", "description": "Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353" } }, "/api/v1/PDF/FillPdfForm": { "post": { "tags": [ "PDF" ], "operationId": "PDF_FillPdfForm", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoFillPdfForm", "schema": { "$ref": "#/definitions/DtoFillPdfForm" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseFillPdfForm" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseFillPdfForm" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseFillPdfForm" } } }, "x-ms-visibility": "important", "summary": "PDF - Fill Form", "description": "Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077" } }, "/api/v1/PDF/FlattenPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_FlattenPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoFlattenPdf", "schema": { "$ref": "#/definitions/DtoFlattenPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseFlattenPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseFlattenPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseFlattenPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Flatten", "description": "Flatten a PDF document or PDF form - https://support.encodian.com/hc/en-gb/articles/4416473033105" } }, "/api/v1/PDF/PdfFlattenFields": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfFlattenFields", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfFlattenFields", "schema": { "$ref": "#/definitions/DtoPdfFlattenFields" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfFlattenFields" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfFlattenFields" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfFlattenFields" } } }, "x-ms-visibility": "important", "summary": "PDF - Flatten Fields", "description": "Flatten specified fields in the PDF file provided - https://support.encodian.com/hc/en-gb/articles/15846471073180" } }, "/api/v1/PDF/PdfGenerateBookmarks": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfGenerateBookmarks", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfGenerateBookmarks", "schema": { "$ref": "#/definitions/DtoPdfGenerateBookmarks" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfGenerateBookmarks" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfGenerateBookmarks" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfGenerateBookmarks" } } }, "x-ms-visibility": "important", "summary": "PDF - Generate Bookmarks", "description": "Generate bookmarks in the PDF document provided - https://support.encodian.com/hc/en-gb/articles/24104894573852" } }, "/api/v1/PDF/InsertHtmlToPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_InsertHtmlToPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoInsertHtmlToPdf", "schema": { "$ref": "#/definitions/DtoInsertHtmlToPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Insert HTML", "description": "Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354" } }, "/api/v1/PDF/PdfInsertPages": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfInsertPages", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfInsertPages", "schema": { "$ref": "#/definitions/DtoPdfInsertPages" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfInsertPages" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfInsertPages" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfInsertPages" } } }, "x-ms-visibility": "important", "summary": "PDF - Insert Pages", "description": "Insert pages in the PDF document provided - https://support.encodian.com/hc/en-gb/articles/25401601825692" } }, "/api/v1/PDF/PdfInsertToc": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfInsertToc", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfInsertToc", "schema": { "$ref": "#/definitions/DtoPdfInsertToc" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfInsertToc" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfInsertToc" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfInsertToc" } } }, "x-ms-visibility": "important", "summary": "PDF - Insert Table of Contents", "description": "Insert a 'Table of Contents' into the PDF document provided - https://support.encodian.com/hc/en-gb/articles/16455983120028" } }, "/api/v1/PDF/PdfLinearize": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfLinearize", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfLinearize", "schema": { "$ref": "#/definitions/DtoPdfLinearize" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfLinearize" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfLinearize" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfLinearize" } } }, "x-ms-visibility": "important", "summary": "PDF - Linearize", "description": "Linearize the PDF document provided - https://support.encodian.com/hc/en-gb/articles/16502159981852" } }, "/api/v1/PDF/MergeArrayOfDocumentsToPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_MergeArrayOfDocumentsToPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoMergeArrayOfDocumentsToPdf", "schema": { "$ref": "#/definitions/DtoMergeArrayOfDocumentsToPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Merge Files", "description": "Convert and merge an array of files to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213" } }, "/api/v1/PDF/MergeDocumentsToPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_MergeDocumentsToPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoMergeDocumentsToPdf", "schema": { "$ref": "#/definitions/DtoMergeDocumentsToPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Merge Specific Files", "description": "Convert and merge the files provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173" } }, "/api/v1/PDF/RedactPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_RedactPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoRedactPdf", "schema": { "$ref": "#/definitions/DtoRedactPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseRedactPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseRedactPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseRedactPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Redact", "description": "Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954" } }, "/api/v1/PDF/PdfRemoveDigitalSignature": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfRemoveDigitalSignature", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfRemoveDigitalSignature", "schema": { "$ref": "#/definitions/DtoPdfRemoveDigitalSignature" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfRemoveDigitalSignature" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfRemoveDigitalSignature" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfRemoveDigitalSignature" } } }, "x-ms-visibility": "important", "summary": "PDF - Remove Digital Signature", "description": "Remove the digital signature from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/19226009832348" } }, "/api/v1/PDF/RemoveWatermarksFromPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_RemoveWatermarksFromPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoRemoveWatermarkFromPdf", "schema": { "$ref": "#/definitions/DtoRemoveWatermarksFromPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Remove Watermarks", "description": "Remove specified watermark(s) from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7751328751645" } }, "/api/v1/PDF/RepairPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_RepairPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoRepairPdf", "schema": { "$ref": "#/definitions/DtoRepairPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseRepairPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseRepairPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseRepairPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Repair", "description": "Repair a PDF document - https://support.encodian.com/hc/en-gb/articles/4418809972753" } }, "/api/v1/PDF/PdfReplaceTextWithImage": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfReplaceTextWithImage", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfReplaceTextWithImage", "schema": { "$ref": "#/definitions/DtoPdfReplaceTextWithImage" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfReplaceTextWithImage" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfReplaceTextWithImage" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfReplaceTextWithImage" } } }, "x-ms-visibility": "important", "summary": "PDF - Replace Text with Image", "description": "Find and replace text contained within a PDF document with an image - https://support.encodian.com/hc/en-gb/articles/15083146797084" } }, "/api/v1/PDF/ResizePdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ResizePdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfResize", "schema": { "$ref": "#/definitions/DtoResizePdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseResizePdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseResizePdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseResizePdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Resize", "description": "Resize a PDF document - https://support.encodian.com/hc/en-gb/articles/12292028562588" } }, "/api/v1/PDF/RotatePdfPages": { "post": { "tags": [ "PDF" ], "operationId": "PDF_RotatePdfPages", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoRotatePdfPages", "schema": { "$ref": "#/definitions/DtoRotatePdfPages" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseRotatePdfPages" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseRotatePdfPages" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseRotatePdfPages" } } }, "x-ms-visibility": "important", "summary": "PDF - Rotate Pages", "description": "Rotate specified pages of the PDF document provided - https://support.encodian.com/hc/en-gb/articles/14798407011356" } }, "/api/v1/PDF/PdfSearchAndReplaceText": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfSearchAndReplaceText", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfSearchAndReplaceText", "schema": { "$ref": "#/definitions/DtoPdfSearchAndReplaceText" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfSearchAndReplaceText" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfSearchAndReplaceText" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfSearchAndReplaceText" } } }, "x-ms-visibility": "important", "summary": "PDF - Replace Text", "description": "Find and replace text contained within a PDF document - https://support.encodian.com/hc/en-gb/articles/15962260285980" } }, "/api/v1/PDF/SecurePdfDocument": { "post": { "tags": [ "PDF" ], "operationId": "PDF_SecurePdfDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoSecurePdf", "schema": { "$ref": "#/definitions/DtoSecurePdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSecurePdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSecurePdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSecurePdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Secure", "description": "Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document" } }, "/api/v1/PDF/PdfSetMetadata": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfSetMetadata", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfSetMetadata", "schema": { "$ref": "#/definitions/DtoPdfSetMetadata" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfSetMetadata" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfSetMetadata" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfSetMetadata" } } }, "x-ms-visibility": "important", "summary": "PDF - Set Metadata", "description": "Set the metadata of the PDF document provided - https://support.encodian.com/hc/en-gb/articles/15925135243292" } }, "/api/v1/PDF/SetPdfPrivileges": { "post": { "tags": [ "PDF" ], "operationId": "PDF_SetPdfPrivileges", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoSetPdfPrivileges", "schema": { "$ref": "#/definitions/DtoSetPdfPrivileges" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSecurePdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSecurePdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSecurePdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Set Privileges", "description": "Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094" } }, "/api/v1/PDF/SignPdf": { "post": { "tags": [ "PDF" ], "operationId": "PDF_SignPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "certificateTypeParameter", "description": "Set the certificate type", "type": "string", "enum": [ "Standard", "Custom" ], "x-ms-visibility": "important", "x-ms-summary": "Certificate Type" }, { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoSignPdf", "schema": { "$ref": "#/definitions/DtoPdfSignPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSignPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSignPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSignPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Sign", "description": "Apply a digital signature to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7117159708189" } }, "/api/v1/PDF/SplitDocument": { "post": { "tags": [ "PDF" ], "operationId": "PDF_SplitDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoSplitDocument", "schema": { "$ref": "#/definitions/DtoSplitDocument" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } } }, "x-ms-visibility": "important", "summary": "PDF - Split", "description": "Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277" } }, "/api/v1/PDF/SplitPdfByBarcode": { "post": { "tags": [ "PDF" ], "operationId": "PDF_SplitPdfByBarcode", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoSplitPdfByBarcode", "schema": { "$ref": "#/definitions/DtoSplitPdfByBarcode" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByBarcode" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByBarcode" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByBarcode" } } }, "x-ms-visibility": "important", "summary": "PDF - Split by Barcode", "description": "Split a PDF Document by Barcode, returning multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360013629457" } }, "/api/v1/PDF/SplitPdfByText": { "post": { "tags": [ "PDF" ], "operationId": "PDF_SplitPdfByText", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoSplitPdfByText", "schema": { "$ref": "#/definitions/DtoSplitPdfByText" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByText" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByText" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByText" } } }, "x-ms-visibility": "important", "summary": "PDF - Split by Text", "description": "Split a PDF Document by text into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360012726397" } }, "/api/v1/PDF/UnlockPdfDocument": { "post": { "tags": [ "PDF" ], "operationId": "PDF_UnlockPdfDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoUnlockPdf", "schema": { "$ref": "#/definitions/DtoUnlockPdf" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseUnlockPdf" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseUnlockPdf" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseUnlockPdf" } } }, "x-ms-visibility": "important", "summary": "PDF - Unlock", "description": "Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237" } }, "/api/v1/PDF/PdfUpdateHyperlinks": { "post": { "tags": [ "PDF" ], "operationId": "PDF_PdfUpdateHyperlinks", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPdfUpdateHyperlinks", "schema": { "$ref": "#/definitions/DtoPdfUpdateHyperlinks" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfUpdateHyperlinks" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfUpdateHyperlinks" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfUpdateHyperlinks" } } }, "x-ms-visibility": "important", "summary": "PDF - Update Hyperlinks", "description": "Find and replace hyperlinks contained within the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7437413638301" } }, "/api/v1/PDF/ValidatePdfTextLayer": { "post": { "tags": [ "PDF" ], "operationId": "PDF_ValidatePdfTextLayer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoValidatePdfTextLayerPages", "schema": { "$ref": "#/definitions/DtoValidatePdfTextLayer" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseValidatePdfTextLayer" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseValidatePdfTextLayer" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseValidatePdfTextLayer" } } }, "x-ms-visibility": "important", "summary": "PDF - Validate Text Layer", "description": "Validate whether a text layer is present within the PDF document provided - https://support.encodian.com/hc/en-gb/articles/14453068327196" } }, "/api/v1/PDF/GetOperationStatusAddWatermark": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusAddWatermark", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of an AddImageWatermark, AddImageWatermarkAdv, AddTextWatermark or AddTextWatermarkAdv operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermark" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermark" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseAddImageWatermark" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for Add Watermark Actions", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusAddWatermarkFileOnly": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusAddWatermarkFileOnly", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of an AddImageWatermark, AddImageWatermarkAdv, AddTextWatermark or AddTextWatermarkAdv operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnlyWatermark" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnlyWatermark" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnlyWatermark" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for Add Watermark Actions (File Only)", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusExtractImage": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusExtractImage", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of an ExtractImage operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractImage" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractImage" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractImage" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for ExtractImage", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusExtractTextRegion": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusExtractTextRegion", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of an ExtractTextRegion operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseExtractTextRegion" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseExtractTextRegion" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseExtractTextRegion" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for ExtractTextRegion", "description": "Retrieve the operation status of an ExtractTextRegion operation for the Operation ID provided." } }, "/api/v1/PDF/GetOperationStatusGetPdfDocumentInfo": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusGetPdfDocumentInfo", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a GetPdfDocumentInfo operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for GetPdfDocumentInfo", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusGetPdfFormData": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusGetPdfFormData", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a GetPdfFormData operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseGetPdfFormData" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseGetPdfFormData" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseGetPdfFormData" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for GetPdfFormData", "description": "Retrieve the operation status of a GetPdfFormData operation for the Operation ID provided." } }, "/api/v1/PDF/GetOperationStatusGetPdfTextLayer": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusGetPdfTextLayer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a GetPdfTextLayer operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseGetPdfTextLayer" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseGetPdfTextLayer" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseGetPdfTextLayer" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for GetPdfTextLayer", "description": "Retrieve the operation status of a GetPdfTextLayer operation for the Operation ID provided." } }, "/api/v1/PDF/GetOperationStatusSplitDocument": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusSplitDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a SplitDocument operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for SplitDocument", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusValidatePdfTextLayer": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusValidatePdfTextLayer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of an ValidatePdfTextLayer operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseValidatePdfTextLayer" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseValidatePdfTextLayer" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseValidatePdfTextLayer" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for ValidatePdfTextLayer", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusString": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusString", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a GetString operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseString" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseString" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseString" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for String", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusPdfSplitBarcode": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusPdfSplitBarcode", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of an PdfSplitBarcode operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByBarcode" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByBarcode" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSplitPdfByBarcode" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for PdfSplitBarcode", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusPdfCheckPassword": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusPdfCheckPassword", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a PdfCheckPassword operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfCheckPassword" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfCheckPassword" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfCheckPassword" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for PdfCheckPassword", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusPdfExtractTextByPage": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusPdfExtractTextByPage", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a PdfExtractTextByPage operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTextByPage" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTextByPage" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePdfExtractTextByPage" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for PdfExtractTextByPage", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PDF/GetDynamicSchemaSignPdf": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetDynamicSchemaSignPdf", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "certificateType", "type": "string", "x-ms-summary": "Certificate Type", "description": "The output format to obtain the dynamic schema for." }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request" } }, "x-ms-visibility": "internal", "summary": "Get Sign PDF Schema", "description": "Provides the dynamic schema for the Sign PDF action." } }, "/api/v1/PDF/GetOperationStatus": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatus", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status", "description": "Get the operation status for the operation ID provided." } }, "/api/v1/PDF/GetOperationStatusChd": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusChd", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status for the CHD Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for CHD", "description": "Get the operation status of for the CHD operation ID provided." } }, "/api/v1/PDF/GetOperationStatusFileOnly": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusFileOnly", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status for a file only operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnly" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnly" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnly" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for File Only", "description": "Retrieve the operation status for a file only operation for the Operation ID provided" } }, "/api/v1/PDF/GetOperationStatusMultipleFiles": { "get": { "tags": [ "PDF" ], "operationId": "PDF_GetOperationStatusMultipleFiles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a MultipleFiles operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseMultipleFiles" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseMultipleFiles" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseMultipleFiles" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for Multiple Files", "description": "Get the operation status of the operation ID provided." } } }, "definitions": { "DocumentArray": { "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the file" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the file" } } }, "DocumentArrayPdfSplitByBarcode": { "required": [ "fileContent", "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "barcodeValue": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Barcode Value", "description": "The value of the Barcode used to perform the split operation" } } }, "DtoAIOcrPdfDocument": { "required": [ "fileContent", "rotateConfidenceLevel" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "adjustBrightnessContrast": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Adjust Brightness and Contrast", "description": "This action analyzes a document and automatically adjusts brightness and contrast based on the analysis." }, "averageFilter": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Average Filter", "description": "Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window." }, "binarize": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Binarize", "description": "Computes all necessary parameters by analyzing the input data before actually performing the binarization. The algorithm is tuned to typical document images, consisting of dark text on brighter background. It is robust to shadows, noise and background images." }, "deskew": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Deskew", "description": "Detects the skew angle and rotates to remove that skew." }, "despeckle": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Despeckle", "description": "Automatically detects speckles and removes them." }, "imageDetergent": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Image Detergent", "description": "Image Detergent works by changing pixels of similar color values to a central color value, which has the result of smoothing the image wherever regions of those colors appear." }, "removeBorder": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Border", "description": "Locates border pixels and removes the pixels from the document,this is disabled by default." }, "removeDotShading": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Dot Shading", "description": "This action will remove shaded regions from bitonal documents." }, "removeHolePunch": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Hole Punch", "description": "Detects and removes hole punch marks from a bitonal document." }, "rotate": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Auto Rotate", "description": "Automatically detects orientation and rotates it so that the text on it is upright oriented" }, "smoothBackground": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Smooth Background", "description": "This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise." }, "smoothObjects": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Smooth Objects", "description": "This only works on bitonal documents, it looks at groups of pixels, and finds isolated bumps and pits in the edges of those objects, and fills them in." }, "rotateConfidenceLevel": { "format": "int32", "default": 0, "type": "integer", "x-ms-visibility": "internal", "x-ms-summary": "Rotate Confidence Level", "description": "Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60." } } }, "DtoAddAttachmentsToPdf": { "required": [ "attachments", "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Attachments", "description": "The array of files to be attached" } } }, "DtoAddHtmlHeaderFooter": { "required": [ "FileName", "htmlHeaderFooter", "htmlHeaderFooterLocation" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "htmlHeaderFooter": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "HTML Header / Footer", "description": "The HTML to embed as a header or footer within the document" }, "htmlHeaderFooterLocation": { "enum": [ "Header", "Footer", "Both" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Location", "description": "Set whether the HTML should be added to the header, footer of both locations." }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Skip First Page", "description": "Set whether to ignore the first page when the header / footers are added." }, "marginTop": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Top Margin", "description": "Set the top margin value (mm)." }, "marginBottom": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Bottom Margin", "description": "Set the bottom margin value (mm)." }, "marginRight": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Right Margin", "description": "Set the right margin value (mm)." }, "marginLeft": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Left Margin", "description": "Set the left margin value (mm)." }, "applyTo": { "default": "AllPages", "enum": [ "FirstPage", "AllPages", "LastPage", "Specific" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Apply To", "description": "Set which pages within the PDF document to apply the HTML header or footer." }, "pageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "Specify the page numbers where the HTML header or footer should be applied, this property only applies when the 'Apply To' property is set to 'Specific'." }, "ignorePageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "advanced", "x-ms-summary": "Ignore Page Numbers", "description": "Specify the page numbers where the HTML header or footer should not applied, this property only applies when the 'Apply To' property is set to 'Specific'." }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "finalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoAddImageWatermark": { "required": [ "FileName", "watermarkFileContent", "watermarkFilename" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "watermarkFilename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Watermark Filename", "description": "The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'" }, "watermarkFileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Watermark File Content", "description": "The content of the watermark image file" }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Skip First Page", "description": "Set whether to skip applying the watermark to the first page." }, "Orientation": { "default": "Horizontal", "enum": [ "Vertical", "Horizontal", "Diagonal" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Orientation", "description": "The orientation of the image to embed as a watermark within the document" }, "Opacity": { "format": "float", "default": 0.7, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Opacity", "description": "The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7" }, "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Watermark ID", "description": "Override and manually set an identifier for the applied watermark" }, "alignImage": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Align Image", "description": "Assure that the image provided is aligned to the EXIF orientation tags" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoAddImageWatermarkAdv": { "required": [ "FileName", "watermarkFileContent", "watermarkFilename" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "watermarkFilename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Watermark Filename", "description": "The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'" }, "watermarkFileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Watermark File Content", "description": "The content of the watermark image file" }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Skip First Page", "description": "Set whether to skip applying the watermark to the first page." }, "applyTo": { "default": "AllPages", "enum": [ "FirstPage", "AllPages", "LastPage", "Specific" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Apply To", "description": "Set where in the document to apply the watermark." }, "pageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "important", "x-ms-summary": "Page Numbers", "description": "Specify the page numbers where the watermark should be applied, this only applies when the 'Apply To' property is set to 'Specific'." }, "ignorePageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "important", "x-ms-summary": "Ignore Page Numbers", "description": "Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'." }, "opacity": { "format": "float", "default": 0.7, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Watermark Opacity", "description": "The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7" }, "rotationAngle": { "format": "float", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Rotation Angle", "description": "Set the rotation angle of the image watermark in degrees." }, "quality": { "format": "int32", "default": 100, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Quality", "description": "Set the quality of the image watermark from 1 to 100." }, "imageXOffset": { "format": "float", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "X Offset", "description": "Set the X offset for positioning the watermark image on the page." }, "imageYOffSet": { "format": "float", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Y Offset", "description": "Set the Y offset for positioning the watermark image on the page." }, "scale": { "format": "float", "default": 1, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Scale", "description": "Set the multiple to either reduce (less than 1.0) or increase the size of the image (greater than 1.0), for example: 1.2 is equal to 120%, and 0.7 is equal to 70%." }, "addToBackground": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Add to Background", "description": "If set to 'true' the watermark image will be added to the background of the page." }, "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "Override and manually set an identifier for the applied watermark" }, "alignImage": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Align Image", "description": "Assure that the image provided is aligned to the EXIF orientation tags" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoAddPageNumbers": { "required": [ "FileName" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "StartPage": { "format": "int32", "default": 1, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Start Page", "description": "Set which page to start adding page number(s) from." }, "StartNumber": { "format": "int32", "default": 1, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Start Number", "description": "Set the starting number for the page number(s) added to the document." }, "PageNumberFormat": { "default": "[PageNumber] of [TotalPages]", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Number Format", "description": "Set the format of the page number(s) added to the document, where [PageNumber] is replaced by the current page number and [TotalPages] is replaced by the total number of pages." }, "HorizontalAlignment": { "default": "Center", "enum": [ "None", "Left", "Center", "Right", "Justify", "FullJustify" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Horizontal Alignment", "description": "Set the horizontal alignment of the page number(s) added to the document, the default value is Center." }, "CustomNumberFormat": { "default": "", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Custom Number Format", "description": "Set a custom number format, for example '{0:00000}' would generate 00001" }, "MarginTop": { "format": "double", "default": 20, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Margin - Top", "description": "Set the top margin value (pt). The default value is set to 20." }, "MarginRight": { "format": "double", "default": 20, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Margin - Right", "description": "Set the right margin value(pt). The default value is set to 20." }, "MarginBottom": { "format": "double", "default": 20, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Margin - Bottom", "description": "Set the bottom margin value (pt). The default value is set to 20." }, "MarginLeft": { "format": "double", "default": 20, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Margin - Left", "description": "Set the left margin value (pt). The default value is set to 20." }, "AddToBackground": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Add to Background", "description": "Set whether the page number(s) should be added to top or bottom layer of the PDF document. The default setting (false) adds the page number(s) to the top layer." }, "Font": { "default": "Arial", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font", "description": "Specify the name of the font, if the font cannot be found the default 'Arial' will be used." }, "FontColour": { "default": "#000000", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font Colour", "description": "Set the HTML colour of the font, the default colour is set to #000000." }, "FontSize": { "format": "int32", "default": 14, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Font Size", "description": "Set the size of the font, the default size is set to 14." }, "Opacity": { "format": "float", "default": 1, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Opacity", "description": "Set the opacity of the page number(s), valid values range from 0.0+ to 1.0, the default value is 1.0" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoAddTextWatermark": { "required": [ "FileName", "Text" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "Text": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text", "description": "The text to embed as a watermark within the document" }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Skip First Page", "description": "Set whether to skip applying the watermark to the first page." }, "Orientation": { "default": "Horizontal", "enum": [ "Vertical", "Horizontal", "Diagonal" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Orientation", "description": "The orientation of the text to embed as a watermark within the document" }, "horizontalAlignment": { "default": "Center", "enum": [ "Left", "Center", "Right", "FullJustify", "Justify", "None" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Alignment - Horizontal", "description": "Set the horizontal alignment of the watermark, the default value is Center." }, "verticalAlignment": { "default": "Center", "enum": [ "Top", "Center", "Bottom", "None" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Alignment - Vertical", "description": "Set the vertical alignment of the watermark, the default value is Center." }, "Font": { "default": "Arial", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font", "description": "The font applied to the text watermark, the default font is set to Arial." }, "TextColour": { "default": "#E81123", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Colour", "description": "The HTML colour applied to the text watermark, the default colour is set to #E81123." }, "TextSize": { "format": "int32", "default": 34, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Size", "description": "The size of the font applied to the text watermark, the default size is set to 34." }, "Opacity": { "format": "float", "default": 1, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Opacity", "description": "The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0" }, "padding": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Padding", "description": "A comma delimited padding configuration 5,0,5,0 in the order top, right, bottom, left" }, "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Watermark ID", "description": "Override and manually set an identifier for the applied watermark" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoAddTextWatermarkAdv": { "required": [ "FileName", "Text" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "Text": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text", "description": "The text to embed as a watermark within the document. Add carriage return control characters (backslash r) to manually split text onto new lines." }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Skip First Page", "description": "Set whether to skip applying the watermark to the first page." }, "ApplyTo": { "default": "AllPages", "enum": [ "FirstPage", "AllPages", "LastPage", "Specific" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Apply To", "description": "Set where in the document to apply the watermark." }, "pageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "important", "x-ms-summary": "Page Numbers", "description": "Specify the page numbers where the watermark should be applied, this proporty only applies when the 'Apply To' property is set to 'Specific'." }, "ignorePageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "important", "x-ms-summary": "Page Numbers - Ignore", "description": "Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'." }, "HorizontalAlignment": { "default": "Center", "enum": [ "Left", "Center", "Right", "FullJustify", "Justify", "None" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Alignment - Horizontal", "description": "Set the horizontal alignment of the watermark, the default value is Center." }, "VerticalAlignment": { "default": "Center", "enum": [ "Top", "Center", "Bottom", "None" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Alignment - Vertical", "description": "Set the vertical alignment of the watermark, the default value is Center." }, "TextAlignment": { "default": "Center", "enum": [ "None", "Left", "Center", "Right", "Justify", "FullJustify" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Alignment - Text", "description": "Set the text alignment of the watermark, the default value is Center." }, "watermarkApplyAsImage": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Apply as an Image", "description": "Set whether the text watermark should be added as text or an image." }, "AutoScale": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Auto Scale", "description": "Set the whether the text should be automatically sized to fit the width of the container." }, "AutoScaleWidth": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Auto Scale - Text Width", "description": "Set the width of the watermark container when automatic scaling is enabled." }, "AutoScaleHeight": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Auto Scale - Text Height", "description": "Set the height of the watermark container when automatic scaling is enabled." }, "EncodingType": { "default": "Winansi", "enum": [ "Identity_h", "Identity_v", "Cp1250", "Cp1252", "Cp1257", "Winansi", "Macroman" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Encoding Type", "description": "The encoding type to apply to the text watermark." }, "Font": { "default": "Arial", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Font", "description": "The font applied to the text watermark, the default font is set to Arial." }, "TextColour": { "default": "#E81123", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Font - Colour", "description": "The HTML colour applied to the text watermark, the default colour is set to #E81123." }, "TextSize": { "format": "int32", "default": 34, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Font - Size", "description": "The size of the font applied to the text watermark, the default size is set to 34." }, "Opacity": { "format": "float", "default": 1, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Opacity", "description": "The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0" }, "padding": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Padding", "description": "A comma delimited padding configuration 5,0,5,0 in the order top, right, bottom, left" }, "RotationAngle": { "format": "float", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Rotation Angle", "description": "Set the rotation angle of the text watermark." }, "TextLayer": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Text Layer", "description": "Set whether the watermark should be added to the top or bottom layer. If 'True' the watermark is added to the bottom layer." }, "TextWrap": { "default": true, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Text Wrap", "description": "Set whether the text watermark should automatically wrap." }, "TextWrapRowWidth": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Text Wrap - Row Width", "description": "Set the row width applied when the watermark is set to automatically wrap." }, "YIndent": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Y Indent", "description": "Set the vertical watermark indent, starting from the bottom and overriding the VerticalAlignment property." }, "XIndent": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "X Indent", "description": "Set the horizontal watermark indent, starting from the left and overriding the HorizontalAlignment property." }, "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "Override and manually set an identifier for the applied watermark" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoBaseMgmtResponse": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoBaseMgmtResponseFileOnly": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoBaseMgmtResponseFileOnlyWatermark": { "type": "object", "properties": { "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "The identifier applied to the watermark" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoCompressPdf": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "compressImages": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Compress Images", "description": "Contained images will be compressed, aligned to the value of the 'Image Quality' property" }, "imageQuality": { "format": "int32", "default": 80, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Image Quality", "description": "Sets the quality for compressed images: 1 > 100" }, "maxResolution": { "format": "int32", "default": 150, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Max Resolution", "description": "Specifies the maximum resolution of images (dpi), if the image has a higher resolution it will be scaled dynamically." }, "resizeImages": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Resize Images", "description": "If 'Compress Images' and 'Resize Images' are enabled, images will be resized where the image resolution is greater than the specified 'Max Resolution' property." }, "removePrivateInfo": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Private Info", "description": "Remove private information from the PDF document, i.e. page piece information." }, "removeUnusedObjects": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Unused Objects", "description": "Remove all unused objects (i.e. objects which do not have a reference) are removed from PDF document." }, "removeUnusedStreams": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Unused Streams", "description": "Remove all unused resources from the PDF document." }, "linkDuplicateStreams": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Link Duplicate Streams", "description": "Link duplicate streams and store them as a single object. This can decrease document size in some cases (for example, where the same document was merged multiple times)." }, "allowReusePageContent": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Allow Reuse Page Content", "description": "Page contents will be reused when the PDF document is optimized for equal pages." }, "unembedFonts": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Unembed Fonts", "description": "Remove all embedded fonts. The document size will decrease but the document may become unreadable if the correct font is not installed on the user's machine." }, "flattenAnnotations": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Flatten Annotations", "description": "Flatten all annotations contained within the PDF document." }, "deleteAnnotations": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Delete Annotations", "description": "Delete all annotations contained within the PDF document." }, "flattenFields": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Flatten Fields", "description": "Flatten all fields contained within the PDF document (AcroForms only)." } } }, "DtoDeletePdfPages": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "StartPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Start Page", "description": "Set the page number to begin deleting pages from" }, "EndPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "End Page", "description": "Set the page number to stop deleting pages on. The default value is set to the last page of the PDF document provided" }, "pageNumbers": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers of the pages to delete: 1,3,4" } } }, "DtoExtractAttachmentsFromPdf": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" } } }, "DtoExtractImage": { "required": [ "FileName", "ImageRegions" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "ImageRegions": { "type": "array", "items": { "$ref": "#/definitions/ImageRegion" }, "x-ms-visibility": "important", "x-ms-summary": "Image Regions", "description": "The collection of regions to to extract images from and return." }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoExtractImagesAll": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "mode": { "default": "Document", "enum": [ "Document", "Resources" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Mode", "description": "Set the image extraction mode (Document or Resources)" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Set the page number to begin extracting images from. By default the first page will be selected" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Set the page number to stop extracting images on. By default the last page will be selected" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers which images should be extracted from: 1,3,4" } } }, "DtoExtractPdfPages": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "StartPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Start Page", "description": "Set the page number to begin extracting pages from" }, "EndPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "End Page", "description": "Set the page number to stop extracting pages on. The default value is set to the last page of the PDF document provided" }, "pageNumbers": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers of the pages to extract: 1,3,4" } } }, "DtoExtractPdfPagesByText": { "required": [ "fileContent", "searchValue" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "searchValue": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Search Value", "description": "Specify either a text value or a regular expression" }, "isExpression": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Is Expression", "description": "Set whether the 'Search Value' should be evaluated as a regular expression, the default value is 'false'" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "A comma-separated string of the pages which should searched for the 'Search Value'. By default, all pages will be searched" } } }, "DtoExtractTextRegion": { "required": [ "FileName", "TextRegions" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "TextRegions": { "type": "array", "items": { "$ref": "#/definitions/TextRegion" }, "x-ms-visibility": "important", "x-ms-summary": "Text Regions", "description": "The collection of regions to to extract text from and return." }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoFillPdfForm": { "required": [ "FileName", "formData" ], "type": "object", "properties": { "FileName": { "default": "form.pdf", "type": "string", "x-ms-visibility": "internal", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "formData": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Form Data", "description": "The JSON data to populate with the PDF Form with." } } }, "DtoFlattenPdf": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" } } }, "DtoGetPdfDocumentInfo": { "required": [ "fileContent", "FileName" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "operationId": { "type": "string", "x-ms-visibility": "internal", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoGetPdfFormData": { "required": [ "FileName", "FinalOperation" ], "type": "object", "properties": { "FileName": { "default": "form.pdf", "type": "string", "x-ms-visibility": "internal", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": false, "type": "boolean", "x-ms-visibility": "internal", "x-ms-summary": "Final Operation", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoGetPdfTextLayer": { "required": [ "FileName" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "StartPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Sets the page number to begin text layer extraction from." }, "EndPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Sets the page number to end text layer extraction from. The default value is set to the last page of the PDF document provided." }, "removeControlCharacters": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Control Characters", "description": "Set whether to automatically remove 'Control Characters' from the extracted text" }, "TextEncodingType": { "default": "UTF8", "enum": [ "Default", "Latin1", "BigEndianUnicode", "UTF16", "UTF8", "UTF7", "ASCII" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Encoding Type", "description": "The encoding type used for text extraction." }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoInsertHtmlToPdf": { "required": [ "FileName", "FinalOperation", "htmlData" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "htmlData": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "HTML Data", "description": "The HTML which will be inserted into the PDF document" }, "htmlInsertLocation": { "default": "Prepend", "enum": [ "Append", "Prepend", "Specific" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "HTML Insert Location", "description": "Set where within the PDF provided, the HTML data should be inserted, the default value is Prepend." }, "htmlInsertLocationPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Page Number", "description": "Set a specific page location to insert the HTML data into." }, "pageOrientation": { "default": "Portrait", "enum": [ "Portrait", "Landscape" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Orientation", "description": "Set page oprientation (Landscape or portrait)." }, "pageSize": { "default": "A4", "enum": [ "Default", "A1", "A2", "A3", "A4", "A5", "A6", "B4", "B5", "EnvelopeDL", "Executive", "Folio", "Ledger", "Legal", "Letter", "Quarto", "Statement", "Tabloid", "Custom" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Size", "description": "Set the page size for the output PDF document, A4 is the default size." }, "viewPort": { "default": "Default", "enum": [ "Default", "Mobile", "Tablet", "Laptop", "LaptopL", "FourK" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Viewport", "description": "Set the viewport used to render the HTML." }, "MarginTop": { "format": "double", "default": 25, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Top Margin", "description": "Set the top margin value (mm)" }, "MarginBottom": { "format": "double", "default": 25, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Bottom Margin", "description": "Set the bottom margin value (mm)" }, "MarginRight": { "format": "double", "default": 25, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Right Margin", "description": "Set the right margin value (mm)" }, "MarginLeft": { "format": "double", "default": 25, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Left Margin", "description": "Set the left margin value (mm)" }, "pageWidth": { "format": "int32", "default": 0, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Page Width", "description": "Set the page width value (pixels)" }, "pageHeight": { "format": "int32", "default": 0, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Page Height", "description": "Set the page height value (pixels)" }, "decodeHtmlData": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Decode HTML Data", "description": "Set whether the data provided in the HTML Data field should be decoded." }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "internal", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoMergeArrayOfDocumentsToPdf": { "required": [ "documents", "FileName", "outputFilename" ], "type": "object", "properties": { "outputFilename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "PDF Filename", "description": "The filename of the output PDF document" }, "FileName": { "default": "default.doc", "type": "string", "x-ms-visibility": "internal", "x-ms-summary": "Filename", "description": "The filename of the source file" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents to be processed" }, "generateBookmarks": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Generate Bookmarks", "description": "Generate a bookmark for each merged PDF document" }, "pageNormalisation": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Page Normalisation", "description": "Set whether to normalise the page width/height to the dimensions of the first file" }, "preserveBookmarks": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Preserve Bookmarks", "description": "Preserve bookmarks contained within each merged PDF document" }, "removeDocumentMarkup": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Markup", "description": "Set MS Office document comments and tracked changes removal option" }, "pdfaCompliance": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "PDF/A Compliant", "description": "Set PDF/A Compliance option" }, "pdfaComplianceLevel": { "default": "PDF_A_2A", "enum": [ "PDF_A_1A", "PDF_A_1B", "PDF_A_2A", "PDF_A_3A", "PDF_A_2B", "PDF_A_2U", "PDF_A_3B", "PDF_A_3U", "v_1_3", "v_1_4", "v_1_5", "v_1_6", "v_1_7", "PDF_X_1A", "PDF_X_3" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "PDF/A Compliance Level", "description": "Set the PDF/A Compliance Level, the default value is PDF_A_2A" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoMergeDocumentsToPdf": { "required": [ "fileContent", "fileContent2", "FileName", "fileName2", "outputFilename" ], "type": "object", "properties": { "outputFilename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "PDF Filename", "description": "The filename of the output PDF document" }, "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the 1st source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "fileName2": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 2", "description": "The filename of the 2nd source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent2": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 2", "description": "The file content of the 2nd source file" }, "fileName3": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 3", "description": "The filename of the 3rd source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent3": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 3", "description": "The file content of the 3rd source file" }, "fileName4": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 4", "description": "The filename of the 4th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent4": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 4", "description": "The file content of the 4th source file" }, "fileName5": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 5", "description": "The filename of the 5th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent5": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 5", "description": "The file content of the 5th source file" }, "fileName6": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 6", "description": "The filename of the 6th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent6": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 6", "description": "The file content of the 6th source file" }, "fileName7": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 7", "description": "The filename of the 7th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent7": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 7", "description": "The file content of the 7th source file" }, "fileName8": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 8", "description": "The filename of the 8th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent8": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 8", "description": "The file content of the 8th source file" }, "fileName9": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 9", "description": "The filename of the 9th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent9": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 9", "description": "The file content of the 9th source file" }, "fileName10": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename 10", "description": "The filename of the 10th source file, the file extension is mandatory: 'file.xlsx' and not 'file'" }, "fileContent10": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content 10", "description": "The file content of the 10th source file" }, "generateBookmarks": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Generate Bookmarks", "description": "Generate a bookmark for each merged PDF document" }, "pageNormalisation": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Page Normalisation", "description": "Set whether to normalise the page width/height to the dimensions of the first file" }, "preserveBookmarks": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Preserve Bookmarks", "description": "Preserve bookmarks contained within each merged PDF document" }, "removeDocumentMarkup": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Markup", "description": "Set MS Office document comments and tracked changes removal option" }, "pdfaCompliance": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "PDF/A Compliant", "description": "Set PDF/A Compliance option" }, "pdfaComplianceLevel": { "default": "PDF_A_2A", "enum": [ "PDF_A_1A", "PDF_A_1B", "PDF_A_2A", "PDF_A_3A", "PDF_A_2B", "PDF_A_2U", "PDF_A_3B", "PDF_A_3U", "v_1_3", "v_1_4", "v_1_5", "v_1_6", "v_1_7", "PDF_X_1A", "PDF_X_3" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "PDF/A Compliance Level", "description": "Set the PDF/A Compliance Level, the default value is PDF_A_2A." }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoOcrPdf": { "required": [ "AutoRotateConfidenceLevel", "FileName" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "ocrLanguage": { "default": "English", "enum": [ "Albanian", "Arabic", "Azerbaijani", "Basque", "Belarusian", "Bengali", "Bosnian", "Bulgarian", "Burmese", "Catalan", "ChineseSimplified", "ChineseTraditional", "Croatian", "Czech", "Danish", "Dutch", "English", "Estonian", "Finnish", "French", "Georgian", "German", "Greek", "Gujarati", "Hebrew", "Hindi", "Hungarian", "Icelandic", "Indonesian", "Italian", "Japanese", "Kannada", "Kazakh", "Khmer", "Korean", "Kurdish", "Kyrgyz", "Laotian", "Latin", "Latvian", "Lithuanian", "Macedonian", "Maharashtra", "Malay", "Malayalam", "Maltese", "Nepali", "Norwegian", "Oriya", "Panjabi", "Persian", "Polish", "Portuguese", "Pushto", "Romanian", "Russian", "Sanskrit", "Serbian", "Singhalese", "Slovakian", "Slovenian", "Spanish", "Swahili", "Swedish", "Syriac", "Tamil", "Telugu", "Thai", "Turkish", "Ukrainian", "Urdu", "Uzbek", "Vietnamese", "Welsh", "Yiddish" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Language", "description": "Select the language used for OCR processing" }, "ocrType": { "default": "Quality", "enum": [ "Quality", "Fast" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "OCR Type", "description": "Select the OCR processing type, the 'Fast' option reduces processing time with possible minor loss of OCR accuracy - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document" }, "pdfaCompliance": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "PDF/A Compliant", "description": "Set PDF/A Compliance option" }, "pdfaComplianceLevel": { "default": "PDF_A_2A", "enum": [ "PDF_A_1A", "PDF_A_1B", "PDF_A_2A", "PDF_A_3A", "PDF_A_2B", "PDF_A_2U", "PDF_A_3B", "PDF_A_3U", "v_1_3", "v_1_4", "v_1_5", "v_1_6", "v_1_7", "PDF_X_1A", "PDF_X_3" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "PDF/A Compliance Level", "description": "Set the PDF/A Compliance Level, the default value is PDF_A_2A." }, "cleanUpType": { "default": "None", "enum": [ "Default", "None", "Specific" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Clean Operations", "description": "Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document." }, "AutoRotate": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Auto Rotate", "description": "Automatically detects orientation and rotates it so that the text on it is upright oriented" }, "Deskew": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Deskew", "description": "Detects the skew angle and rotates to remove that skew." }, "Despeckle": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Despeckle", "description": "Automatically detects speckles and removes them." }, "AdjustBrightnessContrast": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Adjust Brightness and Contrast", "description": "This action analyzes a document and automatically adjusts brightness and contrast based on the analysis." }, "RemoveBorder": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Border", "description": "Locates border pixels and removes the pixels from the document,this is disabled by default." }, "SmoothBackground": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Smooth Background", "description": "This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise." }, "SmoothObjects": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Smooth Objects", "description": "This only works on bitonal documents, it looks at groups of pixels, and finds isolated bumps and pits in the edges of those objects, and fills them in." }, "RemoveDotShading": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Dot Shading", "description": "This action will remove shaded regions from bitonal documents." }, "ImageDetergent": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Image Detergent", "description": "Image Detergent works by changing pixels of similar color values to a central color value, which has the result of smoothing the image wherever regions of those colors appear." }, "ApplyAverageFilter": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Average Filter", "description": "Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window." }, "RemoveHolePunch": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Hole Punch", "description": "Detects and removes hole punch marks from a bitonal document." }, "Binarize": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Binarize", "description": "Computes all necessary parameters by analyzing the input data before actually performing the binarization. The algorithm is tuned to typical document images, consisting of dark text on brighter background. It is robust to shadows, noise and background images." }, "RemoveBlankPages": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Blank Pages", "description": "Set whether blank pages should be removed from the PDF document." }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "AutoRotateConfidenceLevel": { "format": "int32", "default": 0, "type": "integer", "x-ms-visibility": "internal", "x-ms-summary": "Rotate Confidence Level", "description": "Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60." } } }, "DtoPdfCheckPassword": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "viewPassword": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "View Password", "description": "Set the password used to view the PDF document" } } }, "DtoPdfCreateZUGFeRDInvoice": { "required": [ "fileContent", "zUGFeRDFileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "zUGFeRDFileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "ZUGFeRD File Content", "description": "The file content of the ZUGFeRD XML document" } } }, "DtoPdfDeleteBlankPages": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Set the page number to start searching for blank pages" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Set the page number to stop searching for blank pages" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers of the pages to check for blank pages: 1,3,4" } } }, "DtoPdfExtractHyperlinks": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "advancedData": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Advanced Data", "description": "Set whether to return additional information such as Text, Hyperlink and Page Number" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Specifies the page number to start extracting hyperlinks from" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Specifies the page number to stop extracting hyperlinks on" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers of the pages to extract hyperlinks from: 1,3,4" } } }, "DtoPdfExtractTableData": { "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "extract": { "default": "First", "enum": [ "First", "Last", "Custom" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Extract", "description": "Specify the table to extract" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Optional - Specifies the page number to start extracting pages from" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Optional - Specifies the page number to stop extracting pages on" }, "tableIndex": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Table Index", "description": "Optional - If 'Extract' is set to 'Custom', specify the index of the table to extract" }, "hasHeaderRow": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Has Header Row", "description": "Set whether the first row is a header row" } } }, "DtoPdfExtractTextByPage": { "required": [ "FileContent" ], "type": "object", "properties": { "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Sets the page number to begin text extraction from, defaults to the document's first page" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Sets the page number to end text layer extraction from, defaults to the document's last page" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers of the pages to extract hyperlinks from: 1,3,4" }, "removeControlCharacters": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Control Characters", "description": "Set whether to automatically remove 'Control Characters' from the extracted text" }, "textEncodingType": { "default": "UTF8", "enum": [ "Default", "Latin1", "BigEndianUnicode", "UTF16", "UTF8", "UTF7", "ASCII" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Encoding Type", "description": "The encoding type used for text extraction" } } }, "DtoPdfFlattenFields": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "fieldNames": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Field Names", "description": "A comma-separated string of the field names of the fields which are to be flattened" }, "pageNumbers": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Numbers", "description": "A comma-separated string of page numbers which contain fields which are to be flattened" } } }, "DtoPdfGenerateBookmarks": { "required": [ "bookmarks", "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "bookmarks": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Bookmarks", "description": "JSON data containing the bookmarks to add to the PDF document" } } }, "DtoPdfInsertPages": { "required": [ "documents", "fileContent", "outputFilename" ], "type": "object", "properties": { "outputFilename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Output Filename", "description": "The filename of the output PDF document" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The 'File Content' of the PDF document to add pages to" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/PdfPagesToInsert" }, "x-ms-visibility": "important", "x-ms-summary": "PDF Documents", "description": "The PDF documents to insert as pages into the PDF Document provided" }, "preserveBookmarks": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Preserve Bookmarks", "description": "Preserve bookmarks contained within each PDF document that had pages inserted" } } }, "DtoPdfInsertToc": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "title": { "default": "Table of Contents", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Title", "description": "The title of the 'Table of Contents'" }, "destinationPage": { "format": "int32", "default": 2, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Destination Page", "description": "The page number to insert the 'Table of Contents' from" }, "jsonEntries": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "JSON Entries", "description": "JSON data containing the hierarchical entries for the 'Table of Contents'" }, "showPageNumbers": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Show Page Numbers", "description": "Set whether page numbers should be visible for each of item of the 'Table of Contents'" }, "titleFont": { "default": "Arial", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Font", "description": "Set the font applied to the 'Title'" }, "titleFontColor": { "default": "Black", "enum": [ "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Font Color", "description": "Set the font color applied to the 'Title'" }, "titleBackgroundColor": { "default": "Transparent", "enum": [ "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Background Color", "description": "Set the background color applied to the 'Title'" }, "titleFontSize": { "format": "int32", "default": 20, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Font Size", "description": "Set the size of the font applied to the 'Title'" }, "titleFontStyle": { "default": "Bold", "enum": [ "Bold", "Italic", "Regular" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Font Style", "description": "Set the font style applied to the 'Title'" }, "titleHorizontalAlignment": { "default": "Center", "enum": [ "None", "Left", "Center", "Right", "Justify", "FullJustify" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Horizontal Alignment", "description": "Set the horizontal alignment applied to the 'Title'" }, "titleUnderline": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Title - Underline", "description": "Set whether an underline is applied to the 'Title'" }, "itemFont": { "default": "Arial", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Font", "description": "Set the font applied to each 'Table of Contents' item" }, "itemFontColor": { "default": "Black", "enum": [ "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Font Color", "description": "Set the font color applied to each 'Table of Contents' item" }, "itemBackgroundColor": { "default": "Transparent", "enum": [ "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Background Color", "description": "Set the background color applied to each 'Table of Contents' item" }, "itemFontSize": { "format": "int32", "default": 10, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Font Size", "description": "Set the size of the font applied to each 'Table of Contents' item" }, "itemFontStyle": { "default": "Regular", "enum": [ "Bold", "Italic", "Regular" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Font Style", "description": "Set the font style applied to each 'Table of Contents' item" }, "itemTopPadding": { "format": "int32", "default": 10, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Padding", "description": "Set the padding applied to the top of each item within the 'Table of Contents'" }, "itemLevelPadding": { "format": "int32", "default": 10, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Item - Level Padding", "description": "Set the left padding iteratively applied to each level of the 'Table of Contents' hierarchy. For example, a value of '5'; Level 1: 5, Level 2: 10, Level 3: 15, etc." }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request" } } }, "DtoPdfLinearize": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" } } }, "DtoPdfRemoveDigitalSignature": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" } } }, "DtoPdfReplaceTextWithImage": { "required": [ "FileContent", "imageFileContent", "SearchText" ], "type": "object", "properties": { "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "SearchText": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Search Text", "description": "The text to locate and replace with the specified image" }, "imageFileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Image File Content", "description": "The content of the image file" }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Skip First Page", "description": "Set whether to ignore the first page when searching for the text fragment" }, "applyTo": { "default": "All", "enum": [ "First", "All", "Last", "Specific" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Apply To", "description": "Set which pages within the document to search for the text fragment" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "Specify the page numbers to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'." }, "pageNumbersIgnore": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Ignore Page Numbers", "description": "Specify the page numbers not to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'." }, "alignImage": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Align Image", "description": "Assure that the image provided is aligned to the EXIF orientation tags" } } }, "DtoPdfSearchAndReplaceText": { "required": [ "phrases" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "phrases": { "type": "array", "items": { "$ref": "#/definitions/PdfSearchAndReplaceTextPhrase" }, "x-ms-visibility": "important", "x-ms-summary": "Phrases", "description": "The collection of text phrases to locate and replace" } } }, "DtoPdfSetMetadata": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "author": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Author", "description": "The author of the document" }, "creationDate": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Creation Date", "description": "The date the document was created" }, "keywords": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Keywords", "description": "The keywords associated with the document" }, "modificationDate": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Modification Date", "description": "The date the document was modified" }, "subject": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Subject", "description": "The subject of the document" }, "title": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Title", "description": "The title of the document" }, "xmpMetadata": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "XMP Metadata", "description": "A JSON collection of keypair values to set existing XMP metadata entries on the document provided" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request" } } }, "DtoPdfSignPdf": { "required": [ "certificateType", "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "certificateType": { "enum": [ "Standard", "Custom" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Certificate Type", "description": "Select either the standard signing certificate or provide a custom certificate as a PFX file" }, "showSignatureStamp": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Show Signature", "description": "Set whether the signature stamp should be visible" }, "signatureApplyTo": { "default": "FirstPage", "enum": [ "FirstPage", "LastPage", "Specific" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Apply To", "description": "Set where to apply the signature stamp" }, "signatureSpecificPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Specific Page", "description": "Set a specific page to apply the signature stamp to, only effective when the 'Apply To' value is set to 'Specific'" }, "signatureSignedBy": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Signed By", "description": "Set the signature 'Signed By' property" }, "signatureLocation": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Location", "description": "Set the signature 'Location' property" }, "signatureContact": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Contact", "description": "Set the signature 'Contact' property" }, "signatureReason": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Reason", "description": "Set the signature 'Reason' property" }, "signatureFileContent": { "format": "byte", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Signature File Content", "description": "Optional - The image file to override the default signature image" }, "rectangleWidth": { "format": "int32", "default": 0, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Max Stamp Width", "description": "The maximum width of the signature stamp" }, "rectangleHeight": { "format": "int32", "default": 0, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Max Stamp Height", "description": "The maximum height of the signature stamp" }, "stampBackgroundColour": { "default": "Transparent", "enum": [ "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp Background Colour", "description": "The background colour to be used for the signature stamp" }, "stampForegroundColour": { "default": "Black", "enum": [ "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp Foreground Colour", "description": "The foreground colour to be used for the signature stamp" }, "stampFontSize": { "format": "double", "default": 10, "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp Font Size", "description": "The size of the font to be used for the signature stamp" }, "rectangleStartXSn": { "format": "int32", "default": 5, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp X-Coordinate", "description": "The x-coordinate of the of the signature, 0 is the left of the page" }, "rectangleStartYSn": { "format": "int32", "default": 5, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp Y-Coordinate", "description": "The y-coordinate of the of the signature, 0 is the top of the page" }, "certificateFileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Certificate File Content", "description": "The file content of the PFX file" }, "certificatePassword": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Certificate Password", "description": "The password for the PFX file provided" }, "rectangleStartXAp": { "format": "int32", "default": 5, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp X-Coordinate", "description": "The x-coordinate of the of the signature, 0 is the left of the page" }, "rectangleStartYAp": { "format": "int32", "default": 5, "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Stamp Y-Coordinate", "description": "The y-coordinate of the of the signature, 0 is the bottom of the page" } }, "x-ms-dynamic-schema": { "operationId": "PDF_GetDynamicSchemaSignPdf", "value-path": "dynamicSchemaSignPdf", "parameters": { "certificateType": { "parameter": "certificateTypeParameter" } } } }, "DtoPdfUpdateHyperlinks": { "required": [ "fileContent", "hyperlinks" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "hyperlinks": { "type": "array", "items": { "$ref": "#/definitions/PdfHyperlink" }, "x-ms-visibility": "important", "x-ms-summary": "Hyperlinks", "description": "The collection of hyperlinks to locate and update" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request" } } }, "DtoRedactPdf": { "required": [ "FileName", "Redactions" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "Redactions": { "type": "array", "items": { "$ref": "#/definitions/Redaction" }, "x-ms-visibility": "important", "x-ms-summary": "Redactions", "description": "The collection of redactions to apply to this PDF document" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoRemoveWatermarksFromPdf": { "required": [ "fileContent", "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "watermarkIds": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Watermark IDs", "description": "Identifiers of the watermark(s) to remove. Multiple identifiers should be provided comma separated" }, "removeWatermarkType": { "default": "All", "enum": [ "All", "Text", "Image" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Watermark Type", "description": "Set the type of watermark to remove from the PDF document provided" } } }, "DtoRepairPdf": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" } } }, "DtoResizePdf": { "required": [ "FileContent", "pageSize" ], "type": "object", "properties": { "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "pageSize": { "enum": [ "Default", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "B5", "P11x17", "Ledger", "Legal", "Letter", "Custom" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Page Size", "description": "Set the new page size to be applied to the PDF file provided" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Set the page number to begin resizing from" }, "EndPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Set the page number to end resizing on" }, "customWidth": { "format": "float", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Width", "description": "Set a custom width, only applied when the 'Custom' page size has been set" }, "customHeight": { "format": "float", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Height", "description": "Set a custom height, only applied when the 'Custom' page size has been set" }, "paddingBottom": { "format": "double", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Padding Bottom", "description": "Set bottom padding of the PDF document by percentage (default is 0%)" }, "paddingTop": { "format": "double", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Padding Top", "description": "Set top padding of the PDF document by percentage (default is 0%)" }, "paddingLeft": { "format": "double", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Padding Left", "description": "Set left padding of the PDF document by percentage (default is 0%)" }, "paddingRight": { "format": "double", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Padding Right", "description": "Set right padding of the PDF document by percentage (default is 0%)" } } }, "DtoResponseAIOcrPdfDocument": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddAttachmentsToPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddHtmlHeaderFooter": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddImageWatermark": { "type": "object", "properties": { "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "The identifier applied to the watermark" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddImageWatermarkAdv": { "type": "object", "properties": { "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "The identifier applied to the watermark" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddPageNumbers": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddTextWatermark": { "type": "object", "properties": { "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "The identifier applied to the watermark" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseAddTextWatermarkAdv": { "type": "object", "properties": { "watermarkId": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Watermark ID", "description": "The identifier applied to the watermark" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseCompressPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseDeletePdfPages": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseExtractAttachmentsFromPdf": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents extracted from the source PDF" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseExtractImage": { "required": [ "Images" ], "type": "object", "properties": { "Images": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Images", "description": "The array of images extracted from the PDF" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseExtractImagesAll": { "required": [ "Images" ], "type": "object", "properties": { "Images": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Images", "description": "The array of images extracted from the PDF" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseExtractPdfPages": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseExtractPdfPagesByText": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseExtractTextRegion": { "required": [ "TextRegionResults", "TextRegionResultsSimple" ], "type": "object", "properties": { "TextRegionResultsSimple": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Simple Text Region Results", "description": "A collection of text region results in simplified format" }, "TextRegionResults": { "type": "array", "items": { "$ref": "#/definitions/TextRegionResult" }, "x-ms-visibility": "important", "x-ms-summary": "Text Region Results", "description": "A collection of text region results." }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseFillPdfForm": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseFlattenPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseGetPdfDocumentInfo": { "type": "object", "properties": { "NumberOfPages": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Number of Pages", "description": "The number of pages in the supplied PDF document" }, "FileSize": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Size (MBs)", "description": "The size of the supplied PDF document in MBs" }, "Author": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Author", "description": "The author of the PDF as set in the PDF properties" }, "Creator": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Creator", "description": "The creator of the PDF as set in the PDF properties" }, "Producer": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Producer", "description": "The producer of the PDF as set in the PDF properties" }, "Title": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Title", "description": "The title of the PDF as set in the PDF properties" }, "Subject": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Subject", "description": "The subject of the PDF as set in the PDF properties" }, "Keywords": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Keywords", "description": "The keywords of the PDF as set in the PDF properties" }, "customProperties": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Custom Properties", "description": "All custom properties present within the PDF as a JSON array of key / value pairs" }, "Orientation": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Orientation", "description": "The orientation of the PDF Document" }, "Width": { "format": "double", "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Width", "description": "The width of the PDF Document (Points)" }, "Height": { "format": "double", "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Height", "description": "The height of the PDF Document (Points)" }, "CreatedDate": { "format": "date-time", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Created Date", "description": "The creation date of the PDF as set in the PDF properties" }, "ModifiedDate": { "format": "date-time", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Modified Date", "description": "The last modified date of the PDF as set in the PDF properties" }, "PDFFormat": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "PDF Format", "description": "The format of the PDF" }, "IsPDFACompliant": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is PDFA Compliant", "description": "Indicates whether the supplied PDF complies with the PDF/a standard" }, "IsPDFUACompliant": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is PDFUA Compliant", "description": "Indicates whether the supplied PDF complies with the PDF/ua standard" }, "IsEncrypted": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is Encrypted", "description": "Indicates whether the supplied PDF complies is encrypted" }, "HasTextLayer": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Has Text Layer", "description": "Indicates whether the supplied PDF has a text layer" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseGetPdfFormData": { "type": "object", "properties": { "Form Data": { "type": "string" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseGetPdfTextLayer": { "type": "object", "properties": { "TextLayer": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text Layer", "description": "The text layer extracted from the PDF document." }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseInsertHtmlToPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseMergeArrayOfDocumentsToPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseMergeDocumentsToPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseMultipleFiles": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "An array of files" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseOcrPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfCheckPassword": { "type": "object", "properties": { "viewPassword": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "View Password", "description": "Confirms whether the PDF document provided has a 'View Password'" }, "editPassword": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Edit Password", "description": "Confirms whether the PDF document provided has a 'Edit Password'" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponsePdfCreateZUGFeRDInvoice": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfDeleteBlankPages": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfExtractHyperlinks": { "type": "object", "properties": { "result": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Result", "description": "The response value for the request" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponsePdfExtractTableData": { "type": "object", "properties": { "result": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Result", "description": "The response value for the request" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponsePdfExtractTextByPage": { "type": "object", "properties": { "pages": { "type": "array", "items": { "$ref": "#/definitions/PdfExtractTextPage" }, "x-ms-visibility": "important", "x-ms-summary": "Pages", "description": "The collection of text values extracted from the PDF document provided" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponsePdfFlattenFields": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfGenerateBookmarks": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfInsertPages": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfInsertToc": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfLinearize": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfRemoveDigitalSignature": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfReplaceTextWithImage": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfSearchAndReplaceText": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfSetMetadata": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePdfUpdateHyperlinks": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseRedactPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseRemoveWatermarksFromPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseRepairPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseResizePdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseRotatePdfPages": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseSecurePdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseSignPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseSplitDocument": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents to be processed" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseSplitPdfByBarcode": { "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArrayPdfSplitByBarcode" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents split from the source PDF" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseSplitPdfByText": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents split from the source PDF" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseString": { "type": "object", "properties": { "result": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Result", "description": "The response value for the request" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseUnlockPdf": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseValidatePdfTextLayer": { "type": "object", "properties": { "valid": { "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Valid Text Layer", "description": "The result of the text layer validation" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoRotatePdfPages": { "required": [ "fileContent", "pdfPageRotation" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "pdfPageRotation": { "default": "Degrees90", "enum": [ "Degrees90", "Degrees180", "Degrees270", "Degrees360" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Rotation", "description": "Set the angle of the page rotation: 90, 180, 270, 360" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Start Page", "description": "Set the page number to begin rotating pages from" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "End Page", "description": "Set the page number to stop rotating pages on. The default value is set to the last page of the PDF document provided" }, "pageNumbers": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "A comma separated list of page numbers of the pages to rotate: 1,3,4" }, "pdfRotatePagesOrientation": { "default": "All", "enum": [ "All", "Portrait", "Landscape" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Rotate Pages", "description": "Set which pages should be rotated" } } }, "DtoSecurePdf": { "required": [ "FileName", "FinalOperation" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "userPassword": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "View Password", "description": "Protect view access to the document" }, "adminPassword": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Edit Password", "description": "Protect edit access to the document" }, "pdfPrivileges": { "default": "DenyAll", "enum": [ "AllowAll", "DenyAll", "Specific" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Privileges", "description": "Set the privileges assigned to the PDF document" }, "cryptoAlgorithm": { "default": "AESx256", "enum": [ "RC4x40", "RC4x128", "AESx128", "AESx256", "Custom" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Cryptographic Algorithm", "description": "Set the cryptographic algorithm" }, "pdfPrivilegesAllowAssembly": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Assembly", "description": "Set whether document assembly is permitted" }, "pdfPrivilegesAllowCopy": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Copy", "description": "Set whether copy is permitted" }, "pdfPrivilegesAllowFillIn": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Fill in Forms", "description": "Set whether 'Fill in forms' is permitted" }, "pdfPrivilegesAllowPrint": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Print", "description": "Set whether print is permitted" }, "pdfPrivilegesAllowScreenReaders": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Screen Readers", "description": "Set whether screen reading is permitted" }, "pdfPrivilegesAllowModifyContents": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Modify Contents", "description": "Set whether document content modification is permitted" }, "pdfPrivilegesAllowModifyAnnotations": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Privilege - Modify Annotations", "description": "Set whether annotation modification is permitted" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "internal", "x-ms-summary": "Final Operation", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoSetPdfPrivileges": { "required": [ "FileName" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "pdfPrivileges": { "default": "DenyAll", "enum": [ "AllowAll", "DenyAll", "Specific" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Privileges", "description": "Set the privileges assigned to the PDF document" }, "pdfPrivilegesAllowAssembly": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Assembly", "description": "" }, "pdfPrivilegesAllowCopy": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Copy", "description": "" }, "pdfPrivilegesAllowFillIn": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Fill in Forms", "description": "" }, "pdfPrivilegesAllowPrint": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Print", "description": "" }, "pdfPrivilegesAllowScreenReaders": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Screen Readers", "description": "" }, "pdfPrivilegesAllowModifyContents": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Modify Contents", "description": "" }, "pdfPrivilegesAllowModifyAnnotations": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Modify Annotations", "description": "" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoSplitDocument": { "required": [ "fileName", "splitByType", "splitConfiguration" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the PDF file" }, "splitByType": { "enum": [ "NumberOfPages", "PageArray", "BookmarkLevel" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split by Type", "description": "Select how to split the file" }, "splitConfiguration": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Configuration", "description": "Provide a split configuration" }, "enableBookmarkFilenames": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Enable Bookmark Filenames", "description": "Append the bookmark name value to the filename when splitting by 'BookmarkLevel'" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoSplitPdfByBarcode": { "required": [ "fileName", "splitPdfByBarcodeAction", "splitPdfByBarcodeType" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the PDF file" }, "splitPdfByBarcodeValue": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Barcode Value", "description": "Optional - Specify a value for detecting a specific barcode(s)" }, "splitPdfByBarcodeType": { "default": "AllInstances", "enum": [ "AllInstances", "FirstInstant", "LastInstant" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Configuration", "description": "Select a split configuration" }, "splitPdfByBarcodeAction": { "default": "SplitOn", "enum": [ "SplitOn", "SplitAfter", "SplitBefore", "Remove" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Action", "description": "Select a split action, whether to split before, after or remove the page containing the split value." }, "barcodeReadConfidence": { "default": "Medium", "enum": [ "Low", "Medium", "High" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Confidence", "description": "Set the confidence level for barcode detection" }, "appendBarcodeValue": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Append Barcode Value", "description": "Optional - Specify whether the value for each barcode found is appended to the start of the filename" } } }, "DtoSplitPdfByText": { "required": [ "fileName", "splitAction", "splitPdfByTextType", "splitValue" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the PDF file" }, "splitValue": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Value", "description": "Provide the split value used to perform the split operation" }, "isExpression": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is Expression", "description": "Set whether the 'Split Value' value should be evaluted as a regular expression, the default value is 'false'" }, "prefixFilename": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Prefix Filename", "description": "Set whether the expression value should be used within the output filename." }, "splitPdfByTextType": { "default": "AllInstances", "enum": [ "AllInstances", "FirstInstant", "LastInstant" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Configuration", "description": "Select a split configuration" }, "splitAction": { "default": "SplitOn", "enum": [ "SplitOn", "SplitAfter", "SplitBefore", "Remove" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Action", "description": "Select a split action, whether to split before, after or remove the page containing the split value." } } }, "DtoUnlockPdf": { "required": [ "FileName", "FinalOperation", "password" ], "type": "object", "properties": { "FileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "password": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Password", "description": "The password to use to unlock the PDF Document" }, "operationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" }, "FinalOperation": { "default": true, "type": "boolean", "x-ms-visibility": "internal", "x-ms-summary": "Return File", "description": "Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID" } } }, "DtoValidatePdfTextLayer": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source PDF file" }, "level": { "default": "Document", "enum": [ "Document", "Page" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Level", "description": "Set whether each page should be checked for the presence of a text layer or the document as a single entity" } } }, "ImageRegion": { "required": [ "ExtractEntirePage", "ImageType", "LowerLeftXCoordinate", "LowerLeftYCoordinate", "PageNumber", "Resolution", "UpperRightXCoordinate", "UpperRightYCoordinate" ], "type": "object", "properties": { "Name": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Name", "description": "The name assigned to the extracted image" }, "LowerLeftXCoordinate": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Lower Left X Coordinate", "description": "The number of points from the left edge of the page to the lower left corner of the rectangle image region" }, "LowerLeftYCoordinate": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Lower Left Y Coordinate", "description": "The number of points from the bottom edge of the page to the lower left corner of the rectangle image region" }, "UpperRightXCoordinate": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Upper Right X Coordinate", "description": "The number of points from the left edge of the page to the upper right corner of the rectangle image region" }, "UpperRightYCoordinate": { "format": "double", "default": 0, "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Upper Right Y Coordinate", "description": "The number of points from the bottom edge of the page to the upper right corner of the rectangle image region" }, "PageNumber": { "format": "int32", "default": 1, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Page Number", "description": "The number of the page to extract the image from" }, "ImageType": { "default": "PNG", "enum": [ "JPG", "PNG", "TIFF", "BMP" ], "type": "string" }, "ExtractEntirePage": { "default": true, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Extract Entire Page", "description": "Extract the specified page as an image, ignoring and specificed coodinates" }, "Resolution": { "format": "int32", "default": 300, "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Resolution", "description": "The resolution of the extracted image" } } }, "PdfExtractTextPage": { "type": "object", "properties": { "Number": { "format": "int32", "type": "integer" }, "Text": { "type": "string" } } }, "PdfHyperlink": { "required": [ "searchOn", "searchValue" ], "type": "object", "properties": { "searchOn": { "default": "Text", "enum": [ "Text", "URL" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Search On", "description": "Set whether the search should be performed on the hyperlink text or URL value" }, "searchValue": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Search Value", "description": "The hyperlink text or URL value to locate" }, "isExpression": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is Expression", "description": "Set whether the 'Search Value' value should be evaluated as a regular expression, the default value is 'false'" }, "hyperlinkLabelValueCurrent": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text Current Value", "description": "The text value to replace, leave blank to replace the entire value" }, "hyperlinkLabelValueNew": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text New Value", "description": "The new label value to set" }, "hyperlinkUrlValueCurrent": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "URL Current Value", "description": "The URL value to replace, leave blank to replace the entire value" }, "hyperlinkUrlValueNew": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "URL New Value", "description": "The new URL value to set" } } }, "PdfPagesToInsert": { "required": [ "fileContent", "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the PDF Document to insert" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The 'File Content' of the PDF Document to insert" }, "targetPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Target Page", "description": "The target page to insert the PDF Document as pages to" }, "startPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Start Page", "description": "Set the page number to start identifying pages from for insertion into the provided PDF Document, defaults to the first page" }, "endPage": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "End Page", "description": "Set the page number to end identifying pages from for insertion into the provided PDF Document, defaults to the last page" } } }, "PdfSearchAndReplaceTextPhrase": { "required": [ "searchText" ], "type": "object", "properties": { "searchText": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Search Text", "description": "The text to locate and replace with the 'Replacement Text' value" }, "isExpression": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is Expression", "description": "Set whether the 'Search Text' value should be evaluated as a regular expression, the default value is 'false'" }, "replacementText": { "default": "", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Replacement Text", "description": "The value to replace the 'Search Text' value with" }, "hideText": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Hide Text", "description": "Hide the 'Replacement Text' value, it will still be present within the PDF text layer but not visible" }, "font": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font", "description": "Specify the name of the font, by default the existing font will be inherited" }, "fontSize": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Size", "description": "Set the size of the font, by default the existing font size will be inherited" }, "fontColour": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Colour", "description": "Set the HTML colour of the font, by default the existing font colour will be inherited" }, "fontBackgroundColour": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Background Colour", "description": "Set a HTML colour to override the background colour of the font, the default colour is inherited from the document" }, "fontStyle": { "default": "Inherit", "enum": [ "Inherit", "Regular", "Bold", "Italic" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Style", "description": "Set the font style for the 'Replacement Text', the default value is 'Inherit'" }, "styleCharacterSpacing": { "format": "float", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Character Spacing", "description": "Set the spacing between characters within the 'Replacement Text'" }, "styleStrikeOut": { "default": "Inherit", "enum": [ "Inherit", "Apply", "Remove" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Strike Out", "description": "Apply a strikeout to the 'Replacement Text'" }, "styleUnderline": { "default": "Inherit", "enum": [ "Inherit", "Apply", "Remove" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Underline", "description": "Apply an underline to the 'Replacement Text'" } } }, "Redaction": { "type": "object", "properties": { "SearchText": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text", "description": "The text to search for and apply the specified redaction to." }, "SearchExpression": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Expression", "description": "Specify a regular expression to seek matching text and apply the specified redaction to." }, "RedactionColour": { "default": "#000000", "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Redaction Colour", "description": "The redaction colour to apply to the redaction, the default value is #000000 (Black)" }, "skipFirstPage": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Skip First Page", "description": "Set whether to ignore the first page ." }, "applyTo": { "default": "AllPages", "enum": [ "FirstPage", "AllPages", "LastPage", "Specific" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Apply To", "description": "Set which pages within the document to redact" }, "pageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "advanced", "x-ms-summary": "Page Numbers", "description": "Specify the page numbers to apply redaction to, this property only applies when the 'Apply To' property is set to 'Specific'." }, "ignorePageNumbers": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "advanced", "x-ms-summary": "Ignore Page Numbers", "description": "Specify the page numbers not to apply redaction to, this property only applies when the 'Apply To' property is set to 'Specific'." } } }, "TextRegion": { "required": [ "LowerLeftXCoordinate", "LowerLeftYCoordinate", "Name", "Page Number", "UpperRightXCoordinate", "UpperRightYCoordinate" ], "type": "object", "properties": { "Name": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Name", "description": "The name assigned to the text region" }, "LowerLeftXCoordinate": { "format": "double", "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Lower Left X Coordinate", "description": "The number of points from the left edge of the page to the lower left corner of the rectangle text region" }, "LowerLeftYCoordinate": { "format": "double", "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Lower Left Y Coordinate", "description": "The number of points from the bottom edge of the page to the lower left corner of the rectangle text region" }, "UpperRightXCoordinate": { "format": "double", "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Upper Right X Coordinate", "description": "The number of points from the left edge of the page to the upper right corner of the rectangle text region" }, "UpperRightYCoordinate": { "format": "double", "type": "number", "x-ms-visibility": "important", "x-ms-summary": "Upper Right Y Coordinate", "description": "The number of points from the bottom edge of the page to the upper right corner of the rectangle text region" }, "Page Number": { "format": "int32", "type": "integer" } } }, "TextRegionResult": { "type": "object", "properties": { "Name": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Name", "description": "The name assigned to the text region" }, "Text": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Text", "description": "The text extracted via OCR from the specified region" }, "PageNumber": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Page Number", "description": "The number of the page the text was extracted from" } } } }, "securityDefinitions": { "Bearer": { "type": "apiKey", "name": "X-ApiKey", "in": "header", "description": "API Key Authentication Header" } }, "security": [ { "defaultAuth": [ ] } ] }