Encodian
Enhanced document format conversion, OCR, watermarking, data extraction, redaction + much more.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - 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 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 for Microsoft Power Automate' connector provides enterprise grade and simple to use Flow actions which provide a wide array of document and image centric capabilities covering; document format conversion, document merging and splitting, watermarks, OCR, zonal data extraction, PDF form data extraction and fill, image and text layer extraction, HTML conversion, CSV parsing, regex search, document security, ZIP file creation, document redaction, image clean-up, image compression and resize, image format conversion, barcode creation and reading, + lots more.
Prerequisites
An Encodian subscription is required to use the Encodian Power Automate connector.
Visit https://www.encodian.com/pricing for subscription plan details.
How to get started
Visit https://www.encodian.com/apikey to register for a 30-day trial and gain instant access
Once your 30-day trial expires, your Encodian subscription is automatically transitioned to Encodian's Free subscription plan unless a paid plan has been purchased.
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 is located here, and example flows can be found here
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | Get an API Key - https://www.encodian.com/apikey/ | True |
| Region | string |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 600 | 60 seconds |
Actions
Add Attachments to PDF
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 HTML Header or Footer to PDF
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 Image Watermark to Image
Add an image watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/8967068141597
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
filename | True | string |
The filename of the source file, the file extension is mandatory: 'file.png' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Watermark Filename
|
watermarkFilename | True | string |
The filename of the watermark image file, the file extension is mandatory: 'file.png' and not 'file' |
|
Watermark File Content
|
watermarkFileContent | True | byte |
The content of the watermark image file |
|
Watermark Position
|
watermarkPosition | True | string |
The position of the image watermark on the image provided |
|
Y Offset
|
imageYOffSet | integer |
Set the vertical watermark offset in pixels, starting from the top of the image. This setting will only apply when the 'Watermark Position' property is set to 'Custom'. |
|
|
X Offset
|
imageXOffset | integer |
Set the horizontal watermark offset in pixels, starting from the left of the image. This setting will only apply when the 'Watermark Position' property is set to 'Custom'. |
|
|
Rotation Angle
|
rotationAngle | float |
Set the rotation angle of the image watermark in degrees |
|
|
Opacity
|
opacity | float |
The opacity of the image watermark, valid values range from 0.0+ to 1.0, the default value is 0.7 |
Returns
Add Image Watermark to PDF
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 Image Watermark to PDF (Advanced)
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 Image Watermark to Word
Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word 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 |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
|
|
Scale
|
scale | double |
Set the scale factor expressed as a fraction of the image. The default value is 1, valid values range from 0 to 65.5 |
|
|
Semi Transparent
|
isSemiTransparent | boolean |
Set whether the text watermark should be semi transparent |
Returns
Add Page Numbers
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 Rows to Excel
Add rows to the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11551842583581
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Excel file |
|
Row Data
|
jsonData | True | string |
The JSON dataset to be processed and added as rows to the Excel file provided |
|
Insert from Row
|
insertionRow | integer |
The row number after which the data provided will be inserted |
|
|
Insert from Column
|
insertionColumn | integer |
The column number after which the data provided will be inserted |
|
|
Worksheet Name
|
worksheetName | string |
Specify the name of a specific worksheet |
|
|
Convert Numeric and Date
|
convertNumericAndDate | boolean |
Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date' |
|
|
Date Format
|
dateFormat | string |
Set the date and time format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings |
|
|
Numeric Format
|
numericFormat | string |
Set the numeric format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings |
|
|
Ignore Attribute Titles
|
ignoreAttributeTitles | boolean |
Ignores titles of JSON attributes when converting JSON to Excel |
|
|
Ignore Null Values
|
ignoreNulls | boolean |
Ignore JSON properties which contain null values. |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Add Text Watermark to Image
Add a Text Watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/360013560398-Add-Text-Watermark-To-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source image file, the file extension is mandatory: 'file.jpg' and not 'file' |
|
File Content
|
FileContent | byte |
The file content of the source image file |
|
|
Text
|
Text | True | string |
The text to embed as a watermark within the image |
|
Watermark Position
|
WatermarkPosition | string |
The position of the text to embed as a watermark within the image |
|
|
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 10. |
Returns
Add Text Watermark to PDF
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 Text Watermark to PDF (Advanced)
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
Add Text Watermark to Word
Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Text
|
text | True | string |
The text to embed as a watermark within the Microsoft Word file |
|
Orientation
|
orientation | string |
Set the orientation of the text watermark |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
|
|
Font
|
font | string |
Set the font type applied to the text watermark, the default font is set to Calibri |
|
|
Text Colour
|
textColour | string |
Set the HTML colour applied to the text watermark, the default colour is set to #808080 (Grey) |
|
|
Text Size
|
textSize | integer |
Set the font size applied to the text watermark, The default size is set to 0 (Auto) |
|
|
Semi Transparent
|
isSemiTransparent | boolean |
Set whether the text watermark should be semi transparent |
Returns
Add to Archive (ZIP)
Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
outputFilename | True | string |
The filename of the output ZIP package |
|
Filename
|
fileName | string |
The filename of the file |
|
|
File Content
|
fileContent | byte |
The file content of the file |
|
|
Password
|
Password | string |
Set a password to protect and encrypt the archive (ZIP file) |
|
|
Encryption
|
encryption | string |
Set the encryption level which will be applied to a password protected archive (ZIP file) |
|
|
Encoding
|
encoding | string |
Set the encoding type. |
Returns
Compare Word Documents
Compare differences between Microsoft Word and PDF Documents - https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content - One
|
fileContentOne | True | byte |
The file content of the first Microsoft Word or PDF file to compare. |
|
File Content - Two
|
fileContentTwo | True | byte |
The file content of the second Microsoft Word or PDF file to compare. |
|
Author
|
author | string |
Set the name of the author used to denote differences in the output document. |
|
|
Ignore Formatting
|
ignoreFormatting | boolean |
Specifies whether to ignore document formatting differences |
|
|
Case Insensitive
|
caseInsensitive | boolean |
Specifies whether to compare differences in documents as case insensitive |
|
|
Ignore Comments
|
ignoreComments | boolean |
Specifies whether to compare differences in comments |
|
|
Ignore Tables
|
ignoreTables | boolean |
Specifies whether to compare the differences in data contained in tables |
|
|
Ignore Fields
|
ignoreFields | boolean |
Specifies whether to compare differences in fields. By default fields |
|
|
Ignore Footnotes
|
ignoreFootnotes | boolean |
Specifies whether to compare differences in footnotes and endnotes |
|
|
Ignore Textboxes
|
ignoreTextboxes | boolean |
Specifies whether to compare differences in the data contained within text boxes |
|
|
Ignore Headers and Footers
|
ignoreHeadersAndFooters | boolean |
Specifies whether to compare differences in the data contained within headers and footers |
Returns
Compress an Image
Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513-Compress-an-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Image Type
|
imageType | True | string |
Select the image file format. |
Returns
Compress PDF
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
Compress PowerPoint
Compress the PowerPoint file provided - https://support.encodian.com/hc/en-gb/articles/7621965500189
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.pptx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Image Compression Rate
|
compressionRate | string |
Sets the compression rate for images. A higher compression rate generates smaller file sizes. |
|
|
Remove Embedded Fonts
|
compressEmbeddedFonts | boolean |
Compresses the file provided by removing unused characters from embedded fonts |
|
|
Remove Unused Layout Slides
|
removeUnusedLayoutSlides | boolean |
Compresses the file provided by removing unused layout slides |
|
|
Remove Unused Master Slides
|
removeUnusedMasterSlides | boolean |
Compresses the file provided by removing unused master slides |
|
|
Resize Images to Frame Size
|
resizeImagesToFrameSize | boolean |
Resizes the images to fit the frame in which they are displayed |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Convert CAD
Convert CAD files to another document format - https://support.encodian.com/hc/en-gb/articles/4542607350417
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Output Format
|
outputFormatParameter | string |
Set the output file type |
|
|
conversion
|
conversion | dynamic |
Request object, refer to schema definition: DtoConvertCad |
Returns
Convert Email Message
Convert an email to PDF - https://support.encodian.com/hc/en-gb/articles/360011566298-Convert-Mail-Message
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.msg' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Merge Attachments
|
mergeAttachments | boolean |
Set whether attachments should be automatically converted and merged with the output.pdf |
|
|
Generate Bookmarks
|
generateBookmarks | boolean |
Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF. |
|
|
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. |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Convert Excel
Convert Microsoft Excel documents to another document format - https://support.encodian.com/hc/en-gb/articles/360011804178-Convert-Excel
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Output Format
|
outputFormatParameter | string |
Set the output file type |
|
|
conversion
|
conversion | dynamic |
Request object, refer to schema definition: DtoConvertExcel |
Returns
Convert HTML to PDF
Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154-Convert-HTML-to-PDF
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF Filename
|
outputFilename | True | string |
The filename of the output PDF document |
|
File Content
|
fileContent | byte |
Optional - The file content of the source HTML file. |
|
|
HTML Data
|
htmlData | string |
Optional - The HTML which will be converted to a PDF document |
|
|
HTML Url
|
htmlUrl | string |
Optional - The web address to the web page which will be converted to a PDF document |
|
|
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 (pixels) |
|
|
Bottom Margin
|
MarginBottom | double |
Set the bottom margin value (pixels) |
|
|
Right Margin
|
MarginRight | double |
Set the right margin value (pixels) |
|
|
Left Margin
|
MarginLeft | double |
Set the left margin value (pixels) |
|
|
Enable Bookmarks
|
enableBookmarks | boolean |
Enable or disable auto creation of PDF bookmarks. |
|
|
Enable JavaScript
|
enableJavaScript | boolean |
Enable or disable javascript. |
|
|
Enable Hyperlinks
|
enableHyperlinks | boolean |
Enable or disable hyperlinks. |
|
|
Create PDF Form
|
createPdfForm | boolean |
Set whether the HTML content should be converted to a PDF form. |
|
|
Decode HTML Data
|
decodeHtmlData | boolean |
Set whether the data provided in the HTML Data field should be decoded. |
|
|
CSS Type
|
cssType | string |
Set whether the standard or print style sheets should be used for HTML conversion. |
|
|
Repeat Table Header
|
repeatTableHeader | boolean |
Set whether to repeat the table header on every page break. The default value is true |
|
|
Repeat Table Footer
|
repeatTableFooter | boolean |
Set whether to repeat the table footer on every page break. The default value is true |
|
|
Split Images
|
splitImages | boolean |
Set whether to split images |
|
|
Split Text Lines
|
splitTextLines | boolean |
Set whether to split text lines |
|
|
Delay
|
delay | integer |
Set the delay in milliseconds between the HTML being received and the conversion to allo time for JavaScript to load. |
|
|
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
- DtoResponseHtmlToPdf
Convert HTML to Word
Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213-Convert-HTML-to-Word
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
outputFilename | True | string |
The filename of the output DOCX document |
|
File Content
|
fileContent | byte |
Optional - The file content of the source HTML file. |
|
|
HTML Data
|
htmlData | string |
Optional - The HTML which will be converted to a Word document |
|
|
HTML Url
|
htmlUrl | string |
Optional - The web address to the web page which will be converted to a Word document |
|
|
Page Orientation
|
pageOrientation | string |
Set page oprientation (Landscape or portrait). |
|
|
Page Size
|
pageSize | string |
Set the page size for the output Word document, A4 is the default size. |
|
|
Decode HTML Data
|
decodeHtmlData | boolean |
Set whether the data provided in the HTML Data field should be decoded. |
|
|
Encoding
|
encoding | string |
Set the encoding type for the HTML. |
|
|
Top Margin
|
MarginTop | double |
Set the top margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. |
|
|
Bottom Margin
|
MarginBottom | double |
Set the bottom margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. |
|
|
Right Margin
|
MarginRight | double |
Set the right margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. |
|
|
Left Margin
|
MarginLeft | double |
Set the left margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. |
|
|
Compliance Level
|
WordComplianceLevel | string |
Set the compliance level applied to the HTML source during conversion |
Returns
Convert Image Format
Convert the format of the image provided - https://support.encodian.com/hc/en-gb/articles/360006617857-Convert-Image-Format
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Current Image Format
|
currentImageFormat | True | string |
Select the current image file format. |
|
New Image Format
|
newImageFormat | True | string |
Select the new image file format. |
Returns
Convert JSON to Excel
Convert JSON into a Microsft Excel file - https://support.encodian.com/hc/en-gb/articles/7690520790045
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Output Filename
|
outputFilename | True | string |
The filename of the output document |
|
File Content
|
fileContent | byte |
Optional - The file content of the source JSON file. |
|
|
JSON Data
|
jsonData | string |
Optional - The JSON data to be converted to an Excel document |
|
|
First Row
|
row | integer |
The first row to be written to |
|
|
First Column
|
column | integer |
The first column to be written to |
|
|
Worksheet Name
|
worksheetName | string |
The name of the worksheet that the JSON data is added to |
|
|
Convert Numeric and Date
|
convertNumericAndDate | boolean |
Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date' |
|
|
Date Format
|
dateFormat | string |
Set the date and time format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings |
|
|
Numeric Format
|
numericFormat | string |
Set the numeric format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings |
|
|
Ignore Null Values
|
ignoreNulls | boolean |
Ignore JSON properties which contain null values. |
|
|
Title - Font Colour
|
titleFontColour | string |
Set the title font color |
|
|
Title - Font Bold
|
isTitleBold | boolean |
Set the title to bold |
|
|
Title - Wrap Text
|
isTitleTextWrapped | boolean |
Set whether a titles text is wrapped |
|
|
Ignore Attribute Titles
|
ignoreAttributeTitles | boolean |
Ignores titles of JSON attributes when converting JSON to Excel |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Convert PDF to Images
Convert a PDF document into an array of images (PNG or JPG) - https://support.encodian.com/hc/en-gb/articles/4418101623441
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source PDF file. |
|
Image Format
|
imageFormat | True | string |
Set the format for the output image files |
|
Filename Prefix
|
filenamePrefix | string |
The prefix filename for the output image files |
|
|
Resolution
|
resolution | integer |
Set the image resolution |
Returns
Convert PDF to JPG
Convert a PDF document to a JPG - https://support.encodian.com/hc/en-gb/articles/11096881397277
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source PDF file. |
|
Filename
|
outputFilename | string |
The filename of the output JPG file |
|
|
Image Quality
|
imageQuality | integer |
Set the image quality between 1 and 100 |
|
|
Resolution
|
resolution | integer |
Set the image resolution |
|
|
Resolution Unit
|
resolutionUnit | string |
Set the resolution unit |
|
|
Compression Color Mode
|
compressionColourMode | string |
Set the compression color mode |
|
|
Compression Type
|
compressionType | string |
Set the compression type |
|
|
Enhanced Compression
|
enhancedCompression | boolean |
Apply enhanced compression which will further reduce the image size for some conversion configurations |
Returns
Convert PDF to PDFA
Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413-Convert-PDF-to-PDFA
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 |
|
|
PDF/A Compliance Level
|
pdfaComplianceLevel | string |
Set the PDF/A Compliance Level, the default value is PDF_A_2A. |
|
|
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
Convert PDF to PNG
Convert a PDF document to a PNG - https://support.encodian.com/hc/en-gb/articles/10086003836701
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source PDF file. |
|
Filename
|
outputFilename | string |
The filename of the output PNG file |
|
|
Progressive
|
progressive | boolean |
Set progressive image rendering |
|
|
Compression
|
compression | string |
Set the compression level |
|
|
Resolution
|
resolution | integer |
Set the image resolution |
|
|
Bit Depth
|
bitDepth | integer |
Set the bit depth |
Returns
Convert PDF to TIFF
Convert a PDF document to TIFF (tiff) format - https://support.encodian.com/hc/en-gb/articles/4418024925457
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source PDF file. |
|
Filename
|
outputFilename | string |
The filename of the output TIFF file |
|
|
Resolution
|
resolution | integer |
Set the image resolution |
|
|
Compression
|
tiffCompression | string |
Set the compression type |
|
|
Page Orientation
|
pageOrientation | string |
Set the page orientation of the TIFF file |
|
|
Skip Blank Pages
|
skipBlankPages | boolean |
Set whether blank pages should be skipped upon conversion |
Returns
Convert PDF to Word
Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294-Convert-PDF-to-Word
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
outputFilename | True | string |
The filename of the output DOCX document |
|
File Content
|
fileContent | byte |
The file content of the source PDF file. |
|
|
Conversion Mode
|
mode | string | ||
|
Recognize Bullets
|
recognizeBullets | boolean |
Returns
Convert PowerPoint
Convert Microsoft PowerPoint documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015879777-Convert-PowerPoint
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Output Format
|
outputFormatParameter | string |
Set the output file type |
|
|
conversion
|
conversion | dynamic |
Request object, refer to schema definition: DtoConvertPowerPoint |
Returns
Convert Text to PDF
Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054-Convert-Text-to-PDF
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PDF Filename
|
outputFilename | True | string |
The filename of the output PDF document |
|
File Content
|
fileContent | byte |
Optional - Please provide either The file content of the source file and source filename or text data. |
|
|
Text Data
|
textData | string |
Optional - Please provide either the text data which will be converted to a PDF document or The file content of the source file and source filename. |
|
|
Encoding Type
|
textEncodingType | string |
The encoding type used for text conversion. |
|
|
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
- DtoResponseTextToPdf
Convert to PDF
Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574-Convert-to-PDF
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
PDF Filename
|
outputFilename | True | string |
The filename of the output PDF document |
|
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. |
|
|
Generate Bookmarks
|
GenerateBookmarks | boolean |
Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF. |
|
|
Culture Name
|
CultureName | string |
Change the thread culture used to process the request. |
|
|
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 Visio
Convert Microsoft Visio documents to another document format - https://support.encodian.com/hc/en-gb/articles/5306216347665
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Output Format
|
outputFormatParameter | string |
Set the output file type |
|
|
conversion
|
conversion | dynamic |
Request object, refer to schema definition: DtoConvertVisio |
Returns
Convert Word
Convert Microsoft Word documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015616117-Convert-Word
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Output Format
|
outputFormatParameter | string |
Set the output file type |
|
|
conversion
|
conversion | dynamic |
Request object, refer to schema definition: DtoConvertWord |
Returns
Convert Word to PDF Form
Convert the Word document provided (Legacy Form Controls Only) to a PDF form document. - https://support.encodian.com/hc/en-gb/articles/360012307133-Convert-Word-to-PDF-Form
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.doc' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
PDF Filename
|
outputFilename | True | string |
The filename of the output PDF document |
|
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
Create Barcode
Create a Barcode in the specified image format - https://support.encodian.com/hc/en-gb/articles/360006165457-Create-Barcode
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Barcode Type
|
barcodeTypeParameter | string |
Set the barcode type |
|
|
operation
|
operation | dynamic |
Request object, refer to schema definition: DtoResponseCreateBarcode |
Returns
Create QR Code
Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237-Create-QR-Code
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Barcode Data
|
barcodeData | True | string |
Set the string value used to generate the QR barcode. |
|
Image Format
|
barcodeImageFormat | True | string |
Set the image format for barcode. |
|
Height
|
height | integer |
Set the QR code height (pixels). |
|
|
Width
|
width | integer |
Set the QR code width (pixels). |
|
|
Auto Size Mode
|
sizeMode | string |
Set the QR auto size mode, use 'Nearest' to assure QR code readability |
|
|
Fore Color
|
foreColor | string |
Set the QR code foreground color (HTML Color #000000) |
|
|
Back Color
|
backColor | string |
Set the QR code background color (HTML Color #FFFFFF) |
|
|
Visible Border
|
visibleBorder | boolean |
Set whether the QR code border is visible |
|
|
Border Color
|
borderColor | string |
Set the QR code border color (HTML Color #000000) |
|
|
Border Style
|
borderStyle | string |
Set the QR code border style |
|
|
Border Width
|
borderWidth | integer |
Set the QR code border width in pixels |
|
|
Resolution
|
resolution | integer |
Set the QR code border image resolution (dpi) |
|
|
Encode Mode
|
encodeMode | string |
Set the QR code encode mode |
|
|
Encode Type
|
encodeType | string |
Set the QR code encode type |
|
|
Encoding Type
|
textEncodingType | string |
Set the QR code text encoding type |
|
|
Logo Filename
|
logoFileName | string |
The filename of the source logo file, the file extension is mandatory: 'file.png' and not 'file' |
|
|
Logo File Content
|
logoFileContent | byte |
The file content of the source logo file |
|
|
Logo Position
|
logoPosition | string |
Set the position of the logo |
|
|
Caption Above Text
|
captionAboveText | string |
Set the caption above text |
|
|
Caption Above Font
|
captionAboveFont | string |
Set the font for the caption text |
|
|
Caption Above Font Size
|
captionAboveFontSize | integer |
Set the size of font for the caption text |
|
|
Caption Above Font Colour
|
captionAboveFontColour | string |
Set the font colour for the caption text |
|
|
Caption Above Alignment
|
captionAboveAlignment | string |
Set the alignment of the caption text |
|
|
Caption Above No Wrap
|
captionAboveNoWrap | boolean |
Set the wrapping of the caption text |
|
|
Caption Below Text
|
captionBelowText | string |
Set the caption below text |
|
|
Caption Below Font
|
captionBelowFont | string |
Set the font for the caption text |
|
|
Caption Below Font Size
|
captionBelowFontSize | integer |
Set the size of font for the caption text |
|
|
Caption Below Font Colour
|
captionBelowFontColour | string |
Set the font colour for the caption text |
|
|
Caption Below Alignment
|
captionBelowAlignment | string |
Set the alignment of the caption text |
|
|
Caption Below No Wrap
|
captionBelowNoWrap | boolean |
Set the wrapping of the caption text |
Returns
Crop an Image
Crop an image using border values or a rectangle - https://support.encodian.com/hc/en-gb/articles/10860483459740/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Crop Type
|
cropTypeParameter | string |
Set the crop type action |
|
|
operation
|
operation | dynamic |
Request object, refer to schema definition: DtoCropImage |
Returns
- Body
- DtoResponseCropImage
Delete Rows from Excel
Delete rows from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/9936160309148
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source Excel file |
|
First Row
|
firstRow | integer |
Set the number of the first row to delete |
|
|
Last Row
|
lastRow | integer |
Set the number of the last row to delete |
|
|
Worksheet Name
|
worksheetName | string |
Set the name of a specific worksheet to delete the rows from |
|
|
Row Array
|
rowArray | string |
Set an array of rows to delete, conforming to following structure: [23-56],[100-120],[156-8988] |
Returns
Disable Tracked Changes
Disable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695370804125
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word document |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Enable Tracked Changes
Enable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695385009053
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word document |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Extract Attachments from PDF
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 Excel Worksheets
Extract specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13230802892316
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Excel file |
|
Worksheet Names
|
worksheetNames | string |
A comma separated list of the names of the worksheets to extract: Sales, Totals, Year to Date |
|
|
Worksheet Indexes
|
worksheetIndexes | string |
A comma separated list of indexes of the worksheets to extract: 1,3,4 |
Returns
Extract from Archive
Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/11853992723484
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the archive |
|
Password
|
password | string |
Set a password for opening the archive |
|
|
Include Folders
|
includeFolders | True | boolean |
Set whether to extract files contained within folders which are present in the archive |
Returns
Extract Images from PDF
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 Text from Image (OCR)
Extract text from the image provided - https://support.encodian.com/hc/en-gb/articles/360006998078-Extract-Text-from-Image-OCR
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Image Type
|
imageType | True | string |
Select the image file format. |
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Language
|
ocrLanguage | string |
Select the language used for OCR processing |
|
|
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 70. |
|
|
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. |
Returns
Extract Text from Regions
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 a PDF Form
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 PDF
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
Flip an Image
Flip the image provided - https://support.encodian.com/hc/en-gb/articles/9798473339292
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Orientation
|
flipOrientation | True | string |
Set the orientation to flip the image provided |
Returns
- Body
- DtoResponseFlipImage
Get Email Attachments
Extract attachments from the email provided and return an array of files - https://support.encodian.com/hc/en-gb/articles/10531671561629
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source email file, the file extension is mandatory: 'file.eml' or 'file.msg' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the email |
|
Get Inline Attachments
|
getInlineAttachments | True | boolean |
Set whether to extract inline attachments |
Returns
Get Email Information
Get detailed information about the email provided (Email Format, Sender, Priority + more) - https://support.encodian.com/hc/en-gb/articles/12237799140252
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the email |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Get Image Information
Get Image Information (Height, Width, Resolution, Format, File Size + more) - https://support.encodian.com/hc/en-gb/articles/4431662425489
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Simplified Lat/Long Format
|
simplifiedLatLongFormat | boolean |
Return the Latitude and Longitude as formatted string eg., '45° 26’ 21"N' |
Returns
Get PDF Document Information
Get PDF Document Information (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
Get PDF Form Data
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
Get PDF Text Layer
Get the text layer for 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
Get Rows from Excel
Get rows from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/9390845334172
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Worksheet Name
|
worksheetName | string |
Set the name of a specific worksheet to be exported |
|
|
Has Header Row
|
hasHeaderRow | boolean |
Set whether the first row specified is a header row |
|
|
First Row
|
firstRow | integer |
Set the number of the first row to be exported |
|
|
Last Row
|
lastRow | integer |
Set the number of the last row to be rows to be exported |
|
|
First Column
|
firstColumn | integer |
Set the number of the first column to be exported |
|
|
Last Column
|
lastColumn | integer |
Set the number of the last column to be exported |
|
|
Exclude Empty Rows
|
excludeEmptyRows | boolean |
Set whether empty rows should be excluded from the export |
|
|
Export Empty Cells
|
exportEmptyCells | boolean |
Set whether empty cells should be exported |
|
|
Export Values as Text
|
exportValuesAsText | boolean |
Set whether values should be exported as text, i.e. a number would be exported as "value":"3" |
|
|
Hyperlink Format
|
hyperlinkFormat | string |
Set how Hyperlinks should be exported |
|
|
Export as Object
|
alwaysExportAsJsonObject | boolean |
Force row data to be exported as a JsonObject even when there is only a single worksheet contained within the file |
|
|
Culture Name
|
cultureName | string |
Set the thread culture used to process the request |
Returns
Get Subscription Status - Trigr
Get the the status of your Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/7297080207133
Returns
Get Subscription Status – Flowr and Vertr
Get the the status of your Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/360010176717-Get-Subscription-Status
Returns
Get Text from Word
Get the text contained within the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/10583756977180
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the Microsoft Word 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 Microsoft Word document provided |
|
|
Remove Comments
|
removeComments | boolean |
Set whether comments should be removed prior to extracting text from the the Microsoft Word file |
|
|
Accept Changes
|
acceptChanges | boolean |
Set whether tracked changes should be accepted prior to extracting text from the the Microsoft Word file |
|
|
Remove Headers And Footers
|
removeHeadersAndFooters | boolean |
Set whether headers and footers should be removed from the the Microsoft Word file |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Get Tracked Changes
Get all the tracked changes (Revisions and comments) for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6634950400669
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Include Comments
|
includeComments | boolean |
Set whether comments should be included within the tracked changes result(s) |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Image Clean Up (Document)
Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file' |
|
File Content
|
FileContent | byte |
The file content of the source image file |
|
|
Clean Operations
|
cleanUpType | string |
Perform file clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the provided file. |
|
|
Rotate
|
AutoRotate | boolean |
Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default. |
|
|
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, this is enabled by default. |
|
|
Despeckle
|
Despeckle | boolean |
Automatically detects speckles and removes them, this is enabled by default. |
|
|
Adjust Brightness and Contrast
|
AdjustBrightnessContrast | boolean |
This action analyzes a document and automatically adjusts brightness and contrast based on the analysis, this is disabled by default. |
|
|
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, this is disabled by default. |
|
|
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, this is disabled by default. |
|
|
Remove Dot Shading
|
RemoveDotShading | boolean |
This action will remove shaded regions from bitonal documents, this is disabled by default. |
|
|
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, this is disabled by default. |
|
|
Average Filter
|
ApplyAverageFilter | boolean |
Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window, this is disabled by default. |
|
|
Remove Hole Punch
|
RemoveHolePunch | boolean |
Detects and removes hole punch marks from a bitonal document, this is disabled by default. |
|
|
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, this is disabled by default. |
Returns
Image Clean Up (Photo)
Execute image clean up activities for standard photo images.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file' |
|
File Content
|
FileContent | byte |
The file content of the source image file |
|
|
Clean Operations
|
cleanUpType | string |
Perform file clean-up operations, the default option will auto rotate, apply colour balance, auto deskew and auto despeckle the provided file. |
|
|
Deskew
|
Deskew | boolean |
Detects the skew angle and rotates to remove that skew, this is enabled by default. |
|
|
Despeckle
|
Despeckle | boolean |
Automatically detects speckles and removes them, this is enabled by default. |
|
|
Color Balance
|
ColorBalance | boolean |
Restores and balances the color quality within an image, this is enabled by default. |
|
|
Remove Border
|
RemoveBorder | boolean |
Locates border pixels and removes the pixels from the document, this is disabled by default. |
|
|
Contrast
|
Contrast | boolean |
Adjusts the contrast in the current image. |
|
|
Remove Redeye
|
RemoveRedeye | boolean |
Automatically reduces the red reflection of the flash seen in the eyes of people in color flash photo images. |
|
|
Blur
|
Blur | boolean |
Blurs the current image by averaging each pixel with each of its neighboring pixels giving it an 'out of focus' appearance. |
|
|
Diffuse
|
Diffuse | boolean |
Diffuses the current image by replacing each pixel with a randomly selected neighboring pixel. |
|
|
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, this is disabled by default. |
|
|
Rotate
|
AutoRotate | boolean |
Automatically detects orientation and rotates so that the text is upright oriented, this is enabled by default. |
|
|
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 40. |
Returns
Insert HTML to PDF
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
Manage Tracked Changes
Process Tracked Changes within the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10074318228765
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
FileContent | True | byte |
The file content of the source Microsoft Word file |
|
Accept Insertions
|
acceptInsertions | string |
Set whether to accept or reject insertions |
|
|
Accept Deletions
|
acceptDeletions | string |
Set whether to accept or reject deletions |
|
|
Accept Format Changes
|
acceptFormatChanges | string |
Set whether to accept or reject format changes |
|
|
Accept Movements
|
acceptMovements | string |
Set whether to accept or reject content movements |
|
|
Remove Comments
|
removeComments | boolean |
Set whether to remove comments |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Merge document array to PDF
Convert and merge an array of documents 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
Merge documents to PDF
Convert and merge the documents 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
Merge Excel Files
Merge an array of Microsoft Excel files to a single file (multiple formats) - https://support.encodian.com/hc/en-gb/articles/4469865776529
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
outputFilename | string |
The filename of the output excel file |
|
|
Output Format
|
mergeExcelOutputFormat | string |
The format of the output excel file |
|
|
Filename
|
fileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Sort Position
|
sortPosition | integer |
Set the sort position within the document array |
|
|
Worksheets to Merge
|
worksheetsToMerge | array of integer |
Specify which worksheets from the source file should be included within the output |
Returns
Merge Excel Rows
Merge the rows contained within Excel files provided into a single worksheet - https://support.encodian.com/hc/en-gb/articles/11345445953820
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
outputFilename | string |
The filename of the output excel file |
|
|
Output Format
|
outputFormat | True | string |
The format of the output excel file |
|
Filename
|
fileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.xlsx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Sort Position
|
sortPosition | integer |
Set the sort position for the document within the array, lowest number first |
|
|
Worksheets to Merge
|
worksheetsToMerge | array of integer |
Specify which worksheets from the source file should be included within the output |
|
|
Include First Row
|
includeFirstRow | boolean |
Set whether to include the first row of the worksheet |
|
|
Preserve First Row
|
preserveFirstRow | boolean |
Assure that the first row of the first workbook and sheet is always preserved |
Returns
Merge Presentations
Merge an array of presentations to a single presentation - https://support.encodian.com/hc/en-gb/articles/4425652063761
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Format
|
mergePresentationOutputFormat | True | string |
The format of the output presentation file |
|
Filename
|
outputFilename | string |
The filename of the output presentation file, set to 'presentation' by default |
|
|
Filename
|
fileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.pptx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Sort Position
|
sortPosition | integer |
Set the sort position within the document array |
|
|
Slides
|
slidesToMerge | array of integer |
Specify which slides to include in the output |
|
|
Master Style
|
mergePresentationMasterStyle | boolean |
Apply the style of the first provided presentation to all other presentations, set to 'false' by default |
Returns
Merge Word Documents
Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
outputFilename | True | string |
The filename of the output DOCX document |
|
Filename
|
fileName | True | string |
The filename of the source file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Sort Position
|
sortPosition | integer |
Set the sort position within the document array |
|
|
Format Mode
|
wordInputFormatMode | string |
Set how formatting is handled when documents are merged into the first document in the array. |
|
|
Time Zone
|
timezone | string |
Set a specific time zone for date and time processing |
Returns
OCR a PDF Document
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
Parse CSV
Parse CSV and return the extracted data in JSON format - https://support.encodian.com/hc/en-gb/articles/360005177297-Parse-CSV
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
FileContent | True | byte |
The file content of the source CSV file |
|
Delimiter
|
delimiter | string |
Set the CSV delimiter, the default value is a comma: ',' |
|
|
Column Headers
|
csvColumnHeaders | string |
Manually set the column headers for the CSV data (Column delimited: Column 1, Column 2, etc. |
|
|
Skip First Line
|
skipFirstLine | boolean |
Skip the first line of the CSV file, set to 'Yes' if your CSV document contains column headers |
Returns
- Body
- DtoResponseParseCsv
Populate Excel
Populate a Microsoft Excel workbook (XLSX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/12736409527324
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The Microsoft Excel workbook (XLSX) to populate |
|
JSON Data
|
jsonData | True | string |
The JSON data to populate the Microsoft Excel wookbook with |
|
JSON Parse Mode
|
jsonParseMode | string |
Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) |
|
|
Calculate Workbook
|
calculateWorkbook | boolean |
Automatically calculate formulas upon population |
|
|
Use Excel Data Types
|
useExcelDataTypes | boolean |
When enabled data is added to the workbook using corresponding Excel data types as opposed to a string data type |
|
|
Allow Missing Values
|
allowMissingMembers | boolean |
Sets the engine to allow missing values within the 'JSON Data' |
|
|
Inline Errors
|
inlineErrorMessages | boolean |
Produces errors within the resultant workbook as opposed to rejecting the request with a HTTP 4** error |
|
|
Remove Empty Paragraphs
|
removeEmptyParagraphs | boolean |
Sets the engine to automatically removes any empty paragraphs upon execution |
|
|
Date Time Formats
|
dateTimeFormat | string |
Set one or more specfic formats for parsing DateTime values |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Populate PowerPoint
Populate a Microsoft PowerPoint file (PPTX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/9715390966300
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The Microsoft PowerPoint file (PPTX) to populate |
|
JSON Data
|
jsonData | True | string |
The JSON data to populate the Microsoft PowerPoint file with |
|
JSON Parse Mode
|
jsonParseMode | string |
Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) |
|
|
Allow Missing Values
|
allowMissingMembers | boolean |
Sets the engine to allow missing values within the 'Document Data' |
|
|
Inline Errors
|
inlineErrorMessages | boolean |
Produces errors within the resultant document as opposed to rejecting the request with a HTTP 4** error |
|
|
Remove Empty Paragraphs
|
removeEmptyParagraphs | boolean |
Sets the engine to automatically removes any empty paragraphs upon execution |
|
|
Date Time Formats
|
dateTimeFormat | string |
Set one or more specfic formats for parsing DateTime values |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Populate Word Document
Populate a Microsoft Word Document (DOCX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The Microsoft Word Document (DOCX) to populate |
|
Document Data
|
documentData | True | string |
The JSON data to populate the Microsoft Word Document with |
|
JSON Parse Mode
|
jsonParseMode | string |
Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) |
|
|
Allow Missing Values
|
allowMissingMembers | boolean |
Sets the engine to allow missing values within the 'Document Data' |
|
|
Inline Errors
|
inlineErrorMessages | boolean |
Produces errors within the resultant document as opposed to rejecting the request with a HTTP 4** error |
|
|
Remove Empty Paragraphs
|
removeEmptyParagraphs | boolean |
Sets the engine to automatically removes any empty paragraphs upon execution |
|
|
Date Time Formats
|
dateTimeFormat | string |
Set one or more specfic formats for parsing DateTime values |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
|
|
Time Zone
|
timezone | string |
Set a specific time zone for date and time processing |
Returns
Read Barcode - Document
Read barcode(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006170938-Read-Barcode-Document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Type
|
fileType | string |
Select the source document format. |
|
|
File Content
|
FileContent | byte |
The file content of the source file |
|
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Quality
|
barcodeReadQuality | string |
Set the quality level for barcode detection |
|
|
Start Page
|
startPage | integer |
Set the page number to begin reading from |
|
|
End Page
|
endPage | integer |
Set the page number to end reading on |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Read Barcode - Image
Read a barcode from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170918-Read-Barcode-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Image Format
|
barcodeImageFormat | True | string |
Select the image format for the barcode image provided |
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Read QR Code - Document
Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437-Read-QR-Code-Document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Type
|
fileType | string |
Select the source document format. |
|
|
File Content
|
FileContent | byte |
The file content of the source file |
|
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Start Page
|
startPage | integer |
Set the page number to begin reading from |
|
|
End Page
|
endPage | integer |
Set the page number to end reading on |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Read QR Code - Image
Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898-Read-QR-Code-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Image Format
|
barcodeImageFormat | True | string |
Select the image format for the QR Code image provided |
|
Confidence
|
barcodeReadConfidence | string |
Set the confidence level for barcode detection |
|
|
Remove Control Characters
|
barcodeRemoveControlChars | boolean |
Set whether recognised control characters should be removed |
Returns
Redact PDF
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 EXIF Tags from Image
Remove EXIF tags from the specified image - https://support.encodian.com/hc/en-gb/articles/4415700524817
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Image Type
|
imageType | True | string |
Select the image file format. |
Returns
Remove Watermark from Word
Remove the watermark from the Word file provided - https://support.encodian.com/hc/en-gb/articles/7752587767965
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Remove Watermarks from PDF
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 PDF
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
Replace Text with Image
Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Type
|
fileType | string |
Select the source document format. |
|
|
Filename
|
FileName | string |
The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file' |
|
|
File Content
|
FileContent | byte |
The file content of the source file |
|
|
Search Text
|
SearchText | True | string |
The text to locate and replace with the specified image |
|
Image Filename
|
imageFilename | True | string |
The filename for the image file, the file extension is mandatory: 'file.jpg' and not 'file' |
|
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 | array of integer |
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
|
ignorePageNumbers | array of integer |
Specify the page numbers not to search for the text fragment, 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
Resize an Image
Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
FileName | True | string |
The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file' |
|
File Content
|
FileContent | True | byte |
The file content of the source image file |
|
Resize Type
|
ImageResizeType | True | string |
Set whether the image should be resized to a ratio or specific dimensions. |
|
Resize Percentage
|
ResizePercentage | integer |
For percentage resize actions - Set the percentage the image should be decrased or increased in size by. |
|
|
Image Width
|
ImageWidth | integer |
For specific resize actions - Set the specific width of the image in pixels |
|
|
Image Height
|
ImageHeight | integer |
For specific resize actions - Set the specific height of the image in pixels |
|
|
Maintain Aspect Ratio
|
MaintainAspectRatio | boolean |
For specific resize actions - If true, the image height will be automatically set relevant to the image width provided. |
|
|
Image Resolution
|
ImageResolution | integer |
Optionally specify an image resolution, by default the current image resolution will be used |
Returns
Resize PDF
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 an Image
Rotate an image by specified degrees - https://support.encodian.com/hc/en-gb/articles/10041551840796
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source image file |
|
Rotation Angle
|
rotationAngle | float |
Optional - The number of degrees to rotate the image |
|
|
Preset Rotation Angle
|
presetRotationAngle | string |
Optional - Select a preset rotation angle |
|
|
Proportionate Resize
|
resizeProportionally | boolean |
Specifies that the image dimensions are proportionately adjusted to the rotated rectangle (corner points) projections |
|
|
Background Color
|
backgroundColour | string |
Sets the background color of the rotated image when 'Proportionate Resize' is enabled |
Returns
Search and Replace Text
Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Type
|
fileType | string |
Select the source document format. |
|
|
Filename
|
FileName | string |
The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file' |
|
|
File Content
|
FileContent | byte |
The file content of the source file |
|
|
Search Text
|
SearchText | True | string |
Optional - The text to locate and replace with the 'Replacement Text' value |
|
Is Expression
|
IsExpression | boolean |
Set whether the 'Search Text' value should be evaluted as a regular expression, the default value is 'false' |
|
|
Replacement Text
|
ReplacementText | string |
The text to replace the 'Search Text' text with |
|
|
Font
|
Font | string |
The name of the font to use for the 'Replacement Text', the default font is 'Arial' |
|
|
Font Size
|
FontSize | integer |
The size of the font to use for the 'Replacement Text', the default size is '16' |
|
|
Font Colour
|
FontColour | string |
The HTML colour of the font to use for the 'Replacement Text', the default colour is '#000000' |
|
|
Background Colour
|
BackgroundColour | string |
The background HTML colour to use for the 'Replacement Text', the default colour is '#FFFFFF' |
|
|
Underline
|
Underline | boolean |
Set whether the 'Replacement Text' should be underlined, the default value is 'false' |
|
|
Word Spacing
|
WordSpacing | float |
The word spacing to apply to the 'Replacement Text' |
|
|
Line Spacing
|
LineSpacing | float |
The line spacing to apply to the 'Replacement Text' |
|
|
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
Secure PDF Document
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
Secure Word Document
Secure and protect a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/6634150180253
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Protection Type
|
wordProtectionType | string |
Set the protection type for the Microsoft Word document |
|
|
Protection Password
|
password | string |
Set the password used to protect the Microsoft Word document |
|
|
Secure on Open
|
secureOnOpen | boolean |
Set whether a password should be required to open the Microsoft Word document |
|
|
Secure on Open Password
|
secureOnOpenPassword | string |
Set the password used to open the Microsoft Word document |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Send to Encodian Filer
Send data to an Encodian Filer endpoint - https://support.encodian.com/hc/en-gb/articles/4404097189905-Send-to-Encodian-Filer
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
API Endpoint
|
apiEndpoint | True | string |
Set the Encodian Filer endpoint URL. |
|
API Key
|
apiKey | True | string |
Set the Encodian Filer API Key for authentication. |
|
Data
|
data | True | string |
Provide the data payload to be send to Encodian Filer (body). |
|
HTTP Method
|
httpMethod | True | string |
Set the HTTP Method type. |
Returns
Set PDF Document Privileges
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
Sign PDF
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 PDF
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 PDF by Barcode
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 PDF by Text
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
Unlock PDF Document
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
Update Rows in Excel
Update the specified rows in the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11205752671004
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
A Base64 encoded representation of the Excel file to be processed |
|
Row Data
|
jsonData | True | string |
The JSON dataset to be processed and added as rows to the Excel file provided |
|
Update from Row
|
updateRow | True | integer |
The row number which the data provided will start updating from |
|
Update from Column
|
updateColumn | True | integer |
The column number which the data provided will start updating from |
|
Worksheet Name
|
worksheetName | string |
Set the name of a specific worksheet to be updated |
|
|
Convert Numeric and Date
|
convertNumericAndDate | boolean |
Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date' |
|
|
Date Format
|
dateFormat | string |
Set the date and time format - https://docs.aspose.com/cells/net/list-of-supported-number-formats/ |
|
|
Numeric Format
|
numericFormat | string |
Set the numeric format - https://docs.aspose.com/cells/net/list-of-supported-number-formats/ |
|
|
Ignore Attribute Titles
|
ignoreAttributeTitles | boolean |
Ignores titles of JSON attributes when converting JSON to Excel |
|
|
Ignore Null Values
|
ignoreNulls | boolean |
Ignore JSON properties which contain null values. |
|
|
Culture Name
|
cultureName | string |
Set the thread culture used to process the request |
Returns
Update Word - Add Headers and Footers
Add HTML headers and/or footers to the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11348579020572
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Header - All Pages
|
allPagesHeaderHtml | string |
The HTML header to add to all pages |
|
|
Footer - All Pages
|
allPagesFooterHtml | string |
The HTML footer to add to all pages |
|
|
Header - First Page
|
firstPageHeaderHtml | string |
The HTML header to add to the first page |
|
|
Header - Even Pages
|
evenPageHeaderHtml | string |
The HTML header to add to all even pages |
|
|
Header - Odd Pages
|
oddPageHeaderHtml | string |
The HTML header to add to all odd pages |
|
|
Footer - First Page
|
firstPageFooterHtml | string |
The HTML footer to add to the first page |
|
|
Footer - Even Pages
|
evenPageFooterHtml | string |
The HTML footer to add to all even pages |
|
|
Footer - Odd Pages
|
oddPageFooterHtml | string |
The HTML footer to add to all odd pages |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Update Word - Hyperlinks
Find and update hyperlinks contained within a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7136687719837
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
|
File Content
|
fileContent | True | byte |
The file content of the source file |
|
Search On
|
searchOn | True | string |
Set whether the search should be performed on the hyperlink text or URL value |
|
Search Value
|
searchValue | True | string |
The hyperlink text or URL value to locate |
|
Is Expression
|
isExpression | boolean |
Set whether the 'Search Value' value should be evaluated as a regular expression, the default value is 'false' |
|
|
Text Current Value
|
hyperlinkLabelValueCurrent | string |
The text value to replace, leave blank to replace the entire value |
|
|
Text New Value
|
hyperlinkLabelValueNew | string |
The new value to set |
|
|
URL Current Value
|
hyperlinkUrlValueCurrent | string |
The URL value to replace, leave blank to replace the entire value |
|
|
URL New Value
|
hyperlinkUrlValueNew | string |
The new URL value to set |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Update Word - Remove Headers and Footers
Remove headers and/or footers from the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11349707504540
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Remove All Headers
|
removeAllHeaders | boolean |
Set to remove all headers |
|
|
Remove All Footers
|
removeAllFooters | boolean |
Set to remove all footers |
|
|
Header - First Page
|
removeFirstPageHeader | boolean |
Set to remove the header from the first page |
|
|
Header - Even Pages
|
removeEvenPageHeader | boolean |
Set to remove the header from even pages |
|
|
Header - Odd Pages
|
removeOddPageHeader | boolean |
Set to remove the header from odd pages |
|
|
Footer - First Page
|
removeFirstPageFooter | boolean |
Set to remove the footer from the first page |
|
|
Footer - Even Pages
|
removeEvenPageFooter | boolean |
Set to remove the footer from even pages |
|
|
Footer - Odd Pages
|
removeOddPageFooter | boolean |
Set to remove the footer from odd pages |
Returns
Update Word - Table of Contents
Update the 'Table of Contents' in the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10594864447260
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file' |
|
File Content
|
fileContent | True | byte |
The file content of the source Microsoft Word file |
|
Time Zone
|
timezone | string |
Set a specific time zone for date and time processing |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Utility - AES Decryption
Decrypts an AES encrypted string using AES decryption - https://support.encodian.com/hc/en-gb/articles/13200819253660
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The cipher (string) to decrypt |
|
Input Type
|
inputDataEncodingMethod | True | string |
Set the data format of the encrypted string |
|
Key
|
key | True | string |
Set the key (secret) used within the algorithm |
|
Mode
|
mode | True | string |
Set the AES encryption algorithm |
|
Initialization Vector
|
initializationVector | string |
Optional - The 'Initialization Vector' should only be provided when the mode is set to 'CBC' or 'CFB' |
|
|
Padding
|
padding | string |
Sets the padding mode used in the symmetric algorithm, default is PKCS7 |
Returns
Utility - AES Encryption
Encrypts a plain text value (string) using AES encryption - https://support.encodian.com/hc/en-gb/articles/13200698504860
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The input string to encrypt |
|
Output Type
|
outputDataEncodingMethod | True | string |
Set the data format of the encrypted string |
|
Key
|
key | True | string |
Set the key (secret) used within the algorithm |
|
Mode
|
mode | True | string |
Set the AES encryption algorithm |
|
Initialization Vector
|
initializationVector | string |
Optional - The 'Initialization Vector' should only be provided when the mode is set to 'CBC' or 'CFB' |
|
|
Padding
|
padding | string |
Sets the padding mode used in the symmetric algorithm, default is PKCS7 |
Returns
Utility - Array Add Items
Add one or more items to the array provided - https://support.encodian.com/hc/en-gb/articles/10565757970332
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON array or object to modify |
|
Items
|
items | True | string |
The items to add to the 'Data' provided |
|
Item Position
|
itemPosition | True | string |
Set whether to return the first item, last item or a specified item |
|
Item Index
|
itemIndex | integer |
Index of the item to return. This is only applicable when the 'Item Position' property is set to 'Specific' |
|
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array Contains Value
Checks if a value is contained within the array provided - https://support.encodian.com/hc/en-gb/articles/10242960376476
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to evaluate |
|
Value
|
value | True | string |
The value to check is contained within the array |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
|
|
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when searching the array |
Returns
Utility - Array Count Items
Count the items contained within the array provided - https://support.encodian.com/hc/en-gb/articles/10284117199004
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to modify |
|
Path
|
path | string |
Select a specific node using a JSONPath expression |
Returns
Utility - Array Get Item(s)
Get the specified item(s) from the JSON array(s) provided - https://support.encodian.com/hc/en-gb/articles/10564816481564
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON array or object to evaluate |
|
Item Position
|
itemPosition | True | string |
Set whether to return the first item, last item or a specified item |
|
Item Index
|
itemIndex | integer |
Index of the item to return. This is only applicable when the 'Item Position' property is set to 'Specific' |
|
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array Remove Duplicates
Remove duplicates from the array provided - https://support.encodian.com/hc/en-gb/articles/10614334072476
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to modify |
|
Ignore Case
|
ignoreCase | True | boolean |
Set whether the text case should be ignored when searching for duplicates |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array Remove Items
Remove one or more items from the array provided - https://support.encodian.com/hc/en-gb/articles/10597605184028
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to modify |
|
Item Position
|
itemPosition | True | string |
Set whether to remove the first item, last item or a specified item |
|
Item Index
|
itemIndex | integer |
Index of the item to remove. This is only applicable when the 'Item Position' property is set to 'Specific' |
|
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array Remove Items via Regex
Remove items from a JSON Array using a Regular Expression - https://support.encodian.com/hc/en-gb/articles/11196894053020
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to modify |
|
Regex
|
regex | True | string |
The regular expression used to find matches in the 'Data' |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array Replace Values
Replaces an array or specified item with the value provided - https://support.encodian.com/hc/en-gb/articles/10624152774812
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to evaluate |
|
Search Value
|
searchValue | string |
The value to locate and replace with the 'Replacement Value', a blank value is treated as white-space |
|
|
Replacement Value
|
replacementValue | string |
The value to replace the matched values with, a blank value will remove the matched values |
|
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array Reverse Items
Reverse the items in the JSON array provided - https://support.encodian.com/hc/en-gb/articles/9993904693660
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
The JSON data to modify |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Utility - Array to JSON
Convert an array to a named JSON object - https://support.encodian.com/hc/en-gb/articles/12731808723612
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
An array or a JSON object to select an array for conversion to a named JSON object |
|
Name
|
name | True | string |
The JSON node name to contain the array provided or selected |
|
Path
|
path | string |
Select a specific array within the 'Data' using a JSONPath expression |
Returns
Utility - Calculate Date
Calculate a date value by adding or subtracting a given period of time - https://support.encodian.com/hc/en-gb/articles/11311253860508
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Date
|
date | True | string |
The date value to calculate |
|
Measurement
|
measurement | True | string |
Set the time measurement used for the calculation |
|
Operation
|
operation | True | string |
Set the operation type, either add or subtract |
|
Interval
|
interval | True | integer |
Set amount of time to add or subtract from the 'Date' value provided |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Utility - Clean Text
Remove invalid or specified characters from the text value provided - https://support.encodian.com/hc/en-gb/articles/10072015106077
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to process |
|
Remove Character Set
|
removeCharacterSet | string |
Set the collection of characters to remove from the text value provided |
|
|
Remove Control Characters
|
removeControlChars | boolean |
Set whether to remove control characters from the text value |
|
|
Remove Invalid Filename Characters
|
removeInvalidFileNameChars | boolean |
Set whether to remove characters that are invalid in file names from the text value |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Utility - Compare Text
Compare the text values provided - https://support.encodian.com/hc/en-gb/articles/11782390540957
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Primary Text
|
primaryText | True | string |
The first text value to compare |
|
Secondary Text
|
secondaryText | True | string |
The second text value to compare |
|
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when comparing the text values provided |
Returns
Utility - Concatenate Text
Concatenate text values provided - https://support.encodian.com/hc/en-gb/articles/11873576674077
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text Values
|
textList | array of string |
The array of text values to concatenate |
|
|
Delimiter
|
delimiter | string |
The delimiter to place between the concatenated text values |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Utility - Convert Time Zone
Convert the date and time value provided to another time zone - https://support.encodian.com/hc/en-gb/articles/11316002119196
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Date
|
date | True | string |
The date and time value to convert |
|
Current Time Zone
|
currentTimeZone | string |
Set the current time zone |
|
|
New Time Zone
|
newTimeZone | True | string |
Set the new time zone |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Utility - Create GUID
Generate a new GUID - https://support.encodian.com/hc/en-gb/articles/9563119917597
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Case
|
case | True | string |
Set the case of the GUID (Lower or Upper) |
Returns
Utility - Create Hash Code
Create a hashcode for the string provided - https://support.encodian.com/hc/en-gb/articles/360013996077-Create-Hash-Code
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | True | string |
Provide the input data to be computed |
|
Data Type
|
cryptoInputDataType | string |
Set the data format for the input data provided. |
|
|
Digest Algorithm
|
digestAlgorithm | True | string |
Select the message digest algorithm |
|
Output Type
|
cryptoOutputDataType | string |
Set the data format for the hash code generated. |
|
|
Case
|
case | string |
Set the case applied to the computed value. |
|
|
Encoding Type
|
encoding | string |
Select the encoding type. |
Returns
Utility - Create HMAC
Create a Hash-based message authentication code (HMAC) using a secret key - https://support.encodian.com/hc/en-gb/articles/360012782058-Create-HMAC
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data
|
data | string |
Provide the input data to be computed |
|
|
Data Type
|
cryptoInputDataType | string |
Set the data format for the input data provided. |
|
|
Key
|
key | True | string |
Provide the key (secret) used to compute the hash-based message authentication code (HMAC) |
|
Key Type
|
cryptoKeyDataType | string |
Set the data format for the key provided. |
|
|
Digest Algorithm
|
digestAlgorithm | True | string |
Select the message digest algorithm |
|
Output Type
|
cryptoOutputDataType | string |
Set the data format for the HMAC generated |
|
|
Case
|
case | string |
Set the case applied to the computed value. |
|
|
Encoding Type
|
encoding | string |
Select the encoding type. |
Returns
Utility - Escape HTML
Escape the HTML value provided - https://support.encodian.com/hc/en-gb/articles/11749992433437
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
HTML
|
html | True | string |
The HTML value to process |
Returns
Utility - Extract Email Addresses from Text
Extract email addresses from the text value provided - https://support.encodian.com/hc/en-gb/articles/10068475924253
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text from which email addresses are to be extracted |
|
Regex
|
regex | True | string |
The default regular expression used for extraction |
Returns
Utility - Extract Text between Values
Extract text from a string between the two values provided - https://support.encodian.com/hc/en-gb/articles/9604938273565
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text from which a value is to be extracted |
|
Start Value
|
startValue | string |
The text value to start the extraction from |
|
|
End Value
|
endValue | string |
The text value to end the extraction from |
|
|
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing the extraction |
|
|
Include Values
|
includeValues | string |
Set whether any or both of the 'Start Value' and 'End Value' should be included within the result |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the extracted string |
Returns
Utility - Extract Text Instances between Values
Extract all text instances from a string between the two values provided - https://support.encodian.com/hc/en-gb/articles/11193212526108
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text from which values are to be extracted |
|
Start Value
|
startValue | string |
The text value to start an extraction from |
|
|
End Value
|
endValue | string |
The text value to end an extraction from |
|
|
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing an extraction |
|
|
Include Values
|
includeValues | string |
Set whether any or both of the 'Start Value' and 'End Value' should be included within extracted text |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the extracted text |
|
|
Remove Empty Values
|
removeEmptyValues | boolean |
Set whether to remove empty or null strings from the result array if present |
Returns
Utility - Extract URL's from Text
Extract URL's from the text value provided - https://support.encodian.com/hc/en-gb/articles/11056297407261
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text from which URL's are to be extracted |
|
Regex
|
regex | True | string |
The default regular expression used for extraction |
Returns
Utility - Format Date
Format the date value to the format configuration selected - https://support.encodian.com/hc/en-gb/articles/11053469626525
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Date
|
date | True | string |
The date value to format |
|
Format
|
format | True | string |
Set the date format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Utility - Format Text Case
Set the case of the text (string) provided - https://support.encodian.com/hc/en-gb/articles/11009856518557
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to format |
|
Action
|
action | True | string |
The formatting action to apply to the text value provided |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Utility - Generate Password
Create a password conforming to the specified configuration - https://support.encodian.com/hc/en-gb/articles/10720449877789
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Length
|
length | True | integer |
Set the length of the password |
|
Include Lower Case
|
includeLowerCase | boolean |
Set whether lower case characters should be included within the password |
|
|
Include Upper Case
|
includeUpperCase | boolean |
Set whether upper case characters should be included within the password |
|
|
Include Numbers
|
includeNumbers | boolean |
Set whether numbers should be included within the password |
|
|
Include Symbols
|
includeSymbols | boolean |
Set whether symbols should be included within the password |
|
|
Exclude Characters
|
excludeCharacters | string |
Specify a list of characters to exclude from the password |
Returns
Utility - Generate Random Number
Generate a random number conforming to the configuration supplied - https://support.encodian.com/hc/en-gb/articles/10641115110045
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Minimum Value
|
minValue | integer |
Optional - Set the minimum value of the number generated |
|
|
Maximum Value
|
maxValue | integer |
Optional - Set the maximum value of the number generated |
Returns
Utility - Get Date and Time Difference
Calculate the difference between two dates and times - https://support.encodian.com/hc/en-gb/articles/11753070117661
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Start Date
|
startDateTime | True | string |
Start date (and optionally time) of the period to be calculated |
|
End Date
|
endDateTime | True | string |
End date (and optionally time) of the period to be calculated |
|
Interval
|
interval | True | string |
The interval to calculate - Year, Quarter, Month, Week, Day, Hour, Minute, Second, Millisecond |
|
Days to Exclude
|
daysToExclude | string |
Specify the days to be excluded from the calculation as a comma-delimited list, for example: Saturday, Sunday |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Utility - Get File Extension
Get the File Extension for the filaname provided - https://support.encodian.com/hc/en-gb/articles/10931474896797
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
The filename to obtain a file extension from |
|
Case
|
case | string |
Set the case of the extracted file extension value (Lower or Upper) |
Returns
Utility - Parse HTML Table
Parse a table contained within the HTML provided to JSON - https://support.encodian.com/hc/en-gb/articles/11505625014685
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | byte |
Optional - The file content of the source HTML file. |
|
|
HTML Data
|
html | string |
Optional - The HTML to be parsed |
|
|
Table Index
|
tableIndex | integer |
Set the index of the HTML table to parse, when more than one table is present within the HTML (The default is 1) |
|
|
Table ID
|
tableId | string |
Set the ID of the HTML table to parse, when more than one table is present within the HTML |
|
|
Quantity Filter
|
quantityFilter | integer |
Get the rows with the specified number of columns |
|
|
Content Filter
|
contentFilter | string |
Set that only table cells which match the specified type will be parsed |
Returns
Utility - Remove Diacritics
Remove diacritic marks from the text provided - https://support.encodian.com/hc/en-gb/articles/11774131045661
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to process |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Utility - Remove Text between Values
Remove text from a string between the two values provided - https://support.encodian.com/hc/en-gb/articles/10003667972892
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text from which a value is to be removed |
|
Start Value
|
startValue | True | string |
The text value to start the removal from |
|
End Value
|
endValue | True | string |
The text value to end the removal from |
|
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing the removal |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the removed string |
|
|
Replace With
|
replaceWith | string |
Set a value to replace the removed value with |
|
|
Include Values
|
includeValues | string |
Set whether either or both of the Start Value and End Value should be included within the removal |
Returns
Utility - Replace Value with Regex
Replace a value within the text provided using a regex query - https://support.encodian.com/hc/en-gb/articles/11743215056413
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to process |
|
Regex
|
regex | True | string |
The regex query to use to find matches in the text value |
|
Replacement Text
|
replacementText | string |
Optional - The text to replace the matched values with, a blank value will remove the matched text values |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Utility - Replace Value with Text
Replace a value within the text provided - https://support.encodian.com/hc/en-gb/articles/11774858455709
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to process |
|
Search Text
|
searchText | string |
The text to locate and replace with the 'Replacement Text' value, a blank value is treated as white-space |
|
|
Replacement Text
|
replacementText | string |
The text to replace the matched values with, a blank value will remove the matched text values |
|
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Utility - Search Text (Regex)
Search the text provided to find matches using the regex provided - https://support.encodian.com/hc/en-gb/articles/360006764638-Search-Text-Regex
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text to search with the regex string provided |
|
Regex Query
|
query | True | string |
The regex query to use to find matches in the string provided |
|
ECMAScript
|
ecmaScript | boolean |
Enables ECMAScript-compliant behavior for the expression. This value can be used only in conjunction with the IgnoreCase and Multiline options. Disabled by default. |
|
|
Explicit Capture
|
explicitCapture | boolean |
Specifies that the only valid captures are explicitly named or numbered groups of the form, disabled by default. |
|
|
Ignore Case
|
ignoreCase | boolean |
Specifies case-insensitive matching, disabled by default. |
|
|
Ignore Whitespace
|
ignoreWhitespace | boolean |
Eliminates unescaped white space from the pattern and enables comments marked with #, disabled by default. |
|
|
Multiline
|
multiline | boolean |
Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string, disabled by default. |
|
|
Right-to-Left
|
rightToLeft | boolean |
Specifies that the search will be from right to left instead of from left to right, disabled by default. |
|
|
Singleline
|
singleline | boolean |
Specifies single-line mode. Changes the meaning of the dot (.) so it matches every character (instead of every character except \n), disabled by default. |
|
|
Return Groups
|
returnGroups | boolean |
Specifies that the search will return match groups rather than match values |
Returns
Utility - Split Text
Split the text provided using the set delimiter - https://support.encodian.com/hc/en-gb/articles/11846521179805
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to process |
|
Split Value
|
splitValue | string |
Set the value to split the text provided on |
|
|
Split On
|
splitOn | string |
Set whether the text should be split on all instances, the first instance or the last instance of the 'Split Value' |
|
|
Trim Values
|
trimResult | boolean |
Set whether white-space should be trimmed from the values split from the text provided |
|
|
Remove Empty Values
|
removeEmptyValues | boolean |
Set whether empty or null values should be removed from the array of values returned |
Returns
- Body
- DtoResponseSplitText
Utility - Text Contains Value
Check whether the text value provided contains a specified text value - https://support.encodian.com/hc/en-gb/articles/10515175130012/
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text to validate |
|
Value
|
value | True | string |
The value to check is contained within the 'Text' value |
|
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when validating the 'Text' value |
|
|
Comparison Configuration
|
comparisonConfiguration | string |
Specifies the rules to be used when processing the text values provided |
|
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Utility - Trim Text
Trim the text value provided aligined to the set configuration - https://support.encodian.com/hc/en-gb/articles/11769860640413
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Text
|
text | True | string |
The text value to process |
|
Trim Position
|
textTrimPosition | True | string |
Set whether to trim the text provided from the start position, end position or both |
|
Trim Characters
|
trimCharacters | string |
Optional - A list of characters (which can include white-space) to trim from the text provided, for example: &*yt^ :{ |
Returns
- Body
- DtoResponseTrimText
Utility - Unescape HTML
Unescape the HTML value provided - https://support.encodian.com/hc/en-gb/articles/11751174595357
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
HTML
|
html | True | string |
The HTML value to process |
Returns
Utility - Validate Email Address
Validate the email address provided - https://support.encodian.com/hc/en-gb/articles/9588817792925
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Email Address
|
emailAddress | True | string |
The email address to verify |
|
Regex
|
regex | True | string |
The regular expression used for validation |
Returns
Utility - Validate GUID
Validate whether the GUID provided is valid - https://support.encodian.com/hc/en-gb/articles/9601440603421
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
GUID
|
guid | True | string |
The GUID to validate |
Returns
Utility - Validate JSON
Validate the JSON data provided, optionally against a set schema - https://support.encodian.com/hc/en-gb/articles/12722049993500
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
JSON
|
json | True | string |
The JSON data to validate |
|
Schema
|
schema | string |
Optional - A JSON schema to apply to the validation |
Returns
Utility - Validate URL Availability
Validate whether the URL provided is available - https://support.encodian.com/hc/en-gb/articles/9224582350365
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
The URL to verify, please include https:// or http:// in your request |
|
Validate URL
|
validateURL | boolean |
Set whether the 'URL' provided should be validated prior to checking availability |
Returns
Utility - Validate URL Syntax
Validate whether the URL provided has valid syntax - https://support.encodian.com/hc/en-gb/articles/9601816944413
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
The URL syntax to validate, please include https:// or http:// in your request |
Returns
Triggers
| When a user runs a Trigr |
Manages subscribing to an Encodian Trigr Webhook |
When a user runs a Trigr
Manages subscribing to an Encodian Trigr Webhook
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Title
|
title | True | string |
The title of the Encodian Trigr |
|
Description
|
description | string |
Describe the purpose of this flow |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Site Address
|
site | string |
The SharePoint site address |
|
Library/List ID
|
libraryId | string |
The source SharePoint Library/List ID |
|
Library/List Name
|
libraryName | string |
The source SharePoint Library/List Name |
|
Item
|
item | integer |
The selected document/item ID, or the first selected document/item ID from the items array. |
|
items
|
items | array of integer |
documentIds |
|
Form Fields
|
formFields | string |
Dynamic form data provided by the user |
|
User Email Address
|
userEmail | string |
The email address of the user who triggered this flow |
|
File Identifier
|
fileIdentifier | string |
A single file identifier, or first file identifier in the File Identifiers array |
|
fileIdentifiers
|
fileIdentifiers | array of string |
File Identifiers |
Definitions
DocumentArray
| Name | Path | Type | Description |
|---|---|---|---|
|
Filename
|
fileName | string |
The filename of the file |
|
File Content
|
fileContent | byte |
The file content of the file |
DtoResponseAddAttachmentsToPdf
| 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. |
DtoResponseAddHtmlHeaderFooter
| 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. |
DtoResponseAddHtmlHeaderFooterWord
| 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. |
DtoResponseAddImageWatermark
| 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. |
DtoResponseAddImageWatermarkAdv
| 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. |
DtoResponseAddImageWatermarkToImage
| 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. |
DtoResponseAddImageWatermarkWord
| 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. |
DtoResponseAddPageNumbers
| 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. |
DtoResponseAddRowsToExcel
| 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. |
DtoResponseAddTextWatermark
| 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. |
DtoResponseAddTextWatermarkAdv
| 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. |
DtoResponseAddTextWatermarkToImage
| 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. |
DtoResponseAddTextWatermarkWord
| 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. |
DtoResponseAesDecryption
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseAesEncryption
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayAddItems
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayContainsValue
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseArrayConvertToJson
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayCountItems
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | integer |
The response value for the request |
|
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. |
DtoResponseArrayGetItems
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayRemoveDuplicates
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayRemoveItems
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayRemoveItemsRegex
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayReplaceValues
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseArrayReverseItems
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseBasicConversion
| 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. |
DtoResponseCalculateDate
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseCleanString
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseCompareText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseCompareWordDocuments
| 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. |
DtoResponseCompressPdf
| 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. |
DtoResponseCompressPowerPoint
| 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. |
DtoResponseConcatenateText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseConvertCad
| 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. |
DtoResponseConvertExcel
| 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. |
DtoResponseConvertJsonToExcel
| 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. |
DtoResponseConvertMailMessage
| 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. |
DtoResponseConvertPdfToImages
| Name | Path | Type | Description |
|---|---|---|---|
|
Documents
|
documents | array of DocumentArray |
The array of images generated 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. |
DtoResponseConvertPdfToJpg
| 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. |
DtoResponseConvertPdfToPng
| 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. |
DtoResponseConvertPdfToTiff
| 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. |
DtoResponseConvertPdfToWord
| 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. |
DtoResponseConvertPowerPoint
| 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. |
DtoResponseConvertTimeZone
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseConvertToPdfA
| 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. |
DtoResponseConvertVisio
| 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. |
DtoResponseConvertWord
| 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. |
DtoResponseCreateBarcode
| 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. |
DtoResponseCreateGuid
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseCreateHMAC
| Name | Path | Type | Description |
|---|---|---|---|
|
HMAC
|
hmac | string |
The computed HMAC |
|
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. |
DtoResponseCreateHashCode
| Name | Path | Type | Description |
|---|---|---|---|
|
Hash Code
|
HashCode | string |
The computed Hash Code |
|
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. |
DtoResponseCreateQrCode
| 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. |
DtoResponseCropImage
| 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. |
DtoResponseDeleteRowsFromExcel
| 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. |
DtoResponseDisableTrackedChanges
| 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. |
DtoResponseEnableTrackedChanges
| 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. |
DtoResponseEncodianSendToFiler
| Name | Path | Type | Description |
|---|---|---|---|
|
Response
|
response | string |
The JSON response returned by Encodian Filer |
|
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. |
DtoResponseEscapeHtml
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseExtractAllTextInstancesBetweenValues
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | array of string |
The response value for the request |
|
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. |
DtoResponseExtractAttachmentsFromPdf
| 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. |
DtoResponseExtractEmailAddressesFromText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | array of string |
The response value for the request |
|
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. |
DtoResponseExtractExcelWorksheets
| 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. |
DtoResponseExtractFromArchive
| Name | Path | Type | Description |
|---|---|---|---|
|
Documents
|
documents | array of DocumentArray |
The array of documents extracted from the archive provided |
|
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. |
DtoResponseExtractImage
| 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. |
DtoResponseExtractTextBetweenValues
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseExtractTextRegion
| 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. |
DtoResponseExtractUrlsFromText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | array of string |
The response value for the request |
|
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. |
DtoResponseFillPdfForm
| 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. |
DtoResponseFlattenPdf
| 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. |
DtoResponseFlipImage
| 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. |
DtoResponseFormatDate
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseFormatTextCase
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseGeneratePassword
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseGenerateRandomNumber
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | integer |
The response value for the request |
|
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. |
DtoResponseGetDateTimeDifference
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | integer |
The response value for the request |
|
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. |
DtoResponseGetEmailAttachments
| Name | Path | Type | Description |
|---|---|---|---|
|
Documents
|
documents | array of DocumentArray |
The array of documents extracted from the source Email |
|
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. |
DtoResponseGetEmailInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Subject
|
subject | string |
The subject of the email message |
|
Body - Text
|
bodyText | string |
The content of the email message as text |
|
Body - HTML
|
bodyHtml | string |
The content of the email message as HTML |
|
To
|
to | string |
A comma delimited list of email addresses from the 'To' property |
|
To - Array
|
toArray | array of string |
An array of email addresses obtained from the 'To' property |
|
Cc
|
cc | string |
A comma delimited list of email addresses obtained from the 'Cc' property |
|
Cc - Array
|
ccArray | array of string |
An array of email addresses obtained from the 'Cc' property |
|
Bcc
|
bcc | string |
A comma delimited list of email addresses obtained from the 'Bcc' property |
|
Bcc - Array
|
bccArray | array of string |
An array of email addresses obtained from the 'Bcc' property |
|
From
|
from | string |
The email address obtained from the 'From' property |
|
Sent
|
sent | date-time |
The date and time the email message was sent |
|
Priority
|
priority | string |
The priority of the email message |
|
Sensitivity
|
sensitivity | string |
The sensitivity of the email message |
|
Has Attachments
|
hasAttachments | boolean |
Indicates whether the email message contains attachments |
|
File Size (MBs)
|
fileSize | string |
The size of the email message (MBs) |
|
Message ID
|
messageId | string |
The message ID of the email message |
|
Headers
|
headers | array of string |
An array of headers obtained from the email message |
|
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. |
DtoResponseGetFileExtension
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseGetImageInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Image Format
|
imageFormat | string |
The file format of the image |
|
File Size (MBs)
|
fileSize | string |
The size of the supplied image in MBs |
|
Width
|
width | double |
The width of the image (Pixels) |
|
Height
|
height | double |
The height of the image (Pixels) |
|
Orientation
|
orientation | string |
The orientation of the image |
|
Bits per Pixel
|
bitsPerPixel | integer |
The image bits per pixel count |
|
Horizontal Resolution
|
horizontalResolution | double |
The horizontal image resolution (DPI) |
|
Vertical Resolution
|
verticalResolution | double |
The vertical image resolution (DPI) |
|
Has EXIF Data
|
hasExifData | boolean |
Confirms whether the image contains EXIF Data |
|
EXIF Data (JSON)
|
exifDataJson | string |
Image EXIF Data provided as a JSON string |
|
Has XMP Data
|
hasXmpData | boolean |
Confirms whether the image contains XMP Data |
|
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. |
DtoResponseGetPdfDocumentInfo
| 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. |
DtoResponseGetPdfFormData
| 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. |
DtoResponseGetPdfTextLayer
| 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. |
DtoResponseGetRowsFromExcel
| Name | Path | Type | Description |
|---|---|---|---|
|
Row Data
|
rowData | string |
Row data returned as a JSON formatted 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. |
DtoResponseGetTextFromWord
| Name | Path | Type | Description |
|---|---|---|---|
|
Text
|
text | string |
The text extracted from the word document provided |
|
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. |
DtoResponseGetTrackedChanges
| Name | Path | Type | Description |
|---|---|---|---|
|
JSON - Tracked Changes
|
trackedChangesJson | string |
A JSON formatted string containing tracked changes details |
|
JSON - Comments
|
commentsJson | string |
A JSON formatted string containing comments |
|
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. |
DtoResponseHtmlToPdf
| 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. |
DtoResponseHtmlToWord
| 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. |
DtoResponseImageCleanUpDoc
| 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. |
DtoResponseImageCleanUpPhoto
| 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. |
DtoResponseImageCompress
| 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. |
DtoResponseImageConvertFormat
| 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. |
DtoResponseImageExtractText
| Name | Path | Type | Description |
|---|---|---|---|
|
Text
|
Text | string |
The text layer extracted from the image. |
|
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. |
DtoResponseImageRemoveExifTags
| 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. |
DtoResponseImageResize
| 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. |
DtoResponseInsertHtmlToPdf
| 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. |
DtoResponseManageTrackedChanges
| 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. |
DtoResponseMergeArrayOfDocumentsToPdf
| 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. |
DtoResponseMergeArrayOfDocumentsToWord
| 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. |
DtoResponseMergeArrayOfExcelDocuments
| 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. |
DtoResponseMergeDocumentsToPdf
| 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. |
DtoResponseMergeExcelRows
| 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. |
DtoResponseMergePresentations
| 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. |
DtoResponseMgmtGetSubscriptionStatus
| Name | Path | Type | Description |
|---|---|---|---|
|
Available Actions
|
availableActionsMonth | integer |
The number of actions remaining for the current calendar month. |
|
Available Actions - Utility
|
availableActionsMonthDec | double |
The number of utility actions remaining for the current calendar month (as a decimal). |
|
Subscription Enabled
|
subscriptionEnabled | boolean |
Indicates whether the Encodian subscription is enabled or disabled. |
|
Subscription Level
|
subscriptionLevel | string |
Details the current Encodian subscription level. |
|
Monthly Actions
|
monthlyActions | integer |
Details the allowed actions per month for the current Encodian subscription level. |
|
Expiry Date
|
expiryDate | date-time |
The date and time your Encodian subscription will expire. |
|
Billing Interval
|
billingInterval | string |
Details the current billing interval (Monthly or Annually). |
|
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. |
DtoResponseOcrPdf
| 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. |
DtoResponseParseCsv
| Name | Path | Type | Description |
|---|---|---|---|
|
CSV Data
|
csvData | string |
The parsed CSV data in JSON format. |
|
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. |
DtoResponseParseHtmlTable
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponsePopulateExcel
| 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. |
DtoResponsePopulatePowerPoint
| 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. |
DtoResponsePopulateWordDocument
| 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. |
DtoResponseReadBarcodeFromDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
Barcodes
|
barcodes | array of string |
The value of the barcodes detected |
|
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. |
DtoResponseReadBarcodeFromImage
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
Value | string |
The value of the barcode |
|
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. |
DtoResponseReadQrCodeFromDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
QR Codes
|
qrCodes | array of string |
The value of the QR Codes detected |
|
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. |
DtoResponseReadQrCodeFromImage
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
Value | string |
The value of the QR Code |
|
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. |
DtoResponseRedactPdf
| 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. |
DtoResponseRegexSearchText
| Name | Path | Type | Description |
|---|---|---|---|
|
Matches
|
matches | array of string |
The matches found in the text provided |
|
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. |
DtoResponseRemoveDiacritics
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseRemoveHeaderFooterWord
| 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. |
DtoResponseRemoveTextBetweenValues
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseRemoveWatermarksFromPdf
| 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. |
DtoResponseRemoveWatermarksFromWord
| 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. |
DtoResponseRepairPdf
| 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. |
DtoResponseReplaceValueWithRegex
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseReplaceValueWithText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseResizePdf
| 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. |
DtoResponseRotateImage
| 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. |
DtoResponseSearchAndReplaceHyperlink
| 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. |
DtoResponseSearchAndReplaceText
| 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. |
DtoResponseSearchAndReplaceTextWithImage
| 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. |
DtoResponseSecurePdf
| 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. |
DtoResponseSecureWordDocument
| 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. |
DtoResponseSignPdf
| 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. |
DtoResponseSplitDocument
| 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. |
DtoResponseSplitPdfByBarcode
| 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. |
DtoResponseSplitPdfByText
| 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. |
DtoResponseSplitText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | array of string |
The response value for the request |
|
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. |
DtoResponseTextContainsValue
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseTextToPdf
| 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. |
DtoResponseTrimText
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseUnescapeHtml
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | string |
The response value for the request |
|
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. |
DtoResponseUnlockPdf
| 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. |
DtoResponseUpdateRowsInExcel
| 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. |
DtoResponseUpdateWordTableOfContents
| 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. |
DtoResponseValidateEmailAddress
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseValidateGuid
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseValidateJson
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseValidateUrlAvailability
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseValidateUrlSyntax
| Name | Path | Type | Description |
|---|---|---|---|
|
Result
|
result | boolean |
The response value for the request |
|
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. |
DtoResponseWordToPdfForm
| 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. |
DtoResponseZipArrayOfDocuments
| 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. |
TextRegionResult
| 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 |