Plumsail Documents

Plumsail Documents

The API allows you to create documents from templates (DOCX or HTML file), convert it to PDF and many more. Visit https://plumsail.com/documents for more information

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection 1200 60 seconds

Creating a connection

To connect your account, you will need the following information:

API Key
securestring
The API Key for this api

Actions

Add a watermark to PDF

Adds a text watermark to PDF

Required Parameters

Type
string
The type of the watermark
request
dynamic

Returns

Convert DOCX to PDF

It takes DOCX document and converts it to PDF

Required Parameters

Document content
byte
Content of document that should be converted to PDF

Returns

Convert HTML to PDF

It takes HTML markup, renders it and converts to PDF document

Required Parameters

Source HTML
byte
HTML markup that should be converted to PDF

Optional Parameters

Header HTML
string
HTML markup that should be added as a header
Footer HTML
string
HTML markup that should be added as a footer
Papper Size
string
Can be A4,A5 etc...
Orientation
string
Portrait vs Landscape
Margins
string
The page margins that separated ' '. Way of setting values as in CSS

Returns

Convert PDF to Image

It takes PDF document and converts it to Image (jpeg, png, gif, bmp)

Required Parameters

Content of the PDF document
byte
Raw content of PDF document

Optional Parameters

Image Format
string
The format of the result image
Start Page
integer
The first page to start extraction (1 based)
End Page
integer
The last page to extract (inclusive)
Pages
string
Page numbers for extraction separated by ';' (only this pages will be extracted)
DPI
integer
The resolution of the result image
Password
string
Password to decrypt document

Returns

Convert XLSX to PDF

It takes XLSX document and converts it to PDF

Required Parameters

Document content
byte
Content of document that should be converted to PDF

Returns

Result file
binary

Create DOCX document from template

Created Word DOCX document from template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/docx/index.html

Required Parameters

Document content
binary
Content of the template

Optional Parameters

Locale
string
The locale that will be applyed to the document

Returns

Result file
binary

Create HTML from template

It takes input HTML template string or file and replaces special {{Tokens}} by specified data. We use Mustache framework for templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html

Required Parameters

Source HTML
byte
Text HTML template or HTML file template

Optional Parameters

Locale
string
The locale that will be applyed to the document

Returns

Create XLSX document from template

Created Excel XLSX document from template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/xlsx/index.html

Required Parameters

Document content
binary
Content of the template

Optional Parameters

Locale
string
The locale that will be applyed to the document

Returns

Result file
binary

Extract text from PDF document

It takes PDF document and extracts text to Raw or HTML format

Required Parameters

Content of the PDF document
byte
Raw content of PDF document

Optional Parameters

Result Type
string
Raw or HTML
Start Page
integer
The first page to start extraction (1 based)
End Page
integer
The last page to extract (inclusive)
Password
string
Password to decrypt document

Returns

Fill in PDF Form

Filling out PDF form by provided data

Required Parameters

Content of the PDF document
byte
Raw content of PDF document
JSON data
string
The data that will be used to fill out the form

Returns

Fill merge fields in DOCX document

It takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document

Required Parameters

DOCX document content
byte
Raw content of docx document template. MergeField names should be the same as keys in template data

Returns

Get Form from PDF

Returns fillable form data from PDF as JSON

Required Parameters

Content of the PDF document
byte
Raw content of PDF document

Optional Parameters

Password
string
Password to decrypt document

Returns

Get Form from PDF

Merge PDF

It takes an array of PDF documents and merge it

Optional Parameters

Content of PDF documents
binary

Returns

Result file
binary

Protect PDF document

Adds passwords, copy-, printing-, and other protections to PDF file

Required Parameters

Content of the PDF document
byte
Raw content of PDF document
Enable printing
boolean
Protect the PDF file from being printed out
Enable modification
boolean
Protect the PDF file from being edited
Enable extract data
boolean
Allows extraction of text, images, and other media from the PDF file
Enable annotate
boolean
Allows annotation (e.g. comments, form fill-in, signing) of the PDF file

Optional Parameters

PDF owner password
string
Enter an optional owner password here. This password can be used to disable document restrictions
PDF user password
string
Enter an optional user password here. Each time an user opens the PDF he will be asked for this password. If you do not want a password prompt then leave this field blank
Password
string
Password to decrypt document

Returns

Regular Expression Match

Searches an input string for all occurrences of a regular expression and returns all the matches. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Required Parameters

Pattern
string
Regular expression pattern
Text
string
String to search for matches

Returns

The outputs of this operation are dynamic.

Regular Expression Replace

In a specified input string, replaces all strings that match a regular expression pattern with a specified replacement string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Required Parameters

Replacement
string
Replacement string
Pattern
string
Regular expression pattern
Text
string
String to search for matches

Returns

Regular Expression Test

Indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

Required Parameters

Pattern
string
Regular expression pattern
Text
string
String to search for matches

Returns

Split PDF

It takes PDF document and split it

Required Parameters

Content of the PDF document
byte
Raw content of PDF document

Optional Parameters

Start Page
integer
The first page to start split (1 based)
End Page
integer
The last page to split (inclusive)
Split At Page
integer
Number of pages per partition
Password
string
Password to decrypt document

Returns

Definitions

DocumentProcessingResponse

Result file
byte
Raw content of the result file

ApplyHtmlTemplateResponse

Result HTML
string
Raw HTML result

DocumentsArrayResponse

Result files
array of byte
The array of raw content of result files

StringResultResponse

Result
string

BooleanResultResponse

IsSuccess
boolean