Encodian - PDF
Extensive features for the manipulation and creation of PDF documents
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 - US Department of Defense (DoD) |
Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Encodian Support |
URL | https://support.encodian.com |
support@encodian.com |
Connector Metadata | |
---|---|
Publisher | Encodian |
Website | https://www.encodian.com |
Privacy policy | https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy |
Categories | Content and Files;Collaboration |
The 'Encodian Flowr PDF' connector provide enterprise grade and simple to use Power Automate actions creating, merging, splitting and manipulating PDF documents.
The Encodian 'Flowr' PDF connector is supported by Power Automate, Azure Logic Apps and Power Apps.
An Encodian subscription is required to use the Encodian 'Flowr' PDF connector.
Complete the sign-up form to register for a 30-day trial and obtain an API Key
Click here for a step by step guide on how to create an Encodian connection in Power Automate
Contact Encodian Support to request assistance
Encodian action documentation can be found here, and example flows can be found here
Visit Encodian website for subscription plan pricing.
Once your 30-day trial expires, your Encodian subscription is automatically transitioned to Encodian's 'Free' subscription tier unless a paid plan has been purchased.
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Key | securestring | Get an API Key - https://www.encodian.com/apikey/ | True |
Region | string |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Add one or more attachments to the PDF file provided - https://support.encodian.com/hc/en-gb/articles/8087678202653
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Filename
|
fileName | string |
The filename of the file |
|
File Content
|
fileContent | byte |
The file content of the file |
Returns
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
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
HTML Header / Footer
|
htmlHeaderFooter | True | string |
The HTML to embed as a header or footer within the document |
Location
|
htmlHeaderFooterLocation | True | string |
Set whether the HTML should be added to the header, footer of both locations. |
Skip First Page
|
skipFirstPage | boolean |
Set whether to ignore the first page when the header / footers are added. |
|
Top Margin
|
marginTop | double |
Set the top margin value (mm). |
|
Bottom Margin
|
marginBottom | double |
Set the bottom margin value (mm). |
|
Right Margin
|
marginRight | double |
Set the right margin value (mm). |
|
Left Margin
|
marginLeft | double |
Set the left margin value (mm). |
|
Apply To
|
applyTo | string |
Set which pages within the PDF document to apply the HTML header or footer. |
|
Page Numbers
|
pageNumbers | array of integer |
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'. |
|
Ignore Page Numbers
|
ignorePageNumbers | array of integer |
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'. |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
finalOperation | boolean |
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 |
Returns
Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Watermark Filename
|
watermarkFilename | True | string |
The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file' |
Watermark File Content
|
watermarkFileContent | True | byte |
The content of the watermark image file |
Skip First Page
|
skipFirstPage | boolean |
Set whether to skip applying the watermark to the first page. |
|
Orientation
|
Orientation | string |
The orientation of the image to embed as a watermark within the document |
|
Opacity
|
Opacity | float |
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7 |
|
Watermark ID
|
watermarkId | integer |
Override and manually set an identifier for the applied watermark |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Watermark Filename
|
watermarkFilename | True | string |
The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file' |
Watermark File Content
|
watermarkFileContent | True | byte |
The content of the watermark image file |
Skip First Page
|
skipFirstPage | boolean |
Set whether to skip applying the watermark to the first page. |
|
Apply To
|
applyTo | string |
Set where in the document to apply the watermark. |
|
Page Numbers
|
pageNumbers | array of integer |
Specify the page numbers where the watermark should be applied, this only applies when the 'Apply To' property is set to 'Specific'. |
|
Ignore Page Numbers
|
ignorePageNumbers | array of integer |
Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'. |
|
Watermark Opacity
|
opacity | float |
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7 |
|
Rotation Angle
|
rotationAngle | float |
Set the rotation angle of the image watermark in degrees. |
|
Quality
|
quality | integer |
Set the quality of the image watermark from 1 to 100. |
|
X Offset
|
imageXOffset | float |
Set the X offset for positioning the watermark image on the page. |
|
Y Offset
|
imageYOffSet | float |
Set the Y offset for positioning the watermark image on the page. |
|
Scale
|
scale | float |
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%. |
|
Add to Background
|
addToBackground | boolean |
If set to 'true' the watermark image will be added to the background of the page. |
|
Watermark ID
|
watermarkId | integer |
Override and manually set an identifier for the applied watermark |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534-Add-Page-Numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Start Page
|
StartPage | integer |
Set which page to start adding page number(s) from. |
|
Start Number
|
StartNumber | integer |
Set the starting number for the page number(s) added to the document. |
|
Page Number Format
|
PageNumberFormat | string |
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. |
|
Horizontal Alignment
|
HorizontalAlignment | string |
Set the horizontal alignment of the page number(s) added to the document, the default value is Center. |
|
Custom Number Format
|
CustomNumberFormat | string |
Set a custom number format, for example '{0:00000}' would generate 00001 |
|
Margin - Top
|
MarginTop | double |
Set the top margin value (pt). The default value is set to 20. |
|
Margin - Right
|
MarginRight | double |
Set the right margin value(pt). The default value is set to 20. |
|
Margin - Bottom
|
MarginBottom | double |
Set the bottom margin value (pt). The default value is set to 20. |
|
Margin - Left
|
MarginLeft | double |
Set the left margin value (pt). The default value is set to 20. |
|
Add to Background
|
AddToBackground | boolean |
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
|
Font | string | ||
Font Colour
|
FontColour | string |
Set the HTML colour of the font, the default colour is set to #000000. |
|
Font Size
|
FontSize | integer |
Set the size of the font, the default size is set to 14. |
|
Opacity
|
Opacity | float |
Set the opacity of the page number(s), valid values range from 0.0+ to 1.0, the default value is 1.0 |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Text
|
Text | True | string |
The text to embed as a watermark within the document |
Skip First Page
|
skipFirstPage | boolean |
Set whether to skip applying the watermark to the first page. |
|
Orientation
|
Orientation | string |
The orientation of the text to embed as a watermark within the document |
|
Font
|
Font | string |
The font applied to the text watermark, the default font is set to Arial. |
|
Text Colour
|
TextColour | string |
The HTML colour applied to the text watermark, the default colour is set to #E81123. |
|
Text Size
|
TextSize | integer |
The size of the font applied to the text watermark, the default size is set to 34. |
|
Opacity
|
Opacity | float |
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0 |
|
Watermark ID
|
watermarkId | integer |
Override and manually set an identifier for the applied watermark |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Text
|
Text | True | string |
The text to embed as a watermark within the document. Add carriage return control characters (backslash r) to manually split text onto new lines. |
Skip First Page
|
skipFirstPage | boolean |
Set whether to skip applying the watermark to the first page. |
|
Apply To
|
ApplyTo | string |
Set where in the document to apply the watermark. |
|
Page Numbers
|
pageNumbers | array of integer |
Specify the page numbers where the watermark should be applied, this proporty only applies when the 'Apply To' property is set to 'Specific'. |
|
Ignore Page Numbers
|
ignorePageNumbers | array of integer |
Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'. |
|
Font
|
Font | string |
The font applied to the text watermark, the default font is set to Arial. |
|
Text Colour
|
TextColour | string |
The HTML colour applied to the text watermark, the default colour is set to #E81123. |
|
Text Size
|
TextSize | integer |
The size of the font applied to the text watermark, the default size is set to 34. |
|
Opacity
|
Opacity | float |
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0 |
|
Encoding Type
|
EncodingType | string |
The encoding type to apply to the text watermark. |
|
Horizontal Alignment
|
HorizontalAlignment | string |
Set the horizontal alignment of the watermark, the default value is Center. |
|
Vertical Alignment
|
VerticalAlignment | string |
Set the vertical alignment of the watermark, the default value is Center. |
|
Text Alignment
|
TextAlignment | string |
Set the text alignment of the watermark, the default value is Center. |
|
Rotation Angle
|
RotationAngle | float |
Set the rotation angle of the text watermark. |
|
Text Wrap
|
TextWrap | boolean |
Set whether the text watermark should automatically wrap. |
|
Text Wrap Row Width
|
TextWrapRowWidth | double |
Set the row width applied when the watermark is set to automatically wrap. |
|
Auto Scale
|
AutoScale | boolean |
Set the whether the text should be automatically sized to fit the width of the container. |
|
Auto Scale Text Width
|
AutoScaleWidth | double |
Set the width of the watermark container when automatic scaling is enabled. |
|
Auto Scale Text Height
|
AutoScaleHeight | double |
Set the height of the watermark container when automatic scaling is enabled. |
|
Text Layer
|
TextLayer | boolean |
Set whether the watermark should be added to the top or bottom layer. If 'True' the watermark is added to the bottom layer. |
|
Y Indent
|
YIndent | double |
Set the vertical watermark indent, starting from the bottom and overriding the VerticalAlignment property. |
|
X Indent
|
XIndent | double |
Set the horizontal watermark indent, starting from the left and overriding the HorizontalAlignment property. |
|
Apply as an Image
|
watermarkApplyAsImage | boolean |
Set whether the text watermark should be added as text or an image. |
|
Watermark ID
|
watermarkId | integer |
Override and manually set an identifier for the applied watermark |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
FileContent | byte |
The file content of the source PDF file |
|
Language
|
ocrLanguage | string |
Select the language used for OCR processing |
|
OCR Type
|
ocrType | string |
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 |
|
PDF/A Compliant
|
pdfaCompliance | boolean |
Set PDF/A Compliance option |
|
PDF/A Compliance Level
|
pdfaComplianceLevel | string |
Set the PDF/A Compliance Level, the default value is PDF_A_2A. |
|
Clean Operations
|
cleanUpType | string |
Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document. |
|
Rotate
|
AutoRotate | boolean |
Automatically detects orientation and rotates it so that the text on it is upright oriented |
|
Rotate Confidence Level
|
AutoRotateConfidenceLevel | integer |
Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60. |
|
Deskew
|
Deskew | boolean |
Detects the skew angle and rotates to remove that skew. |
|
Despeckle
|
Despeckle | boolean |
Automatically detects speckles and removes them. |
|
Adjust Brightness and Contrast
|
AdjustBrightnessContrast | boolean |
This action analyzes a document and automatically adjusts brightness and contrast based on the analysis. |
|
Remove Border
|
RemoveBorder | boolean |
Locates border pixels and removes the pixels from the document,this is disabled by default. |
|
Smooth Background
|
SmoothBackground | boolean |
This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise. |
|
Smooth Objects
|
SmoothObjects | boolean |
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. |
|
Remove Dot Shading
|
RemoveDotShading | boolean |
This action will remove shaded regions from bitonal documents. |
|
Image Detergent
|
ImageDetergent | boolean |
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. |
|
Average Filter
|
ApplyAverageFilter | boolean |
Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window. |
|
Remove Hole Punch
|
RemoveHolePunch | boolean |
Detects and removes hole punch marks from a bitonal document. |
|
Binarize
|
Binarize | boolean |
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. |
|
Remove Blank Pages
|
RemoveBlankPages | boolean |
Set whether blank pages should be removed from the PDF document. |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
- Body
- DtoResponseOcrPdf
Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857-Compress-PDF
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Compress Images
|
compressImages | boolean |
Contained images will be compressed, aligned to the value of the 'Image Quality' property |
|
Image Quality
|
imageQuality | integer |
Sets the quality for compressed images: 1 > 100 |
|
Max Resolution
|
maxResolution | integer |
Specifies the maximum resolution of images (dpi), if the image has a higher resolution it will be scaled dynamically. |
|
Resize Images
|
resizeImages | boolean |
If 'Compress Images' and 'Resize Images' are enabled, images will be resized where the image resolution is greater than the specified 'Max Resolution' property. |
|
Remove Private Info
|
removePrivateInfo | boolean |
Remove private information from the PDF document, i.e. page piece information. |
|
Remove Unused Objects
|
removeUnusedObjects | boolean |
Remove all unused objects (i.e. objects which do not have a reference) are removed from PDF document. |
|
Remove Unused Streams
|
removeUnusedStreams | boolean |
Remove all unused resources from the PDF document. |
|
Link Duplicate Streams
|
linkDuplicateStreams | boolean |
Link duplicate streams and store them as a single object. This can decrease document size in some cases (for example, where the same document was merged multiple times). |
|
Allow Reuse Page Content
|
allowReusePageContent | boolean |
Page contents will be reused when the PDF document is optimized for equal pages. |
|
Unembed Fonts
|
unembedFonts | boolean |
Remove all embedded fonts. The document size will decrease but the document may become unreadable if the correct font is not installed on the user's machine. |
|
Flatten Annotations
|
flattenAnnotations | boolean |
Flatten all annotations contained within the PDF document. |
|
Delete Annotations
|
deleteAnnotations | boolean |
Delete all annotations contained within the PDF document. |
|
Flatten Fields
|
flattenFields | boolean |
Flatten all fields contained within the PDF document (AcroForms only). |
Returns
Delete specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13690317983132/
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Start Page
|
StartPage | integer |
Set the page number to begin deleting pages from |
|
End Page
|
EndPage | integer |
Set the page number to stop deleting pages on. The default value is set to the last page of the PDF document provided |
|
Page Numbers
|
pageNumbers | string |
A comma separated list of page numbers of the pages to delete: 1,3,4 |
Returns
Extract attachments from the PDF provided - https://support.encodian.com/hc/en-gb/articles/9896328763932
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Returns
Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433-Get-PDF-Form-Data
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
FileContent | byte |
The file content of the source PDF file |
|
Operation ID
|
OperationId | string |
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 |
Returns
Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058-Extract-Images-from-PDF
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
FileContent | byte |
The file content of the source PDF file |
|
Name
|
Name | string |
The name assigned to the extracted image |
|
Lower Left X Coordinate
|
LowerLeftXCoordinate | True | double |
The number of points from the left edge of the page to the lower left corner of the rectangle image region |
Lower Left Y Coordinate
|
LowerLeftYCoordinate | True | double |
The number of points from the bottom edge of the page to the lower left corner of the rectangle image region |
Upper Right X Coordinate
|
UpperRightXCoordinate | True | double |
The number of points from the left edge of the page to the upper right corner of the rectangle image region |
Upper Right Y Coordinate
|
UpperRightYCoordinate | True | double |
The number of points from the bottom edge of the page to the upper right corner of the rectangle image region |
Page Number
|
PageNumber | True | integer |
The number of the page to extract the image from |
ImageType
|
ImageType | True | string | |
Extract Entire Page
|
ExtractEntirePage | True | boolean |
Extract the specified page as an image, ignoring and specificed coodinates |
Resolution
|
Resolution | True | integer |
The resolution of the extracted image |
Operation ID
|
operationId | string |
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 |
Returns
Extract PDF Metadata information from the PDF docucment provided (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358-Get-PDF-Document-Information
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Returns
Extract specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13958097048732
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Start Page
|
StartPage | integer |
Set the page number to begin extracting pages from |
|
End Page
|
EndPage | integer |
Set the page number to stop extracting pages on. The default value is set to the last page of the PDF document provided |
|
Page Numbers
|
pageNumbers | string |
A comma separated list of page numbers of the pages to extract: 1,3,4 |
Returns
Extract the text layer from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373-Get-PDF-Text-Layer
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
FileContent | byte |
The file content of the source PDF file |
|
Start Page
|
StartPage | integer |
Sets the page number to begin text layer extraction from. |
|
End Page
|
EndPage | integer |
Sets the page number to end text layer extraction from. The default value is set to the last page of the PDF document provided. |
|
Encoding Type
|
TextEncodingType | string |
The encoding type used for text extraction. |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353-Extract-Text-from-Regions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
FileContent | byte |
The file content of the source PDF file |
|
Name
|
Name | True | string |
The name assigned to the text region |
Lower Left X Coordinate
|
LowerLeftXCoordinate | True | double |
The number of points from the left edge of the page to the lower left corner of the rectangle text region |
Lower Left Y Coordinate
|
LowerLeftYCoordinate | True | double |
The number of points from the bottom edge of the page to the lower left corner of the rectangle text region |
Upper Right X Coordinate
|
UpperRightXCoordinate | True | double |
The number of points from the left edge of the page to the upper right corner of the rectangle text region |
Upper Right Y Coordinate
|
UpperRightYCoordinate | True | double |
The number of points from the bottom edge of the page to the upper right corner of the rectangle text region |
Page Number
|
Page Number | True | integer | |
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077-Fill-a-PDF-Form
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
FileContent | byte |
The file content of the source PDF file |
|
Form Data
|
formData | True | string |
The JSON data to populate with the PDF Form with. |
Returns
Flatten a PDF document or PDF form - https://support.encodian.com/hc/en-gb/articles/4416473033105
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Returns
Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354-Insert-HTML-to-PDF
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
HTML Data
|
htmlData | True | string |
The HTML which will be inserted into the PDF document |
HTML Insert Location
|
htmlInsertLocation | string |
Set where within the PDF provided, the HTML data should be inserted, the default value is Prepend. |
|
Page Number
|
htmlInsertLocationPage | integer |
Set a specific page location to insert the HTML data into. |
|
Page Orientation
|
pageOrientation | string |
Set page oprientation (Landscape or portrait). |
|
Page Size
|
pageSize | string |
Set the page size for the output PDF document, A4 is the default size. |
|
Viewport
|
viewPort | string |
Set the viewport used to render the HTML. |
|
Top Margin
|
MarginTop | double |
Set the top margin value (mm) |
|
Bottom Margin
|
MarginBottom | double |
Set the bottom margin value (mm) |
|
Right Margin
|
MarginRight | double |
Set the right margin value (mm) |
|
Left Margin
|
MarginLeft | double |
Set the left margin value (mm) |
|
Decode HTML Data
|
decodeHtmlData | boolean |
Set whether the data provided in the HTML Data field should be decoded. |
|
Operation ID
|
operationId | string |
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 |
Returns
Convert and merge an array of files to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213-Merge-document-array-to-PDF
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
PDF Filename
|
outputFilename | True | string |
The filename of the output PDF document |
Filename
|
fileName | string |
The filename of the file |
|
File Content
|
fileContent | byte |
The file content of the file |
|
Remove Markup
|
removeDocumentMarkup | boolean |
Set MS Office document comments and tracked changes removal option |
|
PDF/A Compliant
|
pdfaCompliance | boolean |
Set PDF/A Compliance option |
|
PDF/A Compliance Level
|
pdfaComplianceLevel | string |
Set the PDF/A Compliance Level, the default value is PDF_A_2A. |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Convert and merge the files provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173-Merge-documents-to-PDF
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
PDF Filename
|
outputFilename | True | string |
The filename of the output PDF document |
Filename
|
FileName | True | string |
The filename of the 1st source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
File Content
|
fileContent | True | byte |
The file content of the source file |
Filename 2
|
fileName2 | True | string |
The filename of the 2nd source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
File Content 2
|
fileContent2 | True | byte |
The file content of the 2nd source file |
Filename 3
|
fileName3 | string |
The filename of the 3rd source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 3
|
fileContent3 | byte |
The file content of the 3rd source file |
|
Filename 4
|
fileName4 | string |
The filename of the 4th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 4
|
fileContent4 | byte |
The file content of the 4th source file |
|
Filename 5
|
fileName5 | string |
The filename of the 5th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 5
|
fileContent5 | byte |
The file content of the 5th source file |
|
Filename 6
|
fileName6 | string |
The filename of the 6th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 6
|
fileContent6 | byte |
The file content of the 6th source file |
|
Filename 7
|
fileName7 | string |
The filename of the 7th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 7
|
fileContent7 | byte |
The file content of the 7th source file |
|
Filename 8
|
fileName8 | string |
The filename of the 8th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 8
|
fileContent8 | byte |
The file content of the 8th source file |
|
Filename 9
|
fileName9 | string |
The filename of the 9th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 9
|
fileContent9 | byte |
The file content of the 9th source file |
|
Filename 10
|
fileName10 | string |
The filename of the 10th source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content 10
|
fileContent10 | byte |
The file content of the 10th source file |
|
Remove Markup
|
removeDocumentMarkup | boolean |
Set MS Office document comments and tracked changes removal option |
|
PDF/A Compliant
|
pdfaCompliance | boolean |
Set PDF/A Compliance option |
|
PDF/A Compliance Level
|
pdfaComplianceLevel | string |
Set the PDF/A Compliance Level, the default value is PDF_A_2A. |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954-Redact-PDF-
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Text
|
SearchText | string |
The text to search for and apply the specified redaction to. |
|
Expression
|
SearchExpression | string |
Specify a regular expression to seek matching text and apply the specified redaction to. |
|
Redaction Colour
|
RedactionColour | string |
The redaction colour to apply to the redaction, the default value is #000000 (Black) |
|
Skip First Page
|
skipFirstPage | boolean |
Set whether to ignore the first page . |
|
Apply To
|
applyTo | string |
Set which pages within the document to redact |
|
Page Numbers
|
pageNumbers | array of integer |
Specify the page numbers to apply redaction to, this property only applies when the 'Apply To' property is set to 'Specific'. |
|
Ignore Page Numbers
|
ignorePageNumbers | array of integer |
Specify the page numbers not to apply redaction to, this property only applies when the 'Apply To' property is set to 'Specific'. |
|
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
- Body
- DtoResponseRedactPdf
Remove specified watermark(s) from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7751328751645
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
fileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Watermark IDs
|
watermarkIds | string |
Identifiers of the watermark(s) to remove. Multiple identifiers should be provided comma separated |
|
Watermark Type
|
removeWatermarkType | string |
Set the type of watermark to remove from the PDF document provided |
Returns
Repair a PDF document - https://support.encodian.com/hc/en-gb/articles/4418809972753
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Returns
- Body
- DtoResponseRepairPdf
Find and replace text contained within a PDF document with an image - https://support.encodian.com/hc/en-gb/articles/15083146797084
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
FileContent | True | byte |
The file content of the source file |
Search Text
|
SearchText | True | string |
The text to locate and replace with the specified image |
Image File Content
|
imageFileContent | True | byte |
The content of the image file |
Skip First Page
|
skipFirstPage | boolean |
Set whether to ignore the first page when searching for the text fragment |
|
Apply To
|
applyTo | string |
Set which pages within the document to search for the text fragment |
|
Page Numbers
|
pageNumbers | string |
Specify the page numbers to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'. |
|
Ignore Page Numbers
|
pageNumbersIgnore | string |
Specify the page numbers not to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'. |
Returns
Resize a PDF document - https://support.encodian.com/hc/en-gb/articles/12292028562588
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
FileContent | True | byte |
The file content of the source PDF file |
Page Size
|
pageSize | True | string |
Set the new page size to be applied to the PDF file provided |
Start Page
|
startPage | integer |
Set the page number to begin resizing from |
|
End Page
|
EndPage | integer |
Set the page number to end resizing on |
|
Width
|
customWidth | float |
Set a custom width, only applied when the 'Custom' page size has been set |
|
Height
|
customHeight | float |
Set a custom height, only applied when the 'Custom' page size has been set |
|
Padding Bottom
|
paddingBottom | double |
Set bottom padding of the PDF document by percentage (default is 0%) |
|
Padding Top
|
paddingTop | double |
Set top padding of the PDF document by percentage (default is 0%) |
|
Padding Left
|
paddingLeft | double |
Set left padding of the PDF document by percentage (default is 0%) |
|
Padding Right
|
paddingRight | double |
Set right padding of the PDF document by percentage (default is 0%) |
Returns
- Body
- DtoResponseResizePdf
Rotate specified pages of the PDF document provided - https://support.encodian.com/hc/en-gb/articles/14798407011356
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Rotation
|
pdfPageRotation | True | string |
Set the angle of the page rotation: 90, 180, 270, 360 |
Start Page
|
startPage | integer |
Set the page number to begin rotating pages from |
|
End Page
|
endPage | integer |
Set the page number to stop rotating pages on. The default value is set to the last page of the PDF document provided |
|
Page Numbers
|
pageNumbers | string |
A comma separated list of page numbers of the pages to rotate: 1,3,4 |
Returns
Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
View Password
|
userPassword | string |
Protect view access to the document |
|
Edit Password
|
adminPassword | string |
Protect edit access to the document |
|
Privileges
|
pdfPrivileges | string |
Set the privileges assigned to the PDF document |
|
Cryptographic Algorithm
|
cryptoAlgorithm | string |
Set the cryptographic algorithm |
|
Privilege - Assembly
|
pdfPrivilegesAllowAssembly | boolean |
Set whether document assembly is permitted |
|
Privilege - Copy
|
pdfPrivilegesAllowCopy | boolean |
Set whether copy is permitted |
|
Privilege - Fill in Forms
|
pdfPrivilegesAllowFillIn | boolean |
Set whether 'Fill in forms' is permitted |
|
Privilege - Print
|
pdfPrivilegesAllowPrint | boolean |
Set whether print is permitted |
|
Privilege - Screen Readers
|
pdfPrivilegesAllowScreenReaders | boolean |
Set whether screen reading is permitted |
|
Privilege - Modify Contents
|
pdfPrivilegesAllowModifyContents | boolean |
Set whether document content modification is permitted |
|
Privilege - Modify Annotations
|
pdfPrivilegesAllowModifyAnnotations | boolean |
Set whether annotation modification is permitted |
|
Operation ID
|
operationId | string |
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 |
Returns
- Body
- DtoResponseSecurePdf
Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094-Set-PDF-Document-Privileges
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Privileges
|
pdfPrivileges | string |
Set the privileges assigned to the PDF document |
|
Assembly
|
pdfPrivilegesAllowAssembly | boolean | ||
Copy
|
pdfPrivilegesAllowCopy | boolean | ||
Fill in Forms
|
pdfPrivilegesAllowFillIn | boolean | ||
Print
|
pdfPrivilegesAllowPrint | boolean | ||
Screen Readers
|
pdfPrivilegesAllowScreenReaders | boolean | ||
Modify Contents
|
pdfPrivilegesAllowModifyContents | boolean | ||
Modify Annotations
|
pdfPrivilegesAllowModifyAnnotations | boolean | ||
Operation ID
|
operationId | string |
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 |
|
Return File
|
FinalOperation | boolean |
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 |
Returns
- Body
- DtoResponseSecurePdf
Apply a digital signature to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7117159708189
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Certificate Type
|
certificateTypeParameter | string |
Set the certificate type |
|
operation
|
operation | dynamic |
Request object, refer to schema definition: DtoSignPdf |
Returns
- Body
- DtoResponseSignPdf
Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277-Split-PDF
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
fileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the PDF file |
|
Split by Type
|
splitByType | True | string |
Select how to split the file |
Split Configuration
|
splitConfiguration | True | string |
Provide a split configuration |
Enable Bookmark Filenames
|
enableBookmarkFilenames | boolean |
Append the bookmark name value to the filename when splitting by 'BookmarkLevel' |
|
Operation ID
|
operationId | string |
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 |
Returns
Split a PDF Document by Barcode, returning multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360013629457-Split-PDF-by-Barcode
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
fileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the PDF file |
|
Barcode Value
|
splitPdfByBarcodeValue | string |
Optional - Specify a value for detecting a specific barcode(s) |
|
Split Configuration
|
splitPdfByBarcodeType | True | string |
Select a split configuration |
Split Action
|
splitPdfByBarcodeAction | True | string |
Select a split action, whether to split before, after or remove the page containing the split value. |
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
Append Barcode Value
|
appendBarcodeValue | boolean |
Optional - Specify whether the value for each barcode found is appended to the start of the filename |
Returns
Split a PDF Document by text into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360012726397-Split-PDF-by-Text
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
fileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the PDF file |
|
Split Value
|
splitValue | True | string |
Provide the split value used to perform the split operation |
Is Expression
|
isExpression | boolean |
Set whether the 'Split Value' value should be evaluted as a regular expression, the default value is 'false' |
|
Prefix Filename
|
prefixFilename | boolean |
Set whether the expression value should be used within the output filename. |
|
Split Configuration
|
splitPdfByTextType | True | string |
Select a split configuration |
Split Action
|
splitAction | True | string |
Select a split action, whether to split before, after or remove the page containing the split value. |
Returns
Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237-Unlock-PDF-Document
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
FileName | True | string |
The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
File Content
|
fileContent | byte |
The file content of the source PDF file |
|
Password
|
password | True | string |
The password to use to unlock the PDF Document |
Operation ID
|
operationId | string |
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 |
Returns
- Body
- DtoResponseUnlockPdf
Validate whether a text layer is present within the PDF document provided - https://support.encodian.com/hc/en-gb/articles/14453068327196
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Content
|
fileContent | True | byte |
The file content of the source PDF file |
Level
|
level | string |
Set whether each page should be checked for the presence of a text layer or the document as a single entity |
Returns
Name | Path | Type | Description |
---|---|---|---|
Filename
|
fileName | string |
The filename of the file |
File Content
|
fileContent | byte |
The file content of the file |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Watermark ID
|
watermarkId | integer |
The identifier applied to the watermark |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Watermark ID
|
watermarkId | integer |
The identifier applied to the watermark |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Watermark ID
|
watermarkId | integer |
The identifier applied to the watermark |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Watermark ID
|
watermarkId | integer |
The identifier applied to the watermark |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Documents
|
documents | array of DocumentArray |
The array of documents extracted from the source PDF |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Images
|
Images | array of DocumentArray |
The array of images extracted from the PDF |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Simple Text Region Results
|
TextRegionResultsSimple | string |
A collection of text region results in simplified format |
Text Region Results
|
TextRegionResults | array of TextRegionResult |
A collection of text region results. |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Number of Pages
|
NumberOfPages | integer |
The number of pages in the supplied PDF document |
File Size (MBs)
|
FileSize | string |
The size of the supplied PDF document in MBs |
Author
|
Author | string |
The author of the PDF as set in the PDF properties |
Creator
|
Creator | string |
The creator of the PDF as set in the PDF properties |
Producer
|
Producer | string |
The producer of the PDF as set in the PDF properties |
Title
|
Title | string |
The title of the PDF as set in the PDF properties |
Subject
|
Subject | string |
The subject of the PDF as set in the PDF properties |
Keywords
|
Keywords | string |
The keywords of the PDF as set in the PDF properties |
Width
|
Width | double |
The width of the PDF Document (Points) |
Height
|
Height | double |
The height of the PDF Document (Points) |
Orientation
|
Orientation | string |
The orientation of the PDF Document |
Created Date
|
CreatedDate | date-time |
The creation date of the PDF as set in the PDF properties |
Modified Date
|
ModifiedDate | date-time |
The last modified date of the PDF as set in the PDF properties |
PDF Format
|
PDFFormat | string |
The format of the PDF |
Is PDFA Compliant
|
IsPDFACompliant | boolean |
Indicates whether the supplied PDF complies with the PDF/a standard |
Is PDFUA Compliant
|
IsPDFUACompliant | boolean |
Indicates whether the supplied PDF complies with the PDF/ua standard |
Is Encrypted
|
IsEncrypted | boolean |
Indicates whether the supplied PDF complies is encrypted |
Has Text Layer
|
HasTextLayer | boolean |
Indicates whether the supplied PDF has a text layer |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Form Data
|
Form Data | string | |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Text Layer
|
TextLayer | string |
The text layer extracted from the PDF document. |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Documents
|
documents | array of DocumentArray |
The array of documents to be processed |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Documents
|
documents | array of DocumentArray |
The array of documents split from the source PDF |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Documents
|
documents | array of DocumentArray |
The array of documents split from the source PDF |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
Valid Text Layer
|
valid | boolean |
The result of the text layer validation |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Name
|
Name | string |
The name assigned to the text region |
Text
|
Text | string |
The text extracted via OCR from the specified region |
Page Number
|
PageNumber | integer |
The number of the page the text was extracted from |