Connectors Reference

PDF4me

PDF4me gives you all functionalities around PDF, e.g. convert, merge, split, make Pdf/A compatible, optimize, protect, unlock, do OCR, create watermarks, get thumbnails, rotate, attach barcodes.

 

Status: Preview

Tier: Premium

Version: 3.0

 

Actions:

Name

Summary

PdfOcr_V2 ([Optional]PdfOcr_V2ParameterBody body)

PdfOcr

PdfToExcel_V2 ([Optional]PdfToExcel_V2ParameterBody body)

PdfToExcel

PdfToWord_V2 ([Optional]PdfToWord_V2ParameterBody body)

PdfToWord

ConvertToPdf_V2 ([Optional]ConvertToPdf_V2ParameterBody body)

Convert to Pdf

CreateThumbnail_V2 ([Optional]CreateThumbnail_V2ParameterBody body)

Create a Thumbnail

ExtractPages_V2 ([Optional]ExtractPages_V2ParameterBody body)

Extract Pages

Merge_V2 (Merge_V2ParameterBody body)

Merge

Optimize_V2 ([Optional]Optimize_V2ParameterBody body)

Optimize Document

CreatePdfA_V2 ([Optional]CreatePdfA_V2ParameterBody body)

Create PdfA

ProtectDocument_V2 ([Optional]ProtectDocument_V2ParameterBody body)

Protect Document

RotateDocument_V2 ([Optional]RotateDocument_V2ParameterBody body)

Rotate Document

SplitDocument_V2 ([Optional]SplitDocument_V2ParameterBody body)

Split Document

SplitDocByBarcode_V2 ([Optional]SplitDocByBarcode_V2ParameterBody body)

Split Document by Barcode

Stamp_V2 ([Optional]Stamp_V2ParameterBody body)

Stamp

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ConvertToPdf_V2ParameterBody

 

CreatePdfA_V2ParameterBody

 

CreateThumbnail_V2ParameterBody

 

ExtractPages_V2ParameterBody

 

Merge_V2ParameterBody

 

Optimize_V2ParameterBody

 

PdfOcr_V2ParameterBody

 

PdfToExcel_V2ParameterBody

 

PdfToWord_V2ParameterBody

 

ProtectDocument_V2ParameterBody

 

RotateDocument_V2ParameterBody

 

SplitDocByBarcode_V2ParameterBody

 

SplitDocByBarcode_V2Response

 

SplitDocument_V2ParameterBody

 

SplitDocument_V2Response

 

Stamp_V2ParameterBody

 

 

Actions:

PdfOcr_V2

Summary: PdfOcr

Description: Create searchable PDF using OCR. https://developer.pdf4me.com/docs/api/microsoft-flow/pdf-ocr-connector/

 

Syntax:

