Encodian - Convert
Convert 70+ file formats to new file formats
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Encodian Support |
URL | https://support.encodian.com |
support@encodian.com |
Connector Metadata | |
---|---|
Publisher | Encodian |
Website | https://www.encodian.com |
Privacy policy | https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy |
Categories | Content and Files;Collaboration |
The 'Encodian Flowr Convert' connector provide enterprise grade and simple to use Power Automate actions for convert files and data to another format. The connector provides support for more than 70+ common file types including CAD, Email, Excel, Images, HTML, JSON, PDF, Text, Visio, Word + more
The Encodian 'Flowr' Convert connector is supported by Power Automate, Azure Logic Apps and Power Apps.
An Encodian subscription is required to use the Encodian 'Flowr' Convert connector.
Complete the sign-up form to register for a 30-day trial and obtain an API Key
Click here for a step by step guide on how to create an Encodian connection in Power Automate
Contact Encodian Support to request assistance
Encodian action documentation can be found here, and example flows can be found here
Visit Encodian website for subscription plan pricing.
Once your 30-day trial expires, your Encodian subscription is automatically transitioned to Encodian's 'Free' subscription tier unless a paid plan has been purchased.
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Key | securestring | Get an API Key - https://www.encodian.com/apikey/ | True |
Region | string |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
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 an email and attachments to a single PDF document - 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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
Name | Path | Type | Description |
---|---|---|---|
Filename
|
fileName | string |
The filename of the file |
File Content
|
fileContent | byte |
The file content of the file |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
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. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |
Name | Path | Type | Description |
---|---|---|---|
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Filename
|
Filename | string |
The filename of the document. |
File Content
|
FileContent | byte |
The processed document. |