Connectors Reference

PDF4me Connect

PDF4me Connect is a simple and powerful way to create, edit, manipulate and manage PDFs. It comes loaded with features like Convert, Merge, Split, Make Pdf/A compatible, Optimize, Protect, Unlock, Convert with OCR, Create Watermarks, Get Thumbnails, Rotate, Attach Barcodes, Convert html/md/url to PDF, and Merge Overlay.

 

Status: Preview

Tier: Premium

Version: 2.0

 

Actions:

Name

Summary

ConvertHtmlToPdf_V1 ([Optional]ConvertHtmlToPdf_V1ParameterBody body)

Convert HTML to PDF

ConvertMdToPdf_V1 ([Optional]ConvertMdToPdf_V1ParameterBody body)

Convert Md to PDF

PdfOcr_V1 ([Optional]PdfOcr_V1ParameterBody body)

Convert PDF to editable PDF using OCR

PdfToExcel_V1 ([Optional]PdfToExcel_V1ParameterBody body)

Convert PDF to Excel

PdfToWord_V1 ([Optional]PdfToWord_V1ParameterBody body)

Convert PDF to Word

ConvertToPdf_V1 ([Optional]ConvertToPdf_V1ParameterBody body)

Convert to PDF

ConvertUrlToPdf_V1 ([Optional]ConvertUrlToPdf_V1ParameterBody body)

Convert URL to PDF

CreateThumbnail_V1 ([Optional]CreateThumbnail_V1ParameterBody body)

Create a Thumbnail Image

ExtractPages_V1 ([Optional]ExtractPages_V1ParameterBody body)

Extract Pages from PDF

ImageStamp_V1 ([Optional]ImageStamp_V1ParameterBody body)

Image Stamp on PDF

ProduceDocWithData_V1 ([Optional]ProduceDocWithData_V1ParameterBody body)

Produce document with dynamic data collection and templates

ProduceDocWithDataString_V1 ([Optional]ProduceDocWithDataString_V1ParameterBody body)

Mail Merge with Data String (List of Docs)

ProduceDocWithDataSingle_V1 ([Optional]ProduceDocWithDataSingle_V1ParameterBody body)

Mail Merge with Data String (Single Doc)

ProduceDocWithFile_V1 ([Optional]ProduceDocWithFile_V1ParameterBody body)

Mail Merge with Data File (List of Docs)

ProduceDocWithFileSingle_V1 ([Optional]ProduceDocWithFileSingle_V1ParameterBody body)

Mail Merge with Data File (Single Doc)

Merge_V1 (Merge_V1ParameterBody body)

Merge multiple PDF files into a single PDF file

MergeOverlay_V1 ([Optional]MergeOverlay_V1ParameterBody body)

Merge two PDF files one over another as Overlay

Optimize_V1 ([Optional]Optimize_V1ParameterBody body)

Optimize Document

CreatePdfA_V1 ([Optional]CreatePdfA_V1ParameterBody body)

Create PdfA

ProtectDocument_V1 ([Optional]ProtectDocument_V1ParameterBody body)

Protect Document

RotateDocument_V1 ([Optional]RotateDocument_V1ParameterBody body)

Rotate Document

SplitDocument_V1 ([Optional]SplitDocument_V1ParameterBody body)

Split Document

SplitDocByBarcode_V1 ([Optional]SplitDocByBarcode_V1ParameterBody body)

Split Document by Barcode

Stamp_V1 ([Optional]Stamp_V1ParameterBody body)

Text Stamp on PDF

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ConvertHtmlToPdf_V1ParameterBody

 

ConvertMdToPdf_V1ParameterBody

 

ConvertToPdf_V1ParameterBody

 

ConvertUrlToPdf_V1ParameterBody

 

CreatePdfA_V1ParameterBody

 

CreateThumbnail_V1ParameterBody

 

ExtractPages_V1ParameterBody

 

ImageStamp_V1ParameterBody

 

MergeOverlay_V1ParameterBody

 

Merge_V1ParameterBody

 

Optimize_V1ParameterBody

 

PdfOcr_V1ParameterBody

 

PdfToExcel_V1ParameterBody

 

PdfToWord_V1ParameterBody

 