PDF4me.PdfOcr_V2 ([Optional]PdfOcr_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PdfOcr_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

PdfToExcel_V2

Summary: PdfToExcel

Description: Create XLSX spreadsheets from PDFs with tabular data . Even from an image you can generate an XLS. https://developer.pdf4me.com/docs/api/microsoft-flow/pdf-to-excel-connector/

 

Syntax:

PDF4me.PdfToExcel_V2 ([Optional]PdfToExcel_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PdfToExcel_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

PdfToWord_V2

Summary: PdfToWord

Description: Transform PDF documents to high quality editable DOCX files. https://developer.pdf4me.com/docs/api/microsoft-flow/pdf-to-word-connector/

 

Syntax:

PDF4me.PdfToWord_V2 ([Optional]PdfToWord_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PdfToWord_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

ConvertToPdf_V2

Summary: Convert to Pdf

Description: Convert any type of office documents to PDF format. https://developer.pdf4me.com/docs/api/microsoft-flow/convert-to-pdf-flow-connector/

 

Syntax:

PDF4me.ConvertToPdf_V2 ([Optional]ConvertToPdf_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ConvertToPdf_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

CreateThumbnail_V2

Summary: Create a Thumbnail

Description: Create thumbnail for the PDF document. https://developer.pdf4me.com/docs/api/microsoft-flow/create-thumbnail-flow-connector/

 

Syntax:

PDF4me.CreateThumbnail_V2 ([Optional]CreateThumbnail_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateThumbnail_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

ExtractPages_V2

Summary: Extract Pages

Description: Extract the required pages from the PDF document. https://developer.pdf4me.com/docs/api/microsoft-flow/extract-pages-flow-connector/

 

Syntax:

PDF4me.ExtractPages_V2 ([Optional]ExtractPages_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ExtractPages_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

Merge_V2

Summary: Merge

Description: Merge multiple PDF documents into a single pdf document. https://developer.pdf4me.com/docs/api/microsoft-flow/merge-connector/

 

Syntax:

PDF4me.Merge_V2 (Merge_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Merge_V2ParameterBody

 

 

True

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from PDF4me merge

 

Optimize_V2

Summary: Optimize Document

Description: Optimize the PDF document. https://developer.pdf4me.com/docs/api/microsoft-flow/optimize-document-floe-connector/

 

Syntax:

PDF4me.Optimize_V2 ([Optional]Optimize_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Optimize_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

CreatePdfA_V2

Summary: Create PdfA

Description: Create PdfA document. https://developer.pdf4me.com/docs/api/microsoft-flow/create-pdfa-flow-connector/

 

Syntax:

PDF4me.CreatePdfA_V2 ([Optional]CreatePdfA_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreatePdfA_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output File Content from the PDF4me API response

 

ProtectDocument_V2

Summary: Protect Document

Description: Protect the document with custom password. https://developer.pdf4me.com/docs/api/microsoft-flow/protect-document-flow-document/

 

Syntax:

PDF4me.ProtectDocument_V2 ([Optional]ProtectDocument_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ProtectDocument_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

RotateDocument_V2

Summary: Rotate Document

Description: Rotate the pages and in all directions. https://developer.pdf4me.com/docs/api/microsoft-flow/rotate-document-flow-connector/

 

Syntax:

PDF4me.RotateDocument_V2 ([Optional]RotateDocument_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RotateDocument_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 

SplitDocument_V2

Summary: Split Document

Description: Split the PDF document by page number or recurring pages. https://developer.pdf4me.com/docs/api/microsoft-flow/split-document-flow-connector/

 

Syntax:

PDF4me.SplitDocument_V2 ([Optional]SplitDocument_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SplitDocument_V2ParameterBody

 

 

False

 

Returns:

          Type:SplitDocument_V2Response

 

SplitDocByBarcode_V2

Summary: Split Document by Barcode

Description: Split the PDF document by barcode types and filters. https://developer.pdf4me.com/docs/api/microsoft-flow/split-by-barcode-flow-connector/

 

Syntax:

PDF4me.SplitDocByBarcode_V2 ([Optional]SplitDocByBarcode_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SplitDocByBarcode_V2ParameterBody

 

 

False

 

Returns:

          Type:SplitDocByBarcode_V2Response

 

Stamp_V2

Summary: Stamp

Description: Add a background watermark text to the PDF document. https://developer.pdf4me.com/docs/api/microsoft-flow/stamp-flow-connector/

 

Syntax:

PDF4me.Stamp_V2 ([Optional]Stamp_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Stamp_V2ParameterBody

 

 

False

 

Returns:

          Type:string(binary)File Content

Title: File Content

          Description: Output file content from the PDF4me API response

 


 

ConvertToPdf_V2ParameterBody

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

 


 

CreatePdfA_V2ParameterBody

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_V2ParameterBody

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_V2ParameterBody

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

 


 

Merge_V2ParameterBody

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_V2ParameterBody

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_V2ParameterBody

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_V2ParameterBody

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_V2ParameterBody

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

 


 

ProtectDocument_V2ParameterBody

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_V2ParameterBody

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_V2ParameterBody

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_V2Response

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_V2ParameterBody

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_V2Response

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_V2ParameterBody

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