Connectors Reference

Integrable PDF

Integrable PDF is a connector to work with PDF documents. Actions include: watermark PDF documents, protect PDF documents with a password, merge and split PDF documents, and more. Check https://integrable.net/microsoft-flow/pdf for documentation, examples and tutorials.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

LockPdf (LockPdfParameterLockPdfInput LockPdfInput, [internal]string Accept)

Lock PDF

MergePdf (MergePdfParameterMergePdfInput MergePdfInput, [internal]string Accept)

Merge PDF

PasswordProtectPdf (PasswordProtectPdfParameterPasswordProtectPdfInput PasswordProtectPdfInput, [internal]string Accept)

Password Protect PDF

SplitPdf (SplitPdfParameterSplitPdfInput SplitPdfInput, [internal]string Accept)

Split PDF

UnlockPdf (UnlockPdfParameterUnlockPdfInput UnlockPdfInput, [internal]string Accept)

Unlock PDF

WatermarkPdfBackground (WatermarkPdfBackgroundParameterWatermarkPdfBackgroundInput WatermarkPdfBackgroundInput, [internal]string Accept)

Watermark PDF (Background)

WatermarkPdfCustom (WatermarkPdfCustomParameterWatermarkPdfCustomInput WatermarkPdfCustomInput, [internal]string Accept)

Watermark PDF (Custom)

WatermarkPdfOverlay (WatermarkPdfOverlayParameterWatermarkPdfOverlayInput WatermarkPdfOverlayInput, [internal]string Accept)

Watermark PDF (Overlay)

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

LockPdfParameterLockPdfInput

 

MergePdfParameterMergePdfInput

 

PasswordProtectPdfParameterPasswordProtectPdfInput

 

SplitPdfParameterSplitPdfInput

 

UnlockPdfParameterUnlockPdfInput

 

WatermarkPdfBackgroundParameterWatermarkPdfBackgroundInput

 

WatermarkPdfCustomParameterWatermarkPdfCustomInput

 

WatermarkPdfOverlayParameterWatermarkPdfOverlayInput

 

 

Actions:

LockPdf

Summary: Lock PDF

Description: Lock and set restrictions of a PDF document. https://integrable.net/microsoft-flow/lock-pdf

 

Syntax:

IntegrablePDF.LockPdf (LockPdfParameterLockPdfInput LockPdfInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

LockPdfInput

LockPdfParameterLockPdfInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Locked PDF File Content

          Description: The content of the locked PDF document

 

MergePdf

Summary: Merge PDF

Description: Combine multiple PDF documents into a single PDF document. https://integrable.net/microsoft-flow/merge-pdf

 

Syntax:

IntegrablePDF.MergePdf (MergePdfParameterMergePdfInput MergePdfInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

MergePdfInput

MergePdfParameterMergePdfInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Merged PDF File Content

          Description: The content of the merged PDF document

 

PasswordProtectPdf

Summary: Password Protect PDF

Description: Protect a PDF document with a password. https://integrable.net/microsoft-flow/password-protect-pdf

 

Syntax:

IntegrablePDF.PasswordProtectPdf (PasswordProtectPdfParameterPasswordProtectPdfInput PasswordProtectPdfInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

PasswordProtectPdfInput

PasswordProtectPdfParameterPasswordProtectPdfInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Password Protected PDF File Content

          Description: The content of the password protected PDF document

 

SplitPdf

Summary: Split PDF

Description: Extract one or more pages from a PDF document. https://integrable.net/microsoft-flow/split-pdf

 

Syntax:

IntegrablePDF.SplitPdf (SplitPdfParameterSplitPdfInput SplitPdfInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

SplitPdfInput

SplitPdfParameterSplitPdfInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Split PDF File Content

          Description: The content of the split PDF document

 

UnlockPdf

Summary: Unlock PDF

Description: Unlock and remove restrictions of a PDF document. https://integrable.net/microsoft-flow/unlock-pdf

 

Syntax:

IntegrablePDF.UnlockPdf (UnlockPdfParameterUnlockPdfInput UnlockPdfInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

UnlockPdfInput

UnlockPdfParameterUnlockPdfInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Unlocked PDF File Content

          Description: The content of the unlocked PDF document

 

WatermarkPdfBackground

Summary: Watermark PDF (Background)

Description: Add a background watermark to the PDF document. https://integrable.net/microsoft-flow/watermark-pdf

 

Syntax:

IntegrablePDF.WatermarkPdfBackground (WatermarkPdfBackgroundParameterWatermarkPdfBackgroundInput WatermarkPdfBackgroundInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

WatermarkPdfBackgroundInput

WatermarkPdfBackgroundParameterWatermarkPdfBackgroundInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Watermarked PDF File Content

          Description: The content of the watermarked PDF document

 

WatermarkPdfCustom

Summary: Watermark PDF (Custom)

Description: Add a custom watermark to the PDF document. https://integrable.net/microsoft-flow/watermark-pdf-custom

 

Syntax:

IntegrablePDF.WatermarkPdfCustom (WatermarkPdfCustomParameterWatermarkPdfCustomInput WatermarkPdfCustomInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

WatermarkPdfCustomInput

WatermarkPdfCustomParameterWatermarkPdfCustomInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Watermarked PDF File Content

          Description: The content of the watermarked PDF document

 

WatermarkPdfOverlay

Summary: Watermark PDF (Overlay)

Description: Add an overlay watermark to the PDF document. https://integrable.net/microsoft-flow/watermark-pdf

 

Syntax:

IntegrablePDF.WatermarkPdfOverlay (WatermarkPdfOverlayParameterWatermarkPdfOverlayInput WatermarkPdfOverlayInput, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

WatermarkPdfOverlayInput

WatermarkPdfOverlayParameterWatermarkPdfOverlayInput

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Watermarked PDF File Content

          Description: The content of the watermarked PDF document

 


 

LockPdfParameterLockPdfInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

allowAccessibility

boolean

Allow Accessibility

Accessibility programs can read text and images

allowCopy

boolean

Allow Copy

User can copy text and images to the clipboard

allowDocumentAssembly

boolean

Allow Document Assembly

User can assemble and manipulate the document

allowEdit

boolean

Allow Edit

User can edit the document

allowFormFilling

boolean

Allow Form Filling

User can fill forms

allowPrint

boolean

Allow Print

User can print the document

allowUpdateAnnotationsAndFields

boolean

Allow Update Annotations And Fields

User can add, edit and modify annotations and form fields

documentOpenPassword

string

Document Open Password

The password required to open the PDF document

fileContent

string(byte)

File Content

The content of the PDF document

permissionsPassword

string

Permissions Password

The password required to open and change permissions of the PDF document


 

MergePdfParameterMergePdfInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent1

string(byte)

1st File Content

The content of the first PDF document

fileContent2

string(byte)

2nd File Content

The content of the second PDF document

fileContent3

string(byte)

3rd File Content

The content of the third PDF document

fileContent4

string(byte)

4th File Content

The content of the fourth PDF document


 

PasswordProtectPdfParameterPasswordProtectPdfInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

File Content

The content of the PDF document

password

string

Password

The password required to open the file


 

SplitPdfParameterSplitPdfInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

File Content

The content of the PDF document

firstPage

integer

First Page

First page of the split PDF document

lastPage

integer

Last Page

Last page of the split PDF document


 

UnlockPdfParameterUnlockPdfInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

File Content

The content of the PDF document

password

string

Password

The password required to remove restrictions of the document


 

WatermarkPdfBackgroundParameterWatermarkPdfBackgroundInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

color

string

Color

The color of the text  Values: [Gray, Red, Blue]

fileContent

string(byte)

File Content

The content of the PDF document

line1

string

1st Line

First line of the watermark

line2

string

2nd Line

Second line of the watermark

line3

string

3rd Line

Third line of the watermark

margin

number

Margin

Page margin (in inches)

orientation

string

Orientation

The orientation of the text  Values: [Upward, Downward]

style

string

Style

The style of the watermark  Values: [Solid, Outline]

transparency

number

Transparency

Transparency level from 0 (opaque) to 100 (transparent)


 

WatermarkPdfCustomParameterWatermarkPdfCustomInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

File Content

The content of the PDF document

line1

string

1st Line

First line of the watermark

line2

string

2nd Line

Second line of the watermark

line3

string

3rd Line

Third line of the watermark

line4

string

4th Line

Fourth line of the watermark

line5

string

5th Line

Fifth line of the watermark

templateId

string

Template Id

The id of the custom template


 

WatermarkPdfOverlayParameterWatermarkPdfOverlayInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

color

string

Color

The color of the text  Values: [Gray, Red, Blue]

fileContent

string(byte)

File Content

The content of the PDF document

line1

string

1st Line

First line of the watermark

line2

string

2nd Line

Second line of the watermark

line3

string

3rd Line

Third line of the watermark

margin

number

Margin

Page margin (in inches)

orientation

string

Orientation

The orientation of the text  Values: [Upward, Downward]

style

string

Style

The style of the watermark  Values: [Solid, Outline]

transparency

number

Transparency

Transparency level from 0 (opaque) to 100 (transparent)