ProduceDocWithDataSingle_V1ParameterBody

 

ProduceDocWithDataString_V1ParameterBody

 

ProduceDocWithDataString_V1Response

 

ProduceDocWithData_V1ParameterBody

 

ProduceDocWithFileSingle_V1ParameterBody

 

ProduceDocWithFile_V1ParameterBody

 

ProduceDocWithFile_V1Response

 

ProtectDocument_V1ParameterBody

 

RotateDocument_V1ParameterBody

 

SplitDocByBarcode_V1ParameterBody

 

SplitDocByBarcode_V1Response

 

SplitDocument_V1ParameterBody

 

SplitDocument_V1Response

 

Stamp_V1ParameterBody

 

 

Actions:

ConvertHtmlToPdf_V1

Summary: Convert HTML to PDF

Description: Convert your HTML file to PDF. https://pdf4me.com/power-automate/documentation/actions/html-to-pdf/

 

Syntax:

PDF4meConnect.ConvertHtmlToPdf_V1 ([Optional]ConvertHtmlToPdf_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConvertHtmlToPdf_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect.

 

ConvertMdToPdf_V1

Summary: Convert Md to PDF

Description: Convert your Md file to PDF. https://pdf4me.com/power-automate/documentation/actions/markdown-to-pdf/

 

Syntax:

PDF4meConnect.ConvertMdToPdf_V1 ([Optional]ConvertMdToPdf_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConvertMdToPdf_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect.

 

PdfOcr_V1

Summary: Convert PDF to editable PDF using OCR

Description: Create searchable PDF using OCR. https://pdf4me.com/power-automate/documentation/actions/pdf-ocr/

 

Syntax:

PDF4meConnect.PdfOcr_V1 ([Optional]PdfOcr_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PdfOcr_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

PdfToExcel_V1

Summary: Convert PDF to Excel

Description: Create XLSX spreadsheets from PDFs with tabular data. Even from an image you can generate an XLS. https://pdf4me.com/power-automate/documentation/actions/pdf-to-excel/

 

Syntax:

PDF4meConnect.PdfToExcel_V1 ([Optional]PdfToExcel_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PdfToExcel_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

PdfToWord_V1

Summary: Convert PDF to Word

Description: Transform PDF documents to high quality editable DOCX files. https://pdf4me.com/power-automate/documentation/actions/pdf-to-word/

 

Syntax:

PDF4meConnect.PdfToWord_V1 ([Optional]PdfToWord_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PdfToWord_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

ConvertToPdf_V1

Summary: Convert to PDF

Description: Convert any type of office documents to PDF format. https://pdf4me.com/power-automate/documentation/actions/convert-to-pdf/

 

Syntax:

PDF4meConnect.ConvertToPdf_V1 ([Optional]ConvertToPdf_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConvertToPdf_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

ConvertUrlToPdf_V1

Summary: Convert URL to PDF

Description: Convert your URL file to PDF. https://pdf4me.com/power-automate/documentation/actions/url-to-pdf/

 

Syntax:

PDF4meConnect.ConvertUrlToPdf_V1 ([Optional]ConvertUrlToPdf_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConvertUrlToPdf_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect.

 

CreateThumbnail_V1

Summary: Create a Thumbnail Image

Description: Create thumbnail for the PDF document. https://pdf4me.com/power-automate/documentation/actions/create-thumbnail/

 

Syntax:

PDF4meConnect.CreateThumbnail_V1 ([Optional]CreateThumbnail_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateThumbnail_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

ExtractPages_V1

Summary: Extract Pages from PDF

Description: Extract the required pages from the PDF document. https://pdf4me.com/power-automate/documentation/actions/extract-pages/

 

Syntax:

PDF4meConnect.ExtractPages_V1 ([Optional]ExtractPages_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ExtractPages_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

ImageStamp_V1

Summary: Image Stamp on PDF

Description: Add logo image or watermark image to the PDF document. https://pdf4me.com/power-automate/documentation/actions/image-stamp/

 

Syntax:

PDF4meConnect.ImageStamp_V1 ([Optional]ImageStamp_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ImageStamp_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

ProduceDocWithData_V1

Summary: Produce document with dynamic data collection and templates

Description: Produce your document with dynamic data collection and templates.

 

Syntax:

PDF4meConnect.ProduceDocWithData_V1 ([Optional]ProduceDocWithData_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProduceDocWithData_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect.

 

ProduceDocWithDataString_V1

Summary: Mail Merge with Data String (List of Docs)

Description: Merge document template with data as json text. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-string-list/

 

Syntax:

PDF4meConnect.ProduceDocWithDataString_V1 ([Optional]ProduceDocWithDataString_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProduceDocWithDataString_V1ParameterBody

 

 

False

 

Returns:

          Type:ProduceDocWithDataString_V1Response

 

ProduceDocWithDataSingle_V1

Summary: Mail Merge with Data String (Single Doc)

Description: Merge document template with data as json text. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-string-single/

 

Syntax:

PDF4meConnect.ProduceDocWithDataSingle_V1 ([Optional]ProduceDocWithDataSingle_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProduceDocWithDataSingle_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

ProduceDocWithFile_V1

Summary: Mail Merge with Data File (List of Docs)

Description: Merge document template with data from excel or Json file. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-file-list/

 

Syntax:

PDF4meConnect.ProduceDocWithFile_V1 ([Optional]ProduceDocWithFile_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProduceDocWithFile_V1ParameterBody

 

 

False

 

Returns:

          Type:ProduceDocWithFile_V1Response

 

ProduceDocWithFileSingle_V1

Summary: Mail Merge with Data File (Single Doc)

Description: Merge document template with data from excel or Json file. https://pdf4me.com/power-automate/documentation/actions/mail-merge-with-data-file-single/

 

Syntax:

PDF4meConnect.ProduceDocWithFileSingle_V1 ([Optional]ProduceDocWithFileSingle_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProduceDocWithFileSingle_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

Merge_V1

Summary: Merge multiple PDF files into a single PDF file

Description: Merge multiple PDF documents into a single pdf document. https://pdf4me.com/power-automate/documentation/actions/merge/

 

Syntax:

PDF4meConnect.Merge_V1 (Merge_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Merge_V1ParameterBody

 

 

True

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from PDF4me merge

 

MergeOverlay_V1

Summary: Merge two PDF files one over another as Overlay

Description: Merge two PDF documents one over another as Overlay. https://pdf4me.com/power-automate/documentation/actions/merge-overlay/

 

Syntax:

PDF4meConnect.MergeOverlay_V1 ([Optional]MergeOverlay_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

MergeOverlay_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect. https://developer.pdf4me.com/docs/api/microsoft-flow/merge-overlay/

 

Optimize_V1

Summary: Optimize Document

Description: Optimize the PDF document. https://pdf4me.com/power-automate/documentation/actions/compress-pdf/

 

Syntax:

PDF4meConnect.Optimize_V1 ([Optional]Optimize_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Optimize_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

CreatePdfA_V1

Summary: Create PdfA

Description: Create PdfA document. https://pdf4me.com/power-automate/documentation/actions/create-pdfa/

 

Syntax:

PDF4meConnect.CreatePdfA_V1 ([Optional]CreatePdfA_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreatePdfA_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output File Content from the PDF4me Connect

 

ProtectDocument_V1

Summary: Protect Document

Description: Protect the document with custom password. https://pdf4me.com/power-automate/documentation/actions/protect-document/

 

Syntax:

PDF4meConnect.ProtectDocument_V1 ([Optional]ProtectDocument_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProtectDocument_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

RotateDocument_V1

Summary: Rotate Document

Description: Rotate the pages and in all directions. https://pdf4me.com/power-automate/documentation/actions/rotate/

 

Syntax:

PDF4meConnect.RotateDocument_V1 ([Optional]RotateDocument_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RotateDocument_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 

SplitDocument_V1

Summary: Split Document

Description: Split the PDF document by page number or recurring pages. https://pdf4me.com/power-automate/documentation/actions/split-pdf/

 

Syntax:

PDF4meConnect.SplitDocument_V1 ([Optional]SplitDocument_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SplitDocument_V1ParameterBody

 

 

False

 

Returns:

          Type:SplitDocument_V1Response

 

SplitDocByBarcode_V1

Summary: Split Document by Barcode

Description: Split the PDF document by barcode types and filters. https://pdf4me.com/power-automate/documentation/actions/split-by-barcode/

 

Syntax:

PDF4meConnect.SplitDocByBarcode_V1 ([Optional]SplitDocByBarcode_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SplitDocByBarcode_V1ParameterBody

 

 

False

 

Returns:

          Type:SplitDocByBarcode_V1Response

 

Stamp_V1

Summary: Text Stamp on PDF

Description: Add a background watermark text to the PDF document. https://pdf4me.com/power-automate/documentation/actions/text-stamp/

 

Syntax:

PDF4meConnect.Stamp_V1 ([Optional]Stamp_V1ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Stamp_V1ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me Connect

 


 

ConvertHtmlToPdf_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source. HTML/ZIP supported.

docName

string

 

HTML file name.

indexFilePath

string

 

Index File Path required if input file is ZIP.


 

ConvertMdToPdf_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source. .md/.zip supported.

docName

string

 

Input file name.

mdFilePath

string

 

Markdown File Path required if input file is ZIP.


 

ConvertToPdf_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the file from the source

 


 

ConvertUrlToPdf_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

webUrl

string

 

Web URL to be converted as PDF


 

CreatePdfA_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

compliance

string

 

Select the compliance from the list  Values: [PdfA1b, PdfA1a, PdfA2b, PdfA2u, PdfA2a, PdfA3b, PdfA3u, PdfA3a]

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

CreateThumbnail_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

imageAction

ImageAction

 

imageAction

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

name

string

 

Input file name from the source

 

ImageAction

Summary:

Description: imageAction

 

          Properties:

Name

Type

Summary

ImageExtension

string

 

Choose the image extension from the list  Values: [jpg, jpeg, bmp, gif, jb2, jp2, jpf, jpx, png, tif, tiff]

PageSelection

PageSelection

 

PageSelection

WidthPixel

integer(int32)

 

Size of the thumbnail image in (Width)Pixels

 

PageSelection

Summary:

Description: PageSelection

 

          Properties:

Name

Type

Summary

PageNrs

array of (integer(int32))

 

PageNrs

 


 

ExtractPages_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

pageNumbers

string

 

PageNumbers to be extracted (e.g: 1,2)

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

ImageStamp_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

alignX

string

 

Set alignment in horizontal scale  Values: [left, center, right]

alignY

string

 

Set alignment in vertical scale  Values: [top, middle, bottom]

docContent

string(byte)

 

PDF file content.

docName

string

 

PDF File Name

heightInMM

string

 

Height of the image in MilliMeter. 0 for auto detect.

imageFile

string(byte)

 

Image file content.

imageName

string

 

Image file name.

marginXInMM

string

 

Margin from Left origin of the image in MilliMeter

marginYInMM

string

 

Margin from Top origin of the image in MilliMeter

opacity

integer

 

Give number between 0 to 100. 0 is completely transparent. 100 for complete visible.

pages

string

 

Mention the page numbers like 1,2

widthInMM

string

 

Width of the image in MilliMeter. 0 for auto detect.


 

MergeOverlay_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

baseDocContent

string(byte)

 

Base file content.

baseDocName

string

 

Base File Name

layerDocContent

string(byte)

 

Layer file content.

layerDocName

string

 

Layer file name.


 

Merge_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

array of (string(byte))

 

docContent

document

Document

 

document

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Name

 


 

Optimize_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

optimizeProfile

string

 

Choose the profile  Values: [Default, Web, Print, Max]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

PdfOcr_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

qualityType

string

 

Choose QualityType  Values: [Draft, High]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

PdfToExcel_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

qualityType

string

 

Choose QualityType  Values: [Draft, High]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

PdfToWord_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

qualityType

string

 

Choose QualityType  Values: [Draft, High]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

ProduceDocWithDataSingle_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

dataArray

string

 

Data Collection as list of array.  ex: ["V1","V2","V3","V4"]

dataDocContent

string(byte)

 

DataCollection file content.

dataDocName

string

 

Data Collection file name.

outputType

string

 

Choose DocType  Values: [pdf, docx]

templateDocContent

string(byte)

 

Template file content.

templateDocName

string

 

Template file name.


 

ProduceDocWithDataString_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

dataArray

string

 

Data Collection as list of array.  ex: [[""V1","V2","V3","V4"],["V1","V2","V3","V4"]]"

dataDocContent

string(byte)

 

DataCollection file content.

dataDocName

string

 

Data Collection file name.

outputType

string

 

Choose DocType  Values: [pdf, docx]

templateDocContent

string(byte)

 

Template file content.

templateDocName

string

 

Template file name.


 

ProduceDocWithDataString_V1Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputDocuments

array of (OutputDocumentsItem)

 

Output Documents

 

OutputDocumentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

 

Output file name

streamFile

string(byte)

 

Output file content

 


 

ProduceDocWithData_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

dataDocContent

string(byte)

 

DataCollection file content.

dataDocName

string

 

Data Collection file name.

outputType

string

 

Choose OutputType  Values: [Pdf]

templateDocContent

string(byte)

 

Template file content.

templateDocName

string

 

Template file name.


 

ProduceDocWithFileSingle_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

dataArray

string

 

Data Collection as list of array.  ex: [[""V1","V2","V3","V4"],["V1","V2","V3","V4"]]"

dataDocContent

string(byte)

 

Data file content. Supported only .xlsx and .json types.

dataDocName

string

 

Data Collection file name.

outputType

string

 

Choose DocType

templateDocContent

string(byte)

 

Template file content.

templateDocName

string

 

Template file name.


 

ProduceDocWithFile_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

dataArray

string

 

Data Collection as list of array.  ex: [[""V1","V2","V3","V4"],["V1","V2","V3","V4"]]"

dataDocContent

string(byte)

 

Data file content. Supported only .xlsx and .json types.

dataDocName

string

 

Data Collection file name.

outputType

string

 

Choose DocType

templateDocContent

string(byte)

 

Template file content.

templateDocName

string

 

Template file name.


 

ProduceDocWithFile_V1Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

outputDocuments

array of (OutputDocumentsItem)

 

Output Documents

 

OutputDocumentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

 

Output file name

streamFile

string(byte)

 

Output file content

 


 

ProtectDocument_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

password

string

 

Custom password

pdfPermission

string

 

Allowed permission for the document  Values: [All, None, Copy, Annotate, FillForms, SupportDisabilities, Assemble, DigitalPrint, Print, Modify]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

RotateDocument_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

rotationType

string

 

Select the rotation type from the list  Values: [NoRotation, Clockwise, CounterClockwise, UpsideDown]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source

 


 

SplitDocByBarcode_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

barcodeFilter

string

 

Choose the Barcode filter  Values: [startsWith, endsWith, contains, exact]

barcodeString

string

 

Type the barcode data to split

barcodeType

string

 

Choose the Barcode type  Values: [any, datamatrix, qrcode]

docContent

string(byte)

 

The content of the input file

document

Document

 

document

splitBarcodePage

string

 

Choose the Split Barcode Page  Values: [before, after, remove]

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the file

 


 

SplitDocByBarcode_V1Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

splitedDocuments

array of (SplitedDocumentsItem)

 

splitedDocuments

 

SplitedDocumentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

 

Output file name

streamFile

string(byte)

 

Output file content

 


 

SplitDocument_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

docContent

string(byte)

 

The content of the input file

document

Document

 

document

splitAction

string

 

Choose the split action type  Values: [SplitAfterPage, RecurringSplitAfterPage]

splitActionNumber

integer(int32)

 

Enter the value based on the split action

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the file

 


 

SplitDocument_V1Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

splitedDocuments

array of (SplitedDocumentsItem)

 

splitedDocuments

 

SplitedDocumentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileName

string

 

Output file name

streamFile

string(byte)

 

Output file content

 


 

Stamp_V1ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

alignX

string

 

Set alignment in horizontal scale  Values: [left, center, right]

alignY

string

 

Set alignment in vertical scale  Values: [top, middle, bottom]

docContent

string(byte)

 

Input file content from the source

document

Document

 

document

pages

string

 

Mention the page numbers like 1,2

text

string

 

Stamp text

 

Document

Summary:

Description: document

 

          Properties:

Name

Type

Summary

Name

string

 

Input file name from the source