Share via

Encodian - General

  • Reference

A collection of features covering AI, Archives (ZIP), Email + 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 Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Contact
Name Encodian Support
URL https://support.encodian.com
Email 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

Encodian 'Flowr' General for Power Automate

The 'Encodian Flowr General' connector provides a collection of enterprise grade and simple to use Power Automate actions covering email data extraction, AI (Translation, Classification + more), archive creation and data extraction, + lots more

The Encodian 'Flowr' General connector is supported by Power Automate, Azure Logic Apps and Power Apps.

Register Account

An Encodian subscription is required to use the Encodian 'Flowr' General 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

Support

Contact Encodian Support to request assistance

Encodian action documentation can be found here, and example flows can be found here

Further Information

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.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

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

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

AI - Translate File

Translate the file provided into the designated language - https://support.encodian.com/hc/en-gb/articles/13790274285724
AI - Translate Text (Multiple)

Translate the text provided into multiple designated languages - https://support.encodian.com/hc/en-gb/articles/13670267593628
AI - Translate Text (Single)

Translate the text provided into a single designated language - https://support.encodian.com/hc/en-gb/articles/13568846675996
Archive (ZIP) - Create

Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP
Archive (ZIP) - Extract

Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/11853992723484
Email - Extract Attachments

Extract attachments from the email provided and return an array of files - https://support.encodian.com/hc/en-gb/articles/10531671561629
Email - Extract Metadata

Extract detailed information about the email provided (Email Format, Sender, Priority + more) - https://support.encodian.com/hc/en-gb/articles/12237799140252
File - 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
File - 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

AI - Translate File

Operation ID:
General_AITranslateFile

Translate the file provided into the designated language - https://support.encodian.com/hc/en-gb/articles/13790274285724

Parameters

Name Key Required Type Description
Filename
 fileName True string

The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'
File Content
 fileContent True byte

The file content of the source file
Source Language
 sourceLanguage string

The language of the source file, select 'AUTO' to automatically detect
Target Language
 targetLanguage True string

The language to convert the source file to

Returns

Body
DtoResponseAITranslateFile

AI - Translate Text (Multiple)

Operation ID:
General_AITranslateTextMultiple

Translate the text provided into multiple designated languages - https://support.encodian.com/hc/en-gb/articles/13670267593628

Parameters

Name Key Required Type Description
Text
 text True string

The text to translate
Source Language
 sourceLanguage string

The language of the source text, select 'AUTO' to automatically detect
Target Languages
 targetLanguages True array of string

The languages to convert the source 'Text' value to
Format
 format string

Set the format of the 'Text' value
Profanity Action
 profanityAction string

Define how to handle profanity detected within the 'Text' value
Profanity Replace
 profanityReplace string

Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'

Returns

Body
DtoResponseAITranslateTextMultiple

AI - Translate Text (Single)

Operation ID:
General_AITranslateText

Translate the text provided into a single designated language - https://support.encodian.com/hc/en-gb/articles/13568846675996

Parameters

Name Key Required Type Description
Text
 text True string

The text to translate
Source Language
 sourceLanguage string

The language of the source text, select 'AUTO' to automatically detect
Target Language
 targetLanguage True string

The language to convert the source 'Text' value to
Format
 format string

Set the format of the 'Text' value
Profanity Action
 profanityAction string

Define how to handle profanity detected within the 'Text' value
Profanity Replace
 profanityReplace string

Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'

Returns

Body
DtoResponseAITranslateText

Archive (ZIP) - Create

Operation ID:
General_AddToZip

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

Body
DtoResponseZipArrayOfDocuments

Archive (ZIP) - Extract

Operation ID:
General_ExtractFromArchive

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

Body
DtoResponseExtractFromArchive

Email - Extract Attachments

Operation ID:
General_GetEmailAttachments

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

Body
DtoResponseGetEmailAttachments

Email - Extract Metadata

Operation ID:
General_GetEmailInfo

Extract 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

Body
DtoResponseGetEmailInfo

File - Replace Text with Image

Operation ID:
General_SearchAndReplaceTextWithImage

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

Body
DtoResponseSearchAndReplaceTextWithImage

File - Search and Replace Text

Operation ID:
General_SearchAndReplaceText

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

Body
DtoResponseSearchAndReplaceText

Definitions

DocumentArray

Name Path Type Description
Filename
 fileName string

The filename of the file
File Content
 fileContent byte

The file content of the file

DtoResponseAITranslateFile

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.

DtoResponseAITranslateText

Name Path Type Description
Translation
 translation string

The translated text
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.

DtoResponseAITranslateTextMultiple

Name Path Type Description
Translations
 translations string

The translated text as JSON
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.

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.

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.

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.

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.