Connectors Reference

Encodian

Enhanced document format conversion, OCR, watermarking, data extraction, redaction + much more.

 

Status: Production

Tier: Standard

Version: v1.0

 

Actions:

Name

Summary

BasicConversion ([Optional]DtoBasicConversion conversion)

Convert to PDF

ConvertToPdfA ([Optional]DtoConvertToPdfA operation)

Convert PDF to PDFA

SecurePdfDocument ([Optional]DtoSecurePdf operation)

Secure PDF Document

SetPdfPrivileges ([Optional]DtoSetPdfPrivileges operation)

Set PDF Document Privileges

TextToPDF ([Optional]DtoTextToPdf operation)

Convert Text to PDF

HtmlToPDF ([Optional]DtoHtmlToPdf operation)

Convert HTML to PDF

HtmlToWord ([Optional]DtoHtmlToWord operation)

Convert HTML to Word

InsertHtmlToPdf ([Optional]DtoInsertHtmlToPdf operation)

Insert HTML to PDF

MergeDocumentsToPdf ([Optional]DtoMergeDocumentsToPdf operation)

Merge documents to PDF

MergeArrayOfDocumentsToPdf ([Optional]DtoMergeArrayOfDocumentsToPdf operation)

Merge document array to PDF

MergeArrayOfDocumentsToWord ([Optional]DtoMergeArrayOfDocumentsToWord operation)

Merge Word Documents

OcrPdfDocument ([Optional]DtoOcrPdf operation)

OCR a PDF Document

SplitDocument ([Optional]DtoSplitDocument operation)

Split PDF

SplitPdfByText ([Optional]DtoSplitPdfByText operation)

Split PDF by Text

SplitPdfByBarcode ([Optional]DtoSplitPdfByBarcode operation)

Split PDF by Barcode

WordToPdfForm ([Optional]DtoWordToPdfForm operation)

Convert Word to PDF Form

AddTextWatermark ([Optional]DtoAddTextWatermark operation)

Add Text Watermark

AddImageWatermark ([Optional]DtoAddImageWatermark operation)

Add Image Watermark

AddTextWatermarkAdvanced ([Optional]DtoAddTextWatermarkAdv operation)

Add Text Watermark (Advanced)

AddImageWatermarkAdvanced ([Optional]DtoAddImageWatermarkAdv operation)

Add Image Watermark (Advanced)

ImageCleanUpDocument ([Optional]DtoImageCleanUpDoc operation)

Image Clean Up (Document)

ImageCleanUpPhoto ([Optional]DtoImageCleanUpPhoto operation)

Image Clean Up (Photo)

ExtractTextRegions ([Optional]DtoExtractTextRegion operation)

Extract Text from Regions

AddHtmlHeaderFooter ([Optional]DtoAddHtmlHeaderFooter operation)

Add HTML Header or Footer

AddPageNumbers ([Optional]DtoAddPageNumbers operation)

Add Page Numbers

GetPdfTextLayer ([Optional]DtoGetPdfTextLayer operation)

Get PDF Text Layer

RedactPdf ([Optional]DtoRedactPdf operation)

Redact PDF

ResizeImage ([Optional]DtoImageResize operation)

Resize an Image

GetPdfFormData ([Optional]DtoGetPdfFormData operation)

Get PDF Form Data

SearchAndReplaceText ([Optional]DtoSearchAndReplaceText operation)

Search and Replace Text

SearchAndReplaceTextWithImage ([Optional]DtoSearchAndReplaceTextWithImage operation)

Replace Text with Image

ConvertPdfToWord ([Optional]DtoConvertPdfToWord operation)

Convert PDF to Word

CompressImage ([Optional]DtoImageCompress operation)

Compress an Image

AddToZip ([Optional]DtoZipArrayOfDocuments operation)

Add to Archive (ZIP)

GetPdfDocumentInfo ([Optional]DtoGetPdfDocumentInfo operation)

Get PDF Document Information

UnlockPdfDocument ([Optional]DtoUnlockPdf operation)

Unlock PDF Document

ParseCsv ([Optional]DtoParseCsv operation)

Parse CSV

CreateQrCode ([Optional]DtoCreateQrCode operation)

Create QR Code

ReadQrCodeFromImage ([Optional]DtoReadQrCodeFromImage operation)

Read QR Code - Image

ReadQrCodeFromDocument ([Optional]DtoReadQrCodeFromDocument operation)

Read QR Code - Document

CreateBarcode ([Optional]DtoCreateBarcode operation, [Optional]string barcodeTypeParameter)

Create Barcode

ReadBarcodeFromImage ([Optional]DtoReadBarcodeFromImage operation)

Read Barcode - Image

ReadBarcodeFromDocument ([Optional]DtoReadBarcodeFromDocument operation)

Read Barcode - Document

ImageConvertFormat ([Optional]DtoImageConvertFormat operation)

Convert Image Format

RegexSearchText ([Optional]DtoRegexSearchText operation)

Search Text - Regex

ExtractImages ([Optional]DtoExtractImage operation)

Extract Images from PDF

ImageExtractText ([Optional]DtoImageExtractText operation)

Extract Text from Image (OCR)

FillPdfForm ([Optional]DtoFillPdfForm operation)

Fill a PDF Form

ConvertMailMessage ([Optional]DtoConvertMailMessage conversion)

Convert Email Message

ConvertExcel ([Optional]DtoConvertExcel conversion, [Optional]string outputFormatParameter)

Convert Excel

ConvertWord ([Optional]DtoConvertWord conversion, [Optional]string outputFormatParameter)

Convert Word

ConvertPowerPoint ([Optional]DtoConvertPowerPoint conversion, [Optional]string outputFormatParameter)

Convert PowerPoint

CreateHMAC ([Optional]DtoCreateHMAC operation)

Create HMAC

CreateHashCode ([Optional]DtoCreateHashCode operation)

Create Hash Code

AddTextWatermarkToImage ([Optional]DtoAddTextWatermarkToImage operation)

Add Text Watermark to Image

GetDynamicSchemaCreateBarcode ([Optional]string barcodeType)

Get Create Barcode Schema

GetDynamicSchemaConvertWord ([Optional]string outputFormat)

Get Convert Word Schema

GetDynamicSchemaConvertExcel ([Optional]string outputFormat)

Get Convert Excel Schema

GetDynamicSchemaConvertPowerPoint ([Optional]string outputFormat)

Get Convert PowerPoint Schema

GetSubscriptionStatus ()

Get Subscription Status

GetOperationStatus ([Optional]string operationId)

Get an Operation Status

GetOperationStatusExtractTextRegion ([Optional]string operationId)

Get an Operation Status for ExtractTextRegion

GetOperationStatusGetPdfTextLayer ([Optional]string operationId)

Get an Operation Status for GetPdfTextLayer

GetOperationStatusGetPdfFormData ([Optional]string operationId)

Get an Operation Status for GetPdfFormData

GetOperationStatusSplitDocument ([Optional]string operationId)

Get an Operation Status for SplitDocument

GetOperationStatusGetPdfDocumentInfo ([Optional]string operationId)

Get an Operation Status for GetPdfDocumentInfo

GetOperationStatusParseCsv ([Optional]string operationId)

Get an Operation Status for ParseCsv

GetOperationStatusReadQrCodeFromImage ([Optional]string operationId)

Get an Operation Status for ReadQrCodeFromImage

GetOperationStatusReadQrCodeFromDocument ([Optional]string operationId)

Get an Operation Status for ReadQrCodeFromDocument

GetOperationStatusReadBarcodeFromImage ([Optional]string operationId)

Get an Operation Status for ReadBarcodeFromImage

GetOperationStatusReadBarcodeFromDocument ([Optional]string operationId)

Get an Operation Status for ReadBarcodeFromDocument

GetOperationStatusRegexSearchText ([Optional]string operationId)

Get an Operation Status for RegexSearchText

GetOperationStatusExtractImage ([Optional]string operationId)

Get an Operation Status for ExtractImage

GetOperationStatusImageExtractText ([Optional]string operationId)

Get an Operation Status for ImageExtractText

GetOperationStatusCreateHMAC ([Optional]string operationId)

Get an Operation Status for CreateHMAC

GetOperationStatusCreateHashCode ([Optional]string operationId)

Get an Operation Status for CreateHashCode

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

DocumentArray

 

DocumentArrayWord

 

DtoAddHtmlHeaderFooter

 

DtoAddImageWatermark

 

DtoAddImageWatermarkAdv

 

DtoAddPageNumbers

 

DtoAddTextWatermark

 

DtoAddTextWatermarkAdv

 

DtoAddTextWatermarkToImage

 

DtoBaseMgmtResponse

 

DtoBasicConversion

 

DtoConvertExcel

 

DtoConvertMailMessage

 

DtoConvertPdfToWord

 

DtoConvertPowerPoint

 

DtoConvertToPdfA

 

DtoConvertWord

 

DtoCreateBarcode

 

DtoCreateHashCode

 

DtoCreateHMAC

 

DtoCreateQrCode

 

DtoExtractImage

 

DtoExtractTextRegion

 

DtoFillPdfForm

 

DtoGetPdfDocumentInfo

 

DtoGetPdfFormData

 

DtoGetPdfTextLayer

 

DtoHtmlToPdf

 

DtoHtmlToWord

 

DtoImageCleanUpDoc

 

DtoImageCleanUpPhoto

 

DtoImageCompress

 

DtoImageConvertFormat

 

DtoImageExtractText

 

DtoImageResize

 

DtoInsertHtmlToPdf

 

DtoMergeArrayOfDocumentsToPdf

 

DtoMergeArrayOfDocumentsToWord

 

DtoMergeDocumentsToPdf

 

DtoOcrPdf

 

DtoParseCsv

 

DtoReadBarcodeFromDocument

 

DtoReadBarcodeFromImage

 

DtoReadQrCodeFromDocument

 

DtoReadQrCodeFromImage

 

DtoRedactPdf

 

DtoRegexSearchText

 

DtoResponseAddHtmlHeaderFooter

 

DtoResponseAddImageWatermark

 

DtoResponseAddImageWatermarkAdv

 

DtoResponseAddPageNumbers

 

DtoResponseAddTextWatermark

 

DtoResponseAddTextWatermarkAdv

 

DtoResponseAddTextWatermarkToImage

 

DtoResponseBasicConversion

 

DtoResponseConvertExcel

 

DtoResponseConvertMailMessage

 

DtoResponseConvertPdfToWord

 

DtoResponseConvertPowerPoint

 

DtoResponseConvertToPdfA

 

DtoResponseConvertWord

 

DtoResponseCreateBarcode

 

DtoResponseCreateHashCode

 

DtoResponseCreateHMAC

 

DtoResponseCreateQrCode

 

DtoResponseExtractImage

 

DtoResponseExtractTextRegion

 

DtoResponseFillPdfForm

 

DtoResponseGetPdfDocumentInfo

 

DtoResponseGetPdfFormData

 

DtoResponseGetPdfTextLayer

 

DtoResponseHtmlToPdf

 

DtoResponseHtmlToWord

 

DtoResponseImageCleanUpDoc

 

DtoResponseImageCleanUpPhoto

 

DtoResponseImageCompress

 

DtoResponseImageConvertFormat

 

DtoResponseImageExtractText

 

DtoResponseImageResize

 

DtoResponseInsertHtmlToPdf

 

DtoResponseMergeArrayOfDocumentsToPdf

 

DtoResponseMergeArrayOfDocumentsToWord

 

DtoResponseMergeDocumentsToPdf

 

DtoResponseMgmtGetSubscriptionStatus

 

DtoResponseOcrPdf

 

DtoResponseParseCsv

 

DtoResponseReadBarcodeFromDocument

 

DtoResponseReadBarcodeFromImage

 

DtoResponseReadQrCodeFromDocument

 

DtoResponseReadQrCodeFromImage

 

DtoResponseRedactPdf

 

DtoResponseRegexSearchText

 

DtoResponseSearchAndReplaceText

 

DtoResponseSearchAndReplaceTextWithImage

 

DtoResponseSecurePdf

 

DtoResponseSplitDocument

 

DtoResponseSplitPdfByBarcode

 

DtoResponseSplitPdfByText

 

DtoResponseTextToPdf

 

DtoResponseUnlockPdf

 

DtoResponseWordToPdfForm

 

DtoResponseZipArrayOfDocuments

 

DtoSearchAndReplaceText

 

DtoSearchAndReplaceTextWithImage

 

DtoSecurePdf

 

DtoSetPdfPrivileges

 

DtoSplitDocument

 

DtoSplitPdfByBarcode

 

DtoSplitPdfByText

 

DtoTextToPdf

 

DtoUnlockPdf

 

DtoWordToPdfForm

 

DtoZipArrayOfDocuments

 

GetDynamicSchemaConvertExcelResponse

 

GetDynamicSchemaConvertPowerPointResponse

 

GetDynamicSchemaConvertWordResponse

 

GetDynamicSchemaCreateBarcodeResponse

 

ImageRegion

 

Phrase

 

Redaction

 

TextRegion

 

TextRegionResult

 

 

Actions:

BasicConversion

Summary: Convert to PDF

Description: Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574-Convert-to-PDF

 

Syntax:

Encodian.BasicConversion ([Optional]DtoBasicConversion conversion)

 

Parameters:

Name

Type

Summary

Required

Related Action

conversion

DtoBasicConversion

 

 

False

 

Returns:

          Type:DtoResponseBasicConversion

 

ConvertToPdfA

Summary: Convert PDF to PDFA

Description: Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413-Convert-PDF-to-PDFA

 

Syntax:

Encodian.ConvertToPdfA ([Optional]DtoConvertToPdfA operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoConvertToPdfA

 

 

False

 

Returns:

          Type:DtoResponseConvertToPdfA

 

SecurePdfDocument

Summary: Secure PDF Document

Description: Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document

 

Syntax:

Encodian.SecurePdfDocument ([Optional]DtoSecurePdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSecurePdf

 

 

False

 

Returns:

          Type:DtoResponseSecurePdf

 

SetPdfPrivileges

Summary: Set PDF Document Privileges

Description: Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094-Set-PDF-Document-Privileges

 

Syntax:

Encodian.SetPdfPrivileges ([Optional]DtoSetPdfPrivileges operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSetPdfPrivileges

 

 

False

 

Returns:

          Type:DtoResponseSecurePdf

 

TextToPDF

Summary: Convert Text to PDF

Description: Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054-Convert-Text-to-PDF

 

Syntax:

Encodian.TextToPDF ([Optional]DtoTextToPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoTextToPdf

 

 

False

 

Returns:

          Type:DtoResponseTextToPdf

 

HtmlToPDF

Summary: Convert HTML to PDF

Description: Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154-Convert-HTML-to-PDF

 

Syntax:

Encodian.HtmlToPDF ([Optional]DtoHtmlToPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoHtmlToPdf

 

 

False

 

Returns:

          Type:DtoResponseHtmlToPdf

 

HtmlToWord

Summary: Convert HTML to Word

Description: Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213-Convert-HTML-to-Word

 

Syntax:

Encodian.HtmlToWord ([Optional]DtoHtmlToWord operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoHtmlToWord

 

 

False

 

Returns:

          Type:DtoResponseHtmlToWord

 

InsertHtmlToPdf

Summary: Insert HTML to PDF

Description: Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354-Insert-HTML-to-PDF

 

Syntax:

Encodian.InsertHtmlToPdf ([Optional]DtoInsertHtmlToPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoInsertHtmlToPdf

 

 

False

 

Returns:

          Type:DtoResponseInsertHtmlToPdf

 

MergeDocumentsToPdf

Summary: Merge documents to PDF

Description: Convert and merge the documents provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173-Merge-documents-to-PDF

 

Syntax:

Encodian.MergeDocumentsToPdf ([Optional]DtoMergeDocumentsToPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoMergeDocumentsToPdf

 

 

False

 

Returns:

          Type:DtoResponseMergeDocumentsToPdf

 

MergeArrayOfDocumentsToPdf

Summary: Merge document array to PDF

Description: Convert and merge an array of documents to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213-Merge-document-array-to-PDF

 

Syntax:

Encodian.MergeArrayOfDocumentsToPdf ([Optional]DtoMergeArrayOfDocumentsToPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoMergeArrayOfDocumentsToPdf

 

 

False

 

Returns:

          Type:DtoResponseMergeArrayOfDocumentsToPdf

 

MergeArrayOfDocumentsToWord

Summary: Merge Word Documents

Description: Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word

 

Syntax:

Encodian.MergeArrayOfDocumentsToWord ([Optional]DtoMergeArrayOfDocumentsToWord operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoMergeArrayOfDocumentsToWord

 

 

False

 

Returns:

          Type:DtoResponseMergeArrayOfDocumentsToWord

 

OcrPdfDocument

Summary: OCR a PDF Document

Description: Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document

 

Syntax:

Encodian.OcrPdfDocument ([Optional]DtoOcrPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoOcrPdf

 

 

False

 

Returns:

          Type:DtoResponseOcrPdf

 

SplitDocument

Summary: Split PDF

Description: Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277-Split-PDF

 

Syntax:

Encodian.SplitDocument ([Optional]DtoSplitDocument operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSplitDocument

 

 

False

 

Returns:

          Type:DtoResponseSplitDocument

 

SplitPdfByText

Summary: Split PDF by Text

Description: Split a PDF Document by text into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360012726397-Split-PDF-by-Text

 

Syntax:

Encodian.SplitPdfByText ([Optional]DtoSplitPdfByText operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSplitPdfByText

 

 

False

 

Returns:

          Type:DtoResponseSplitPdfByText

 

SplitPdfByBarcode

Summary: Split PDF by Barcode

Description: Split a PDF Document by Barcode, returning multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360013629457-Split-PDF-by-Barcode

 

Syntax:

Encodian.SplitPdfByBarcode ([Optional]DtoSplitPdfByBarcode operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSplitPdfByBarcode

 

 

False

 

Returns:

          Type:DtoResponseSplitPdfByBarcode

 

WordToPdfForm

Summary: Convert Word to PDF Form

Description: Convert the Word document provided (Legacy Form Controls Only) to a PDF form document. - https://support.encodian.com/hc/en-gb/articles/360012307133-Convert-Word-to-PDF-Form

 

Syntax:

Encodian.WordToPdfForm ([Optional]DtoWordToPdfForm operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoWordToPdfForm

 

 

False

 

Returns:

          Type:DtoResponseWordToPdfForm

 

AddTextWatermark

Summary: 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-Add-Text-Watermark

 

Syntax:

Encodian.AddTextWatermark ([Optional]DtoAddTextWatermark operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddTextWatermark

 

 

False

 

Returns:

          Type:DtoResponseAddTextWatermark

 

AddImageWatermark

Summary: 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-Add-Image-Watermark

 

Syntax:

Encodian.AddImageWatermark ([Optional]DtoAddImageWatermark operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddImageWatermark

 

 

False

 

Returns:

          Type:DtoResponseAddImageWatermark

 

AddTextWatermarkAdvanced

Summary: 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-Add-Text-Watermark-Advanced-

 

Syntax:

Encodian.AddTextWatermarkAdvanced ([Optional]DtoAddTextWatermarkAdv operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddTextWatermarkAdv

 

 

False

 

Returns:

          Type:DtoResponseAddTextWatermarkAdv

 

AddImageWatermarkAdvanced

Summary: 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-Add-Image-Watermark-Advanced-

 

Syntax:

Encodian.AddImageWatermarkAdvanced ([Optional]DtoAddImageWatermarkAdv operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddImageWatermarkAdv

 

 

False

 

Returns:

          Type:DtoResponseAddImageWatermarkAdv

 

ImageCleanUpDocument

Summary: Image Clean Up (Document)

Description: Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more.

 

Syntax:

Encodian.ImageCleanUpDocument ([Optional]DtoImageCleanUpDoc operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoImageCleanUpDoc

 

 

False

 

Returns:

          Type:DtoResponseImageCleanUpDoc

 

ImageCleanUpPhoto

Summary: Image Clean Up (Photo)

Description: Execute image clean up activities for standard photo images.

 

Syntax:

Encodian.ImageCleanUpPhoto ([Optional]DtoImageCleanUpPhoto operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoImageCleanUpPhoto

 

 

False

 

Returns:

          Type:DtoResponseImageCleanUpPhoto

 

ExtractTextRegions

Summary: 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-Extract-Text-from-Regions

 

Syntax:

Encodian.ExtractTextRegions ([Optional]DtoExtractTextRegion operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoExtractTextRegion

 

 

False

 

Returns:

          Type:DtoResponseExtractTextRegion

 

AddHtmlHeaderFooter

Summary: 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-Add-HTML-Header-or-Footer

 

Syntax:

Encodian.AddHtmlHeaderFooter ([Optional]DtoAddHtmlHeaderFooter operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddHtmlHeaderFooter

 

 

False

 

Returns:

          Type:DtoResponseAddHtmlHeaderFooter

 

AddPageNumbers

Summary: Add Page Numbers

Description: Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534-Add-Page-Numbers

 

Syntax:

Encodian.AddPageNumbers ([Optional]DtoAddPageNumbers operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddPageNumbers

 

 

False

 

Returns:

          Type:DtoResponseAddPageNumbers

 

GetPdfTextLayer

Summary: Get PDF Text Layer

Description: Get the text layer for the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373-Get-PDF-Text-Layer

 

Syntax:

Encodian.GetPdfTextLayer ([Optional]DtoGetPdfTextLayer operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoGetPdfTextLayer

 

 

False

 

Returns:

          Type:DtoResponseGetPdfTextLayer

 

RedactPdf

Summary: Redact PDF

Description: Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954-Redact-PDF-

 

Syntax:

Encodian.RedactPdf ([Optional]DtoRedactPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoRedactPdf

 

 

False

 

Returns:

          Type:DtoResponseRedactPdf

 

ResizeImage

Summary: Resize an Image

Description: Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image

 

Syntax:

Encodian.ResizeImage ([Optional]DtoImageResize operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoImageResize

 

 

False

 

Returns:

          Type:DtoResponseImageResize

 

GetPdfFormData

Summary: Get PDF Form Data

Description: Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433-Get-PDF-Form-Data

 

Syntax:

Encodian.GetPdfFormData ([Optional]DtoGetPdfFormData operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoGetPdfFormData

 

 

False

 

Returns:

          Type:DtoResponseGetPdfFormData

 

SearchAndReplaceText

Summary: Search and Replace Text

Description: Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text

 

Syntax:

Encodian.SearchAndReplaceText ([Optional]DtoSearchAndReplaceText operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSearchAndReplaceText

 

 

False

 

Returns:

          Type:DtoResponseSearchAndReplaceText

 

SearchAndReplaceTextWithImage

Summary: Replace Text with Image

Description: Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874

 

Syntax:

Encodian.SearchAndReplaceTextWithImage ([Optional]DtoSearchAndReplaceTextWithImage operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoSearchAndReplaceTextWithImage

 

 

False

 

Returns:

          Type:DtoResponseSearchAndReplaceTextWithImage

 

ConvertPdfToWord

Summary: Convert PDF to Word

Description: Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294-Convert-PDF-to-Word

 

Syntax:

Encodian.ConvertPdfToWord ([Optional]DtoConvertPdfToWord operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoConvertPdfToWord

 

 

False

 

Returns:

          Type:DtoResponseConvertPdfToWord

 

CompressImage

Summary: Compress an Image

Description: Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513-Compress-an-Image

 

Syntax:

Encodian.CompressImage ([Optional]DtoImageCompress operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoImageCompress

 

 

False

 

Returns:

          Type:DtoResponseImageCompress

 

AddToZip

Summary: Add to Archive (ZIP)

Description: Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP

 

Syntax:

Encodian.AddToZip ([Optional]DtoZipArrayOfDocuments operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoZipArrayOfDocuments

 

 

False

 

Returns:

          Type:DtoResponseZipArrayOfDocuments

 

GetPdfDocumentInfo

Summary: Get PDF Document Information

Description: Get PDF Document Information (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358-Get-PDF-Document-Information

 

Syntax:

Encodian.GetPdfDocumentInfo ([Optional]DtoGetPdfDocumentInfo operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoGetPdfDocumentInfo

 

 

False

 

Returns:

          Type:DtoResponseGetPdfDocumentInfo

 

UnlockPdfDocument

Summary: Unlock PDF Document

Description: Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237-Unlock-PDF-Document

 

Syntax:

Encodian.UnlockPdfDocument ([Optional]DtoUnlockPdf operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoUnlockPdf

 

 

False

 

Returns:

          Type:DtoResponseUnlockPdf

 

ParseCsv

Summary: Parse CSV

Description: Parse CSV and return the extracted data in JSON format - https://support.encodian.com/hc/en-gb/articles/360005177297-Parse-CSV

 

Syntax:

Encodian.ParseCsv ([Optional]DtoParseCsv operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoParseCsv

 

 

False

 

Returns:

          Type:DtoResponseParseCsv

 

CreateQrCode

Summary: Create QR Code

Description: Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237-Create-QR-Code

 

Syntax:

Encodian.CreateQrCode ([Optional]DtoCreateQrCode operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoCreateQrCode

 

 

False

 

Returns:

          Type:DtoResponseCreateQrCode

 

ReadQrCodeFromImage

Summary: Read QR Code - Image

Description: Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898-Read-QR-Code-Image

 

Syntax:

Encodian.ReadQrCodeFromImage ([Optional]DtoReadQrCodeFromImage operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoReadQrCodeFromImage

 

 

False

 

Returns:

          Type:DtoResponseReadQrCodeFromImage

 

ReadQrCodeFromDocument

Summary: Read QR Code - Document

Description: Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437-Read-QR-Code-Document

 

Syntax:

Encodian.ReadQrCodeFromDocument ([Optional]DtoReadQrCodeFromDocument operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoReadQrCodeFromDocument

 

 

False

 

Returns:

          Type:DtoResponseReadQrCodeFromDocument

 

CreateBarcode

Summary: Create Barcode

Description: Create a Barcode in the specified image format - https://support.encodian.com/hc/en-gb/articles/360006165457-Create-Barcode

 

Syntax:

Encodian.CreateBarcode ([Optional]DtoCreateBarcode operation, [Optional]string barcodeTypeParameter)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoCreateBarcode

 

 

False

barcodeTypeParameter

string

(Barcode Type)Values: [AustraliaPost, Aztec, Codabar, CodablockF, Code11, Code128, Code16K, DatabarExpanded, DatabarExpandedStacked, DatabarLimited, DatabarOmniDirectional, DatabarStacked, DatabarStackedOmniDirectional, DatabarTruncated, DataMatrix, DotCode, EAN8, EAN13, GS1Code128, GS1CodablockF, Interleaved2of5, ISBN, ISMN, ISSN, ITF6, ITF14, MaxiCode, Pdf417, Planet, Postnet, Standard2of5, UPCA, UpcaGs1Code128Coupon, UpcaGs1DatabarCoupon, UPCE]

Set the barcode type

False

 

Returns:

          Type:DtoResponseCreateBarcode

 

ReadBarcodeFromImage

Summary: Read Barcode - Image

Description: Read a barcode from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170918-Read-Barcode-Image

 

Syntax:

Encodian.ReadBarcodeFromImage ([Optional]DtoReadBarcodeFromImage operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoReadBarcodeFromImage

 

 

False

 

Returns:

          Type:DtoResponseReadBarcodeFromImage

 

ReadBarcodeFromDocument

Summary: Read Barcode - Document

Description: Read barcode(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006170938-Read-Barcode-Document

 

Syntax:

Encodian.ReadBarcodeFromDocument ([Optional]DtoReadBarcodeFromDocument operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoReadBarcodeFromDocument

 

 

False

 

Returns:

          Type:DtoResponseReadBarcodeFromDocument

 

ImageConvertFormat

Summary: Convert Image Format

Description: Convert the format of the image provided - https://support.encodian.com/hc/en-gb/articles/360006617857-Convert-Image-Format

 

Syntax:

Encodian.ImageConvertFormat ([Optional]DtoImageConvertFormat operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoImageConvertFormat

 

 

False

 

Returns:

          Type:DtoResponseImageConvertFormat

 

RegexSearchText

Summary: Search Text - Regex

Description: Search the text provided to find matches using the regex provided - https://support.encodian.com/hc/en-gb/articles/360006764638-Search-Text-Regex

 

Syntax:

Encodian.RegexSearchText ([Optional]DtoRegexSearchText operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoRegexSearchText

 

 

False

 

Returns:

          Type:DtoResponseRegexSearchText

 

ExtractImages

Summary: Extract Images from PDF

Description: Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058-Extract-Images-from-PDF

 

Syntax:

Encodian.ExtractImages ([Optional]DtoExtractImage operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoExtractImage

 

 

False

 

Returns:

          Type:DtoResponseExtractImage

 

ImageExtractText

Summary: Extract Text from Image (OCR)

Description: Extract text from the image provided - https://support.encodian.com/hc/en-gb/articles/360006998078-Extract-Text-from-Image-OCR

 

Syntax:

Encodian.ImageExtractText ([Optional]DtoImageExtractText operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoImageExtractText

 

 

False

 

Returns:

          Type:DtoResponseImageExtractText

 

FillPdfForm

Summary: Fill a PDF Form

Description: Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077-Fill-a-PDF-Form

 

Syntax:

Encodian.FillPdfForm ([Optional]DtoFillPdfForm operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoFillPdfForm

 

 

False

 

Returns:

          Type:DtoResponseFillPdfForm

 

ConvertMailMessage

Summary: Convert Email Message

Description: Convert an email to PDF - https://support.encodian.com/hc/en-gb/articles/360011566298-Convert-Mail-Message

 

Syntax:

Encodian.ConvertMailMessage ([Optional]DtoConvertMailMessage conversion)

 

Parameters:

Name

Type

Summary

Required

Related Action

conversion

DtoConvertMailMessage

 

 

False

 

Returns:

          Type:DtoResponseConvertMailMessage

 

ConvertExcel

Summary: Convert Excel

Description: Convert Microsoft Excel documents to another document format - https://support.encodian.com/hc/en-gb/articles/360011804178-Convert-Excel

 

Syntax:

Encodian.ConvertExcel ([Optional]DtoConvertExcel conversion, [Optional]string outputFormatParameter)

 

Parameters:

Name

Type

Summary

Required

Related Action

conversion

DtoConvertExcel

 

 

False

outputFormatParameter

string

(Output Format)Values: [PDF, HTML, CSV, TXT, XLSX, PNG, TIFF]

Set the output file type

False

 

Returns:

          Type:DtoResponseConvertExcel

 

ConvertWord

Summary: Convert Word

Description: Convert Microsoft Word documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015616117-Convert-Word

 

Syntax:

Encodian.ConvertWord ([Optional]DtoConvertWord conversion, [Optional]string outputFormatParameter)

 

Parameters:

Name

Type

Summary

Required

Related Action

conversion

DtoConvertWord

 

 

False

outputFormatParameter

string

(Output Format)Values: [PDF, HTML, DOCX, TXT, DOC, PNG, TIFF]

Set the output file type

False

 

Returns:

          Type:DtoResponseConvertWord

 

ConvertPowerPoint

Summary: Convert PowerPoint

Description: Convert Microsoft PowerPoint documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015879777-Convert-PowerPoint

 

Syntax:

Encodian.ConvertPowerPoint ([Optional]DtoConvertPowerPoint conversion, [Optional]string outputFormatParameter)

 

Parameters:

Name

Type

Summary

Required

Related Action

conversion

DtoConvertPowerPoint

 

 

False

outputFormatParameter

string

(Output Format)Values: [PDF, HTML, PPTX, TXT, PNG, TIFF]

Set the output file type

False

 

Returns:

          Type:DtoResponseConvertPowerPoint

 

CreateHMAC

Summary: Create HMAC

Description: Create a Hash-based message authentication code (HMAC) using a secret key - https://support.encodian.com/hc/en-gb/articles/360012782058-Create-HMAC

 

Syntax:

Encodian.CreateHMAC ([Optional]DtoCreateHMAC operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoCreateHMAC

 

 

False

 

Returns:

          Type:DtoResponseCreateHMAC

 

CreateHashCode

Summary: Create Hash Code

Description: Create a hashcode for the string provided - https://support.encodian.com/hc/en-gb/articles/360013996077-Create-Hash-Code

 

Syntax:

Encodian.CreateHashCode ([Optional]DtoCreateHashCode operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoCreateHashCode

 

 

False

 

Returns:

          Type:DtoResponseCreateHashCode

 

AddTextWatermarkToImage

Summary: Add Text Watermark to Image

Description: Add a Text Watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/360013560398-Add-Text-Watermark-To-Image

 

Syntax:

Encodian.AddTextWatermarkToImage ([Optional]DtoAddTextWatermarkToImage operation)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

DtoAddTextWatermarkToImage

 

 

False

 

Returns:

          Type:DtoResponseAddTextWatermarkToImage

 

GetDynamicSchemaCreateBarcode

Summary: Get Create Barcode Schema

Description: Provides the dynamic schema for the Create Barcode action.

 

Syntax:

Encodian.GetDynamicSchemaCreateBarcode ([Optional]string barcodeType)

 

Parameters:

Name

Type

Summary

Required

Related Action

barcodeType

string

(Barcode Type)

The barcode type to obtain the dynamic schema for.

False

 

Returns:

          Type:GetDynamicSchemaCreateBarcodeResponse

 

GetDynamicSchemaConvertWord

Summary: Get Convert Word Schema

Description: Provides the dynamic schema for the Convert Word action.

 

Syntax:

Encodian.GetDynamicSchemaConvertWord ([Optional]string outputFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

outputFormat

string

(Output Format)

The output format to obtain the dynamic schema for.

False

 

Returns:

          Type:GetDynamicSchemaConvertWordResponse

 

GetDynamicSchemaConvertExcel

Summary: Get Convert Excel Schema

Description: Provides the dynamic schema for the Convert Excel action.

 

Syntax:

Encodian.GetDynamicSchemaConvertExcel ([Optional]string outputFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

outputFormat

string

(Output Format)

The output format to obtain the dynamic schema for.

False

 

Returns:

          Type:GetDynamicSchemaConvertExcelResponse

 

GetDynamicSchemaConvertPowerPoint

Summary: Get Convert PowerPoint Schema

Description: Provides the dynamic schema for the Convert PowerPoint action.

 

Syntax:

Encodian.GetDynamicSchemaConvertPowerPoint ([Optional]string outputFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

outputFormat

string

(Output Format)

The output format to obtain the dynamic schema for.

False

 

Returns:

          Type:GetDynamicSchemaConvertPowerPointResponse

 

GetSubscriptionStatus

Summary: Get Subscription Status

Description: Get the the status of your Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/360010176717-Get-Subscription-Status

 

Syntax:

Encodian.GetSubscriptionStatus ()

 

Returns:

          Type:DtoResponseMgmtGetSubscriptionStatus

 

GetOperationStatus

Summary: Get an Operation Status

Description: Get the operation status of for the operation ID provided.

 

Syntax:

Encodian.GetOperationStatus ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status for the Operation ID provided.

False

 

Returns:

          Type:DtoBaseMgmtResponse

 

GetOperationStatusExtractTextRegion

Summary: Get an Operation Status for ExtractTextRegion

Description: Retrieve the operation status of an ExtractTextRegion operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusExtractTextRegion ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of an ExtractTextRegion operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseExtractTextRegion

 

GetOperationStatusGetPdfTextLayer

Summary: Get an Operation Status for GetPdfTextLayer

Description: Retrieve the operation status of a GetPdfTextLayer operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusGetPdfTextLayer ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetPdfTextLayer operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseGetPdfTextLayer

 

GetOperationStatusGetPdfFormData

Summary: Get an Operation Status for GetPdfFormData

Description: Retrieve the operation status of a GetPdfFormData operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusGetPdfFormData ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetPdfFormData operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseGetPdfFormData

 

GetOperationStatusSplitDocument

Summary: Get an Operation Status for SplitDocument

Description: Get the operation status of for the operation ID provided.

 

Syntax:

Encodian.GetOperationStatusSplitDocument ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a SplitDocument operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseSplitDocument

 

GetOperationStatusGetPdfDocumentInfo

Summary: Get an Operation Status for GetPdfDocumentInfo

Description: Get the operation status of for the operation ID provided.

 

Syntax:

Encodian.GetOperationStatusGetPdfDocumentInfo ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetPdfDocumentInfo operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseGetPdfDocumentInfo

 

GetOperationStatusParseCsv

Summary: Get an Operation Status for ParseCsv

Description: Retrieve the operation status of a ParseCsv operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusParseCsv ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusParseCsv operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseParseCsv

 

GetOperationStatusReadQrCodeFromImage

Summary: Get an Operation Status for ReadQrCodeFromImage

Description: Retrieve the operation status of a ReadQrCodeFromImage operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusReadQrCodeFromImage ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusReadQrCodeFromImage operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseReadQrCodeFromImage

 

GetOperationStatusReadQrCodeFromDocument

Summary: Get an Operation Status for ReadQrCodeFromDocument

Description: Retrieve the operation status of a ReadQrCodeFromDocument operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusReadQrCodeFromDocument ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusReadQrCodeFromDocument operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseReadQrCodeFromDocument

 

GetOperationStatusReadBarcodeFromImage

Summary: Get an Operation Status for ReadBarcodeFromImage

Description: Retrieve the operation status of a ReadBarcodeFromImage operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusReadBarcodeFromImage ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusReadBarcodeFromImage operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseReadBarcodeFromImage

 

GetOperationStatusReadBarcodeFromDocument

Summary: Get an Operation Status for ReadBarcodeFromDocument

Description: Retrieve the operation status of a ReadBarcodeFromDocument operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusReadBarcodeFromDocument ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusReadBarcodeFromDocument operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseReadBarcodeFromDocument

 

GetOperationStatusRegexSearchText

Summary: Get an Operation Status for RegexSearchText

Description: Retrieve the operation status of a RegexSearchText operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusRegexSearchText ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusRegexSearchText operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseRegexSearchText

 

GetOperationStatusExtractImage

Summary: Get an Operation Status for ExtractImage

Description: Get the operation status of for the operation ID provided.

 

Syntax:

Encodian.GetOperationStatusExtractImage ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of an ExtractImage operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseExtractImage

 

GetOperationStatusImageExtractText

Summary: Get an Operation Status for ImageExtractText

Description: Get the operation status of for the operation ID provided.

 

Syntax:

Encodian.GetOperationStatusImageExtractText ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of an ImageExtractText operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseImageExtractText

 

GetOperationStatusCreateHMAC

Summary: Get an Operation Status for CreateHMAC

Description: Retrieve the operation status of a CreateHMAC operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusCreateHMAC ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusCreateHMAC operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseCreateHMAC

 

GetOperationStatusCreateHashCode

Summary: Get an Operation Status for CreateHashCode

Description: Retrieve the operation status of a CreateHashCode operation for the Operation ID provided.

 

Syntax:

Encodian.GetOperationStatusCreateHashCode ([Optional]string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

 

Retrieve the operation status of a GetOperationStatusCreateHashCode operation for the Operation ID provided.

False

 

Returns:

          Type:DtoResponseCreateHashCode

 


 

DocumentArray

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

Filename

The filename of the file

fileContent

string(byte)

File Content

The file content of the file


 

DocumentArrayWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

Filename

The filename of the source file, the file extension is mandatory: 'file.docx' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

sortPosition

integer(int32)

Sort Position

Set the sort position within the document array

wordInputFormatMode

string

Format Mode

Set how formatting is handled when documents are merged into the first document in the array.  Values: [KeepSourceFormatting, KeepDifferentStyles, UseDestinationStyles]


 

DtoAddHtmlHeaderFooter

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

htmlHeaderFooter

string

HTML Header / Footer

The HTML to embed as a header or footer within the document

htmlHeaderFooterLocation

string

Location

Set whether the HTML should be added to the header, footer of both locations.  Values: [Header, Footer, Both]

skipFirstPage

boolean

Skip First Page

Set whether to ignore the first page when the header / footers are added.

marginTop

number(double)

Top Margin

Set the top margin value (mm).

marginBottom

number(double)

Bottom Margin

Set the bottom margin value (mm).

marginRight

number(double)

Right Margin

Set the right margin value (mm).

marginLeft

number(double)

Left Margin

Set the left margin value (mm).

applyTo

string

Apply To

Set which pages within the PDF document to apply the HTML header or footer.  Values: [FirstPage, AllPages, LastPage, Specific]

pageNumbers

array of (integer(int32))

Page Numbers

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

array of (integer(int32))

Ignore Page Numbers

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

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

watermarkFilename

string

Watermark Filename

The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'

watermarkFileContent

string(byte)

Watermark File Content

The content of the watermark image file

skipFirstPage

boolean

Skip First Page

Set whether to skip applying the watermark to the first page.

Orientation

string

Orientation

The orientation of the image to embed as a watermark within the document  Values: [Vertical, Horizontal, Diagonal]

Opacity

number(float)

Opacity

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

watermarkFilename

string

Watermark Filename

The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'

watermarkFileContent

string(byte)

Watermark File Content

The content of the watermark image file

skipFirstPage

boolean

Skip First Page

Set whether to skip applying the watermark to the first page.

applyTo

string

Apply To

Set where in the document to apply the watermark.  Values: [FirstPage, AllPages, LastPage, Specific]

pageNumbers

array of (integer(int32))

Page Numbers

Specify the page numbers where the watermark should be applied, this only applies when the 'Apply To' property is set to 'Specific'.

ignorePageNumbers

array of (integer(int32))

Ignore Page Numbers

Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'.

opacity

number(float)

Watermark Opacity

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

rotationAngle

number(float)

Rotation Angle

Set the rotation angle of the image watermark in degrees.

quality

integer(int32)

Quality

Set the quality of the image watermark from 1 to 100.

imageXOffset

number(float)

X Offset

Set the X offset for positioning the watermark image on the page.

imageYOffSet

number(float)

Y Offset

Set the Y offset for positioning the watermark image on the page.

scale

number(float)

Scale

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

boolean

Add to Background

If set to 'true' the watermark image will be added to the background of the page.

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

StartPage

integer(int32)

Start Page

Set which page to start adding page number(s) from.

StartNumber

integer(int32)

Start Number

Set the starting number for the page number(s) added to the document.

PageNumberFormat

string

Page Number Format

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

string

Horizontal Alignment

Set the horizontal alignment of the page number(s) added to the document, the default value is Center.  Values: [None, Left, Center, Right, Justify, FullJustify]

MarginTop

number(double)

Margin - Top

Set the top margin value (pt). The default value is set to 20.

MarginRight

number(double)

Margin - Right

Set the right margin value(pt). The default value is set to 20.

MarginBottom

number(double)

Margin - Bottom

Set the bottom margin value (pt). The default value is set to 20.

MarginLeft

number(double)

Margin - Left

Set the left margin value (pt). The default value is set to 20.

AddToBackground

boolean

Add to Background

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

string

Font

Specify the name of the font, if the font cannot be found the default 'Arial' will be used.

FontColour

string

Font Colour

Set the HTML colour of the font, the default colour is set to #000000.

FontSize

integer(int32)

Font Size

Set the size of the font, the default size is set to 14.

Opacity

number(float)

Opacity

Set the opacity of the page number(s), valid values range from 0.0+ to 1.0, the default value is 1.0

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

Text

string

Text

The text to embed as a watermark within the document

skipFirstPage

boolean

Skip First Page

Set whether to skip applying the watermark to the first page.

Orientation

string

Orientation

The orientation of the text to embed as a watermark within the document  Values: [Vertical, Horizontal, Diagonal]

Font

string

Font

The font applied to the text watermark, the default font is set to Arial.

TextColour

string

Text Colour

The HTML colour applied to the text watermark, the default colour is set to #E81123.

TextSize

integer(int32)

Text Size

The size of the font applied to the text watermark, the default size is set to 34.

Opacity

number(float)

Opacity

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

Text

string

Text

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

boolean

Skip First Page

Set whether to skip applying the watermark to the first page.

ApplyTo

string

Apply To

Set where in the document to apply the watermark.  Values: [FirstPage, AllPages, LastPage, Specific]

pageNumbers

array of (integer(int32))

Page Numbers

Specify the page numbers where the watermark should be applied, this proporty only applies when the 'Apply To' property is set to 'Specific'.

ignorePageNumbers

array of (integer(int32))

Ignore Page Numbers

Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'.

Font

string

Font

The font applied to the text watermark, the default font is set to Arial.

TextColour

string

Text Colour

The HTML colour applied to the text watermark, the default colour is set to #E81123.

TextSize

integer(int32)

Text Size

The size of the font applied to the text watermark, the default size is set to 34.

Opacity

number(float)

Opacity

The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0

EncodingType

string

Encoding Type

The encoding type to apply to the text watermark.  Values: [Identity_h, Identity_v, Cp1250, Cp1252, Cp1257, Winansi, Macroman]

HorizontalAlignment

string

Horizontal Alignment

Set the horizontal alignment of the watermark, the default value is Center.  Values: [None, Left, Center, Right, Justify, FullJustify]

VerticalAlignment

string

Vertical Alignment

Set the vertical alignment of the watermark, the default value is Center.  Values: [None, Top, Center, Bottom]

TextAlignment

string

Text Alignment

Set the text alignment of the watermark, the default value is Center.  Values: [None, Left, Center, Right, Justify, FullJustify]

RotationAngle

number(float)

Rotation Angle

Set the rotation angle of the text watermark.

TextWrap

boolean

Text Wrap

Set whether the text watermark should automatically wrap.

TextWrapRowWidth

number(double)

Text Wrap Row Width

Set the row width applied when the watermark is set to automatically wrap.

AutoScale

boolean

Auto Scale

Set the whether the text should be automatically sized to fit the width of the container.

AutoScaleWidth

number(double)

Auto Scale Text Width

Set the width of the watermark container when automatic scaling is enabled.

AutoScaleHeight

number(double)

Auto Scale Text Height

Set the height of the watermark container when automatic scaling is enabled.

TextLayer

boolean

Text Layer

Set whether the watermark should be added to the top or bottom layer. If 'True' the watermark is added to the bottom layer.

YIndent

number(double)

Y Indent

Set the vertical watermark indent, starting from the bottom and overriding the VerticalAlignment property.

XIndent

number(double)

X Indent

Set the horizontal watermark indent, starting from the left and overriding the HorizontalAlignment property.

watermarkApplyAsImage

boolean

Apply as an Image

Set whether the text watermark should be added as text or an image.

operationId

string

Operation ID

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

boolean

Return File

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


 

DtoAddTextWatermarkToImage

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source image file, the file extension is mandatory: 'file.jpg' and not 'file'

FileContent

string(byte)

File Content

The file content of the source image file

Text

string

Text

The text to embed as a watermark within the image

WatermarkPosition

string

Watermark Position

The position of the text to embed as a watermark within the image  Values: [BottomLeft, TopLeft, BottomRight, TopRight, CentreHorizontal, CentreVertical, Diagonal]

Font

string

Font

The font applied to the text watermark, the default font is set to Arial.

TextColour

string

Text Colour

The HTML colour applied to the text watermark, the default colour is set to #E81123.

TextSize

integer(int32)

Text Size

The size of the font applied to the text watermark, the default size is set to 10.

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoBasicConversion

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

outputFilename

string

PDF Filename

The filename of the output PDF document

removeDocumentMarkup

boolean

Remove Markup

Set MS Office document comments and tracked changes removal option

pdfaCompliance

boolean

PDF/A Compliant

Set PDF/A Compliance option

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level, the default value is PDF_A_2A.  Values: [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]

GenerateBookmarks

boolean

Generate Bookmarks

Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF.

CultureName

string

Culture Name

Change the thread culture used to process the request.

FinalOperation

boolean

Return File

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


 

DtoConvertExcel

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

Output Filename

The filename of the output document

fileName

string

Filename

The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

outputFormat

string

Output Format

Select the output file type format  Values: [PDF, HTML, CSV, TXT, XLSX, PNG, TIFF]

worksheet

string

Worksheet Name

Specify the name of a specific worksheet

onePagePerSheet

boolean

One Page Per Sheet

Place all sheets into one page

allColumnsInOnePagePerSheet

boolean

All Columns in One Page Per Sheet Name

Place each column of a sheet into its own page

removeDocumentMarkup

boolean

Remove Markup

Set MS Office document comments and tracked changes removal option

cultureName

string

Culture Name

Change the thread culture used to process the request.

generateBookmarks

boolean

Generate Bookmarks

Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF.

pdfaCompliance

boolean

PDF/A Compliant

Set whether the PDF document should be PDF/A compliant.

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level  Values: [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]

tiffCompression

string

Compression

Set the compression type.  Values: [None, Ccitt3, Ccitt4, Lzw, Rle]


 

DtoConvertMailMessage

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

PDF Filename

The filename of the output PDF document

fileName

string

Filename

The filename of the source file, the file extension is mandatory: 'file.msg' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

mergeAttachments

boolean

Merge Attachments

Set whether attachments should be automatically converted and merged with the output.pdf

generateBookmarks

boolean

Generate Bookmarks

Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF.

pdfaCompliance

boolean

PDF/A Compliant

Set PDF/A Compliance option

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level, the default value is PDF_A_2A.  Values: [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]

cultureName

string

Culture Name

Change the thread culture used to process the request.


 

DtoConvertPdfToWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

Filename

The filename of the source HTML file, the file extension is mandatory: 'file.html' and not 'file'

outputFilename

string

Filename

The filename of the output DOCX document

fileContent

string(byte)

File Content

The file content of the source PDF file.

mode

string

Conversion Mode

Values: [Full, PreserveLayout]

recognizeBullets

boolean

Recognize Bullets

 

finalOperation

boolean

Final Operation

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


 

DtoConvertPowerPoint

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

Output Filename

The filename of the output document

outputFormat

string

Output Format

Select the output file type format  Values: [PDF, HTML, PPTX, TXT, PNG, TIFF]

fileName

string

Filename

The filename of the source file, the file extension is mandatory: 'file.pptx' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

slideOrientation

string

Slide Orientation

Manually set the presentations slide orientation.  Values: [Inherit, Portrait, Landscape]

slideSize

string

Slide Size

Manually set the presentations slide size.  Values: [Inherit, Widescreen, A3Paper, A4Paper, B4IsoPaper, B4JisPaper, B5IsoPaper, B5JisPaper, Banner, HagakiCard, Ledger, LetterPaper, OnScreen, OnScreen16x10, OnScreen16x9, Overhead, Slide35mm]

slideScale

string

Slide Scale

When changing the presentations size control how content should be scaled.  Values: [DoNotScale, EnsureFit, Maximise]

showHiddenSlides

boolean

Show Hidden Slides

Set whether hidden slides should be included.

removeDocumentMarkup

boolean

Remove Markup

Set MS Office document comments and tracked changes removal option

cultureName

string

Culture Name

Change the thread culture used to process the request.

pdfaCompliance

boolean

PDF/A Compliant

Set whether the PDF document should be PDF/A compliant.

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level  Values: [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]

slideIndex

integer(int32)

Slide Index

Set the slide within the document to convert to a PNG file.

resolution

integer(int32)

Resolution

Set the DPI (Dots per inch) of the PNG file.

tiffCompression

string

Compression

Set the compression type.  Values: [None, Ccitt3, Ccitt4, Lzw, Rle]


 

DtoConvertToPdfA

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level, the default value is PDF_A_2A.  Values: [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]

operationId

string

Operation ID

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

boolean

Return File

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


 

DtoConvertWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

Output Filename

The filename of the output document

outputFormat

string

Output Format

Select the output file type format  Values: [PDF, HTML, DOCX, TXT, DOC, PNG, TIFF]

fileName

string

Filename

The filename of the source file, the file extension is mandatory: 'file.docx' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

pageOrientation

string

Page Orientation

Manually set the page orientation of the document.  Values: [Inherit, Portrait, Landscape]

pageSize

string

Page Size

Manually set the page size of the document.  Values: [Inherit, A3, A4, A5, B4, B5, EnvelopeDL, Executive, Folio, Ledger, Legal, Letter, Quarto, Statement, Tabloid]

removeDocumentMarkup

boolean

Remove Markup

Set MS Office document comments and tracked changes removal option

cultureName

string

Culture Name

Change the thread culture used to process the request.

generateBookmarks

boolean

Generate Bookmarks

Set whether bookmarks should be automatically created.

pdfaCompliance

boolean

PDF/A Compliant

Set whether the PDF document should be PDF/A compliant.

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level  Values: [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]

convertToForm

boolean

Convert to PDF Form

Create a fillable PDF Form.

pageIndex

integer(int32)

Page Index

Set the page within the document to convert to a PNG file.

tiffCompression

string

Compression

Set the compression type.  Values: [None, Ccitt3, Ccitt4, Lzw, Rle]


 

DtoCreateBarcode

Summary:

Description:

 

          Properties:

Name

Type

Summary

barcodeType

string

Barcode Type

Set the type of barcode to be produced  Values: [AustraliaPost, Aztec, Codabar, CodablockF, Code11, Code128, Code16K, DatabarExpanded, DatabarExpandedStacked, DatabarLimited, DatabarOmniDirectional, DatabarStacked, DatabarStackedOmniDirectional, DatabarTruncated, DataMatrix, DotCode, EAN8, EAN13, GS1Code128, GS1CodablockF, Interleaved2of5, ISBN, ISMN, ISSN, ITF6, ITF14, MaxiCode, Pdf417, Planet, Postnet, Standard2of5, UPCA, UpcaGs1Code128Coupon, UpcaGs1DatabarCoupon, UPCE]

barcodeData

string

Barcode Data

Set the string value used to generate the barcode.

barcodeImageFormat

string

Image Format

Set the image format for barcode.  Values: [PNG, JPG, SVG, BMP, TIFF, GIF]

captionAbove

string

Caption Above

Set the caption above the barcode.

captionBelow

string

Caption Below

Set the caption below the barcode.

sizeMode

string

Size Mode

Set the barcode auto sizing mode.  Values: [None, Nearest, Fixed, Interpolation]

height

integer(int32)

Height

Set the barcode height (pixels).

width

integer(int32)

Width

Set the barcode width (pixels).

backColor

string

Back Color

Set the barcode back color of the barcode. (HTML color format).

barHeight

integer(int32)

Bar Height

Set the height of the barcode bars (pixels).

barColor

string

Bar Color

Set the color of the barcode bars (HTML color format).

filledBars

boolean

Filled Bars

Set whether the barcode bars are a filled.

borderColor

string

Border Color

Set the barcode border color (HTML color format)

borderStyle

string

Border Style

Set the barcode code border style  Values: [Dash, DashDot, DashDotDot, Dot, Solid]

borderVisible

boolean

Border Visible

Set whether the barcode border is visible or not.

borderWidth

integer(int32)

Border Width

Set width of the barcode border (pixels).

paddingBottom

integer(int32)

Padding Bottom

Set bottom padding of the barcode (pixels).

paddingTop

integer(int32)

Padding Top

Set top padding of the barcode (pixels).

paddingLeft

integer(int32)

Padding Left

Set left padding of the barcode (pixels).

paddingRight

integer(int32)

Padding Right

Set right padding of the barcode (pixels).

resolution

integer(int32)

Resolution

Set the barcode code border image resolution (dpi)

rotationangle

number(float)

Rotation Angle

Set the barcode rotation angle measure in degrees, for best results use 0, 90, 180 or 270.

xDimension

number(float)

X Dimension

Set minimum width of the barcode bars (pixels).

aspectRatio

number(float)

Aspect Ratio

Set the aspect ratio of the barcode

columns

integer(int32)

Columns

Set the number of columns.

rows

integer(int32)

Rows

Set the number of rows.

codeTextEncoding

string

Code Text Encoding

Set Encoding of the text.  Values: [Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII]

itfBorderThickness

integer(int32)

ITF Border Thickness

Set the border thickness for ITF barcodes (pt).

itfBorderType

string

ITF Border Type

Set the border type for ITF barcodes.  Values: [None, Frame, Bar, FrameOut, BarOut]

quietZoneCoef

integer(int32)

Quiet Zone Coefficient

Set the quiet zone coefficient as a mulitple of the X Dimension for ITF barcodes.

postalShortBarHeight

integer(int32)

Postal Short Bar Height

Set the short bar height of Postal barcodes

wideNarrowRatio

number(float)

Wide Narrow Ratio

Set the ratio of wide bars to narrow bars (default 3 i.e. Wide bars are 3 times wider than narrow bars).

supplementData

string

Supplement Data

Set the supplement data that follows the barcode.

supplementSpace

integer(int32)

Supplement Space

Set the space between the main barcode and supplement barcode.

australianPostEncodingTable

string

Encoding Table

Set encoding table type for an Australian Post barcode.  Values: [CTable, NTable, Other]

australianPostShortBarHeight

integer(int32)

Short Bar Height

Set short bar height for an Australian Post barcode (pixels).

aztecErrorLevel

integer(int32)

Error Level

Set the error level protect for Aztec barcodes (value between 10-95)

aztecSymbolMode

string

Symbol Mode

Set the Aztec symbol mode for Aztec barcodes.  Values: [Auto, Compact, FullRange, Rune]

codabarChecksumMode

string

Checksum Mode

Set the checksum mode for Codabar barcodes.  Values: [Mod10, Mod16]

codabarStartSymbol

string

Start Symbol

Set the start symbol for Codabar barcodes.  Values: [A, B, C, D]

codabarStopSymbol

string

Stop Symbol

Set the stop symbol for Codabar barcodes.  Values: [A, B, C, D]

code16KQuietZoneLeftCoef

integer(int32)

Quiet Zone Left Coefficient

Set the size of the left quiet zone as a multiple of the xDimension for Code16K barcodes.

code16KQuietZoneRightCoef

integer(int32)

Quiet Zone Right Coefficient

Set the size of the right quiet zone as a multiple of the xDimension for Code16K barcodes.

dataMatrixEcc

string

ECC Type

Set the DataMatrix ECC type for DataMatrix barcodes.  Values: [EccAuto, Ecc000, Ecc050, Ecc080, Ecc100, Ecc140, Ecc200]

dataMatrixEncodeMode

string

Encode Mode

Set encoding mode for DataMatrix barcodes.  Values: [Auto, ASCII, Full, Custom, C40, Text, EDIFACT, ANSIX12, ExtendedCodetext]

dotCodemask

integer(int32)

Mask

Set the mask value for DotCode barcodes.

maxiCodeEncodeMode

integer(int32)

Encode Mode

Set the encode mode for Maxi Code barcodes (value between 2 and 6).

pdf417CompactionMode

string

Compaction Mode

Set the compaction mode for Pdf417 barcodes.  Values: [Auto, Text, Numeric, Binary]

pdf417ErrorLevel

string

Error Level

Set the error level for Pdf417 barcodes.  Values: [Level0, Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8]

pdf417MacroFileID

integer(int32)

Macro File ID

Set the macro file ID for Pdf417 barcodes.

pdf417MacroSegmentID

integer(int32)

Macro Segment ID

Set the macro segment ID for Pdf417 barcodes.

pdf417MacroSegmentsCount

integer(int32)

Macro Segments Count

Set macro segment count for Pdf417 barcodes.

pdf417Truncate

boolean

Truncate

Set whether the Pdf417 barcode is truncated to save space.


 

DtoCreateHashCode

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

string

Data

Provide the input data to be computed

cryptoInputDataType

string

Data Type

Set the data format for the input data provided.  Values: [TEXT, HEX, BASE64]

digestAlgorithm

string

Digest Algorithm

Select the message digest algorithm  Values: [SHA1, SHA256, SHA384, SHA512, MD5, RIPEMD160]

cryptoOutputDataType

string

Output Type

Set the data format for the hash code generated.  Values: [HASH, BASE64, HEX]

case

string

Case

Set the case applied to the computed value.  Values: [Lower, Upper]

encoding

string

Encoding Type

Select the encoding type.  Values: [UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode, Default]


 

DtoCreateHMAC

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

string

Data

Provide the input data to be computed

cryptoInputDataType

string

Data Type

Set the data format for the input data provided.  Values: [TEXT, HEX, BASE64]

key

string

Key

Provide the key (secret) used to compute the hash-based message authentication code (HMAC)

cryptoKeyDataType

string

Key Type

Set the data format for the key provided.  Values: [TEXT, HEX, BASE64]

digestAlgorithm

string

Digest Algorithm

Select the message digest algorithm  Values: [SHA1, SHA256, SHA384, SHA512, MD5, RIPEMD160]

cryptoOutputDataType

string

Output Type

Set the data format for the HMAC generated.  Values: [HASH, BASE64, HEX]

case

string

Case

Set the case applied to the computed value.  Values: [Lower, Upper]

encoding

string

Encoding Type

Select the encoding type.  Values: [UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode, Default]


 

DtoCreateQrCode

Summary:

Description:

 

          Properties:

Name

Type

Summary

barcodeData

string

Barcode Data

Set the string value used to generate the QR barcode.

barcodeImageFormat

string

Image Format

Set the image format for barcode.  Values: [PNG, JPG, SVG, BMP, TIFF, GIF]

height

integer(int32)

Height

Set the QR code height (pixels).

width

integer(int32)

Width

Set the QR code width (pixels).

sizeMode

string

Auto Size Mode

Set the QR auto size mode, use 'Nearest' to assure QR code readability  Values: [None, Nearest, Fixed, Interpolation]

foreColor

string

Fore Color

Set the QR code foreground color (HTML Color #000000)

backColor

string

Back Color

Set the QR code background color (HTML Color #FFFFFF)

visibleBorder

boolean

Visible Border

Set whether the QR code border is visible

borderColor

string

Border Color

Set the QR code border color (HTML Color #000000)

borderStyle

string

Border Style

Set the QR code border style  Values: [Dash, DashDot, DashDotDot, Dot, Solid]

borderWidth

integer(int32)

Border Width

Set the QR code border width in pixels

resolution

integer(int32)

Resolution

Set the QR code border image resolution (dpi)

encodeMode

string

Encode Mode

Set the QR code encode mode  Values: [Auto, Bytes, ECIEncoding, ExtendedCodetext, Utf16BEBOM, Utf8BOM]

encodeType

string

Encode Type

Set the QR code encode type  Values: [Auto, ForceMicroQR, ForceQR]

textEncodingType

string

Encoding Type

Set the QR code text encoding type  Values: [Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII]


 

DtoExtractImage

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

FileContent

string(byte)

File Content

The file content of the source PDF file

ImageRegions

array of (ImageRegion)

Image Regions

The collection of regions to to extract images from and return.

operationId

string

Operation ID

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


 

DtoExtractTextRegion

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

FileContent

string(byte)

File Content

The file content of the source PDF file

TextRegions

array of (TextRegion)

Text Regions

The collection of regions to to extract text from and return.

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

FileContent

string(byte)

File Content

The file content of the source PDF file

formData

string

Form Data

The JSON data to populate with the PDF Form with.


 

DtoGetPdfDocumentInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

operationId

string

Operation ID

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

FileContent

string(byte)

File Content

The file content of the source PDF file

OperationId

string

Operation ID

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

boolean

Final Operation

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

FileContent

string(byte)

File Content

The file content of the source PDF file

StartPage

integer(int32)

Start Page

Sets the page number to begin text layer extraction from.

EndPage

integer(int32)

End Page

Sets the page number to end text layer extraction from. The default value is set to the last page of the PDF document provided.

TextEncodingType

string

Encoding Type

The encoding type used for text extraction.  Values: [Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII]

operationId

string

Operation ID

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

boolean

Return File

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


 

DtoHtmlToPdf

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source HTML file, the file extension is mandatory: 'file.html' and not 'file'

outputFilename

string

PDF Filename

The filename of the output PDF document

fileContent

string(byte)

File Content

Optional - The file content of the source HTML file.

htmlData

string

HTML Data

Optional - The HTML which will be converted to a PDF document

htmlUrl

string

HTML Url

Optional - The web address to the web page which will be converted to a PDF document

pageOrientation

string

Page Orientation

Set page oprientation (Landscape or portrait).  Values: [Portrait, Landscape]

pageSize

string

Page Size

Set the page size for the output PDF document, A4 is the default size.  Values: [Default, A1, A2, A3, A4, A5, A6, B4, B5, EnvelopeDL, Executive, Folio, Ledger, Legal, Letter, Quarto, Statement, Tabloid]

viewPort

string

Viewport

Set the viewport used to render the HTML.  Values: [Default, Mobile, Tablet, Laptop, LaptopL, FourK]

MarginTop

number(double)

Top Margin

Set the top margin value (mm)

MarginBottom

number(double)

Bottom Margin

Set the bottom margin value (mm)

MarginRight

number(double)

Right Margin

Set the right margin value (mm)

MarginLeft

number(double)

Left Margin

Set the left margin value (mm)

enableBookmarks

boolean

Enable Bookmarks

Enable or disable auto creation of PDF bookmarks.

enableJavaScript

boolean

Enable JavaScript

Enable or disable javascript.

enableHyperlinks

boolean

Enable Hyperlinks

Enable or disable hyperlinks.

createPdfForm

boolean

Create PDF Form

Set whether the HTML content should be converted to a PDF form.

decodeHtmlData

boolean

Decode HTML Data

Set whether the data provided in the HTML Data field should be decoded.

cssType

string

CSS Type

Set whether the standard or print style sheets should be used for HTML conversion.  Values: [Screen, Print]

repeatTableHeader

boolean

Repeat Table Header

Set whether to repeat the table header on every page break. The default value is true

repeatTableFooter

boolean

Repeat Table Footer

Set whether to repeat the table footer on every page break. The default value is true

splitImages

boolean

Split Images

Set whether to split images

splitTextLines

boolean

Split Text Lines

Set whether to split text lines

encoding

string

Encoding

Set the encoding type for the HTML.  Values: [UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode]

delay

integer(int32)

Delay

Set the delay in milliseconds between the HTML being received and the conversion to allo time for JavaScript to load.

FinalOperation

boolean

Return File

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


 

DtoHtmlToWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source HTML file, the file extension is mandatory: 'file.html' and not 'file'

outputFilename

string

Filename

The filename of the output DOCX document

fileContent

string(byte)

File Content

Optional - The file content of the source HTML file.

htmlData

string

HTML Data

Optional - The HTML which will be converted to a Word document

htmlUrl

string

HTML Url

Optional - The web address to the web page which will be converted to a Word document

pageOrientation

string

Page Orientation

Set page oprientation (Landscape or portrait).  Values: [Portrait, Landscape]

pageSize

string

Page Size

Set the page size for the output Word document, A4 is the default size.  Values: [Default, A1, A2, A3, A4, A5, A6, B4, B5, EnvelopeDL, Executive, Folio, Ledger, Legal, Letter, Quarto, Statement, Tabloid]

decodeHtmlData

boolean

Decode HTML Data

Set whether the data provided in the HTML Data field should be decoded.

encoding

string

Encoding

Set the encoding type for the HTML.  Values: [UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode]

MarginTop

number(double)

Top Margin

Set the top margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

MarginBottom

number(double)

Bottom Margin

Set the bottom margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

MarginRight

number(double)

Right Margin

Set the right margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

MarginLeft

number(double)

Left Margin

Set the left margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value.

FinalOperation

boolean

Final Operation

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


 

DtoImageCleanUpDoc

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'

FileContent

string(byte)

File Content

The file content of the source image file

cleanUpType

string

Clean Operations

Perform file clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the provided file.  Values: [Default, None, Specific]

AutoRotate

boolean

Rotate

Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default.

AutoRotateConfidenceLevel

integer(int32)

Rotate Confidence Level

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60.

Deskew

boolean

Deskew

Detects the skew angle and rotates to remove that skew, this is enabled by default.

Despeckle

boolean

Despeckle

Automatically detects speckles and removes them, this is enabled by default.

AdjustBrightnessContrast

boolean

Adjust Brightness and Contrast

This action analyzes a document and automatically adjusts brightness and contrast based on the analysis, this is disabled by default.

RemoveBorder

boolean

Remove Border

Locates border pixels and removes the pixels from the document, this is disabled by default.

SmoothBackground

boolean

Smooth Background

This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise, this is disabled by default.

SmoothObjects

boolean

Smooth Objects

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, this is disabled by default.

RemoveDotShading

boolean

Remove Dot Shading

This action will remove shaded regions from bitonal documents, this is disabled by default.

ImageDetergent

boolean

Image Detergent

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, this is disabled by default.

ApplyAverageFilter

boolean

Average Filter

Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window, this is disabled by default.

RemoveHolePunch

boolean

Remove Hole Punch

Detects and removes hole punch marks from a bitonal document, this is disabled by default.

Binarize

boolean

Binarize

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, this is disabled by default.

FinalOperation

boolean

Final Operation

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


 

DtoImageCleanUpPhoto

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'

FileContent

string(byte)

File Content

The file content of the source image file

cleanUpType

string

Clean Operations

Perform file clean-up operations, the default option will auto rotate, apply colour balance, auto deskew and auto despeckle the provided file.  Values: [Default, None, Specific]

Deskew

boolean

Deskew

Detects the skew angle and rotates to remove that skew, this is enabled by default.

Despeckle

boolean

Despeckle

Automatically detects speckles and removes them, this is enabled by default.

ColorBalance

boolean

Color Balance

Restores and balances the color quality within an image, this is enabled by default.

RemoveBorder

boolean

Remove Border

Locates border pixels and removes the pixels from the document, this is disabled by default.

Contrast

boolean

Contrast

Adjusts the contrast in the current image.

RemoveRedeye

boolean

Remove Redeye

Automatically reduces the red reflection of the flash seen in the eyes of people in color flash photo images.

Blur

boolean

Blur

Blurs the current image by averaging each pixel with each of its neighboring pixels giving it an 'out of focus' appearance.

Diffuse

boolean

Diffuse

Diffuses the current image by replacing each pixel with a randomly selected neighboring pixel.

Binarize

boolean

Binarize

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, this is disabled by default.

AutoRotate

boolean

Rotate

Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default.

AutoRotateConfidenceLevel

integer(int32)

Rotate Confidence Level

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 40.

FinalOperation

boolean

Final Operation

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


 

DtoImageCompress

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

Filename

The filename of the source image file

fileContent

string(byte)

File Content

The file content of the source image file

imageType

string

Image Type

Select the image file format.  Values: [JPG, PNG]


 

DtoImageConvertFormat

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

Filename

The filename of the source image file

fileContent

string(byte)

File Content

The file content of the source image file

currentImageFormat

string

Current Image Format

Select the current image file format.  Values: [BMP, GIF, JPG, PNG, TIF]

newImageFormat

string

New Image Format

Select the new image file format.  Values: [BMP, GIF, JPG, PNG, TIF]


 

DtoImageExtractText

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

Filename

The filename of the source image file

imageType

string

Image Type

Select the image file format.  Values: [JPG, PNG, TIFF, BMP]

fileContent

string(byte)

File Content

The file content of the source image file

ocrLanguage

string

Language

Select the language used for OCR processing  Values: [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]

cleanUpType

string

Clean Operations

Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document.  Values: [Default, None, Specific]

AutoRotate

boolean

Rotate

Automatically detects orientation and rotates it so that the text on it is upright oriented

AutoRotateConfidenceLevel

integer(int32)

Rotate Confidence Level

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 70.

Deskew

boolean

Deskew

Detects the skew angle and rotates to remove that skew.

Despeckle

boolean

Despeckle

Automatically detects speckles and removes them.

AdjustBrightnessContrast

boolean

Adjust Brightness and Contrast

This action analyzes a document and automatically adjusts brightness and contrast based on the analysis.

RemoveBorder

boolean

Remove Border

Locates border pixels and removes the pixels from the document,this is disabled by default.

SmoothBackground

boolean

Smooth Background

This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise.

SmoothObjects

boolean

Smooth Objects

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

boolean

Remove Dot Shading

This action will remove shaded regions from bitonal documents.

ImageDetergent

boolean

Image Detergent

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

boolean

Average Filter

Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window.

RemoveHolePunch

boolean

Remove Hole Punch

Detects and removes hole punch marks from a bitonal document.

Binarize

boolean

Binarize

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.


 

DtoImageResize

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'

FileContent

string(byte)

File Content

The file content of the source image file

ImageResizeType

string

Resize Type

Set whether the image should be resized to a ratio or specific dimensions.  Values: [Percentage, Specific]

ResizePercentage

integer(int32)

Resize Percentage

For percentage resize actions - Set the percentage the image should be decrased or increased in size by.

ImageWidth

integer(int32)

Image Width

For specific resize actions - Set the specific width of the image in pixels

ImageHeight

integer(int32)

Image Height

For specific resize actions - Set the specific height of the image in pixels

MaintainAspectRatio

boolean

Maintain Aspect Ratio

For specific resize actions - If true, the image height will be automatically set relevant to the image width provided.

FinalOperation

boolean

Final Operation

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

htmlData

string

HTML Data

The HTML which will be inserted into the PDF document

htmlInsertLocation

string

HTML Insert Location

Set where within the PDF provided, the HTML data should be inserted, the default value is Prepend.  Values: [Append, Prepend, Specific]

htmlInsertLocationPage

integer(int32)

Page Number

Set a specific page location to insert the HTML data into.

pageOrientation

string

Page Orientation

Set page oprientation (Landscape or portrait).  Values: [Portrait, Landscape]

pageSize

string

Page Size

Set the page size for the output PDF document, A4 is the default size.  Values: [Default, A1, A2, A3, A4, A5, A6, B4, B5, EnvelopeDL, Executive, Folio, Ledger, Legal, Letter, Quarto, Statement, Tabloid]

viewPort

string

Viewport

Set the viewport used to render the HTML.  Values: [Default, Mobile, Tablet, Laptop, LaptopL, FourK]

MarginTop

number(double)

Top Margin

Set the top margin value (mm)

MarginBottom

number(double)

Bottom Margin

Set the bottom margin value (mm)

MarginRight

number(double)

Right Margin

Set the right margin value (mm)

MarginLeft

number(double)

Left Margin

Set the left margin value (mm)

decodeHtmlData

boolean

Decode HTML Data

Set whether the data provided in the HTML Data field should be decoded.

operationId

string

Operation ID

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

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

PDF Filename

The filename of the output PDF document

FileName

string

Filename

The filename of the source file

documents

array of (DocumentArray)

Documents

The array of documents to be processed

removeDocumentMarkup

boolean

Remove Markup

Set MS Office document comments and tracked changes removal option

pdfaCompliance

boolean

PDF/A Compliant

Set PDF/A Compliance option

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level, the default value is PDF_A_2A.  Values: [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]

FinalOperation

boolean

Return File

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


 

DtoMergeArrayOfDocumentsToWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

Filename

The filename of the output DOCX document

documents

array of (DocumentArrayWord)

Documents

The array of Microsoft Word documents to be processed

FinalOperation

boolean

Final Operation

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputFilename

string

PDF Filename

The filename of the output PDF document

FileName

string

Filename

The filename of the 1st source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent

string(byte)

File Content

The file content of the source file

fileName2

string

Filename 2

The filename of the 2nd source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent2

string(byte)

File Content 2

The file content of the 2nd source file

fileName3

string

Filename 3

The filename of the 3rd source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent3

string(byte)

File Content 3

The file content of the 3rd source file

fileName4

string

Filename 4

The filename of the 4th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent4

string(byte)

File Content 4

The file content of the 4th source file

fileName5

string

Filename 5

The filename of the 5th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent5

string(byte)

File Content 5

The file content of the 5th source file

fileName6

string

Filename 6

The filename of the 6th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent6

string(byte)

File Content 6

The file content of the 6th source file

fileName7

string

Filename 7

The filename of the 7th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent7

string(byte)

File Content 7

The file content of the 7th source file

fileName8

string

Filename 8

The filename of the 8th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent8

string(byte)

File Content 8

The file content of the 8th source file

fileName9

string

Filename 9

The filename of the 9th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent9

string(byte)

File Content 9

The file content of the 9th source file

fileName10

string

Filename 10

The filename of the 10th source file, the file extension is mandatory: 'file.xlsx' and not 'file'

fileContent10

string(byte)

File Content 10

The file content of the 10th source file

removeDocumentMarkup

boolean

Remove Markup

Set MS Office document comments and tracked changes removal option

pdfaCompliance

boolean

PDF/A Compliant

Set PDF/A Compliance option

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level, the default value is PDF_A_2A.  Values: [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]

FinalOperation

boolean

Return File

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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

FileContent

string(byte)

File Content

The file content of the source PDF file

ocrLanguage

string

Language

Select the language used for OCR processing  Values: [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]

ocrType

string

OCR Type

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  Values: [Quality, Fast]

pdfaCompliance

boolean

PDF/A Compliant

Set PDF/A Compliance option

pdfaComplianceLevel

string

PDF/A Compliance Level

Set the PDF/A Compliance Level, the default value is PDF_A_2A.  Values: [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]

cleanUpType

string

Clean Operations

Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document.  Values: [Default, None, Specific]

AutoRotate

boolean

Rotate

Automatically detects orientation and rotates it so that the text on it is upright oriented

AutoRotateConfidenceLevel

integer(int32)

Rotate Confidence Level

Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60.

Deskew

boolean

Deskew

Detects the skew angle and rotates to remove that skew.

Despeckle

boolean

Despeckle

Automatically detects speckles and removes them.

AdjustBrightnessContrast

boolean

Adjust Brightness and Contrast

This action analyzes a document and automatically adjusts brightness and contrast based on the analysis.

RemoveBorder

boolean

Remove Border

Locates border pixels and removes the pixels from the document,this is disabled by default.

SmoothBackground

boolean

Smooth Background

This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise.

SmoothObjects

boolean

Smooth Objects

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

boolean

Remove Dot Shading

This action will remove shaded regions from bitonal documents.

ImageDetergent

boolean

Image Detergent

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

boolean

Average Filter

Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window.

RemoveHolePunch

boolean

Remove Hole Punch

Detects and removes hole punch marks from a bitonal document.

Binarize

boolean

Binarize

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

boolean

Remove Blank Pages

Set whether blank pages should be removed from the PDF document.

operationId

string

Operation ID

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

boolean

Return File

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


 

DtoParseCsv

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source CSV file, the file extension is mandatory: 'file.csv' and not 'file'

FileContent

string(byte)

File Content

The file content of the source CSV file

delimiter

string

Delimiter

Set the CSV delimiter, the default value is a comma: ','

csvColumnHeaders

string

Column Headers

Manually set the column headers for the CSV data (Column delimited: Column 1, Column 2, etc.

skipFirstLine

boolean

Skip First Line

Skip the first line of the CSV file, set to 'Yes' if your CSV document contains column headers


 

DtoReadBarcodeFromDocument

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileType

string

File Type

Select the source document format.  Values: [PDF, DOCX]

FileContent

string(byte)

File Content

The file content of the source file

barcodeReadConfidence

string

Confidence

Set the confidence level for barcode detection  Values: [Low, Medium, High]

barcodeRemoveControlChars

boolean

Remove Control Characters

Set whether recognised control characters should be removed


 

DtoReadBarcodeFromImage

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

File Content

The file content of the source image file

barcodeImageFormat

string

Image Format

Select the image format for the barcode image provided.  Values: [PNG, JPG, BMP, TIFF, GIF, EMF]

barcodeReadConfidence

string

Confidence

Set the confidence level for barcode detection  Values: [Low, Medium, High]

barcodeRemoveControlChars

boolean

Remove Control Characters

Set whether recognised control characters should be removed


 

DtoReadQrCodeFromDocument

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileType

string

File Type

Select the source document format.  Values: [PDF, DOCX]

FileContent

string(byte)

File Content

The file content of the source file

barcodeReadConfidence

string

Confidence

Set the confidence level for barcode detection  Values: [Low, Medium, High]

barcodeRemoveControlChars

boolean

Remove Control Characters

Set whether recognised control characters should be removed


 

DtoReadQrCodeFromImage

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

File Content

The file content of the source image file

barcodeImageFormat

string

Image Format

Select the image format for the QR Code image provided.  Values: [PNG, JPG, BMP, TIFF, GIF, EMF]

barcodeReadConfidence

string

Confidence

Set the confidence level for barcode detection  Values: [Low, Medium, High]

barcodeRemoveControlChars

boolean

Remove Control Characters

Set whether recognised control characters should be removed


 

DtoRedactPdf

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

Filename

The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'

fileContent

string(byte)

File Content

The file content of the source PDF file

Redactions

array of (Redaction)

Redactions

The collection of redactions to apply to this PDF document

operationId

string

Operation ID

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

boolean

Return File

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


 

DtoRegexSearchText

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Text

The text to search with the regex string provided

query

string

Regex Query

The regex query to use to find matches in the string provided

ecmaScript

boolean

ECMAScript

Enables ECMAScript-compliant behavior for the expression. This value can be used only in conjunction with the IgnoreCase and Multiline options. Disabled by default.

explicitCapture

boolean

Explicit Capture

Specifies that the only valid captures are explicitly named or numbered groups of the form, disabled by default.

ignoreCase

boolean

Ignore Case

Specifies case-insensitive matching, disabled by default.

ignoreWhitespace

boolean

Ignore Whitespace

Eliminates unescaped white space from the pattern and enables comments marked with #, disabled by default.

multiline

boolean

Multiline

Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string, disabled by default.

rightToLeft

boolean

Right-to-Left

Specifies that the search will be from right to left instead of from left to right, disabled by default.

singleline

boolean

Singleline

Specifies single-line mode. Changes the meaning of the dot (.) so it matches every character (instead of every character except \n), disabled by default.


 

DtoResponseAddHtmlHeaderFooter

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseAddImageWatermark

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseAddImageWatermarkAdv

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseAddPageNumbers

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseAddTextWatermark

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseAddTextWatermarkAdv

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseAddTextWatermarkToImage

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseBasicConversion

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseConvertExcel

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseConvertMailMessage

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseConvertPdfToWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseConvertPowerPoint

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseConvertToPdfA

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseConvertWord

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseCreateBarcode

Summary:

Description:

 

          Properties:

Name

Type

Summary

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status

string

Operation Status

Indicates whether the operation has completed, has been queued or has failed.

Filename

string

Filename

The filename of the document.

FileContent

string(byte)

File Content

The processed document.


 

DtoResponseCreateHashCode

Summary:

Description:

 

          Properties:

Name

Type

Summary

HashCode

string

Hash Code

The computed Hash Code

HttpStatusCode

integer(int32)

HTTP Status Code

The HTTP Status code for the response.

HttpStatusMessage

string

HTTP Status Message

The HTTP Status message for the response.

OperationId

string

Operation ID

The unique ID assigned to this operation.

Errors

array of (string)

Errors

An array of error messages should an error occur.

Operation Status