Encodian - Word (Preview)

  • Reference

Extensive features for the manipulation and creation of Word 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)
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' Word for Power Automate

The 'Encodian Flowr Word' connector provide enterprise grade and simple to use Power Automate actions for creating, merging, splitting and manipulating Word documents.

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

Register Account

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

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
Word - Add Image Watermark

Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361
Word - Add Text Watermark

Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593
Word - Compare

Compare differences between Microsoft Word Documents - https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents
Word - Delete Pages

Delete specified pages from the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/14903494355996
Word - Disable Tracked Changes

Disable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695370804125
Word - Enable Tracked Changes

Enable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695385009053
Word - Extract Pages

Extract specified pages from the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/14902696561948
Word - Extract Text

Extract text contained within the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/10583756977180
Word - Extract Tracked Changes

Extract all the tracked changes (Revisions and comments) for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6634950400669
Word - Manage Tracked Changes

Process Tracked Changes within the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10074318228765
Word - Merge Files

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
Word - Populate

Populate a Microsoft Word Document (DOCX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document
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
Word - Remove Table of Contents

Remove the 'Table of Contents' from the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/14544663512860
Word - Remove Watermark

Remove the watermark from the Word file provided - https://support.encodian.com/hc/en-gb/articles/7752587767965
Word - Replace Text With Image

Find and replace text contained within a Word document with an image - https://support.encodian.com/hc/en-gb/articles/15089626493340
Word - Secure

Secure and protect a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/6634150180253
Word - Split

Split the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/14575340646940
Word - Update Hyperlinks

Find and update hyperlinks contained within a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7136687719837
Word - Update Table of Contents

Update the 'Table of Contents' in the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10594864447260

Word - Add Headers and Footers

Operation ID:
Word_AddHtmlHeaderFooterWord

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

Body
DtoResponseAddHtmlHeaderFooterWord

Word - Add Image Watermark

Operation ID:
Word_AddImageWatermarkWord

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

Body
DtoResponseAddImageWatermarkWord

Word - Add Text Watermark

Operation ID:
Word_AddTextWatermarkWord

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

Body
DtoResponseAddTextWatermarkWord

Word - Compare

Operation ID:
Word_CompareWordDocuments

Compare differences between Microsoft Word 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

Body
DtoResponseCompareWordDocuments

Word - Delete Pages

Operation ID:
Word_DeleteWordPages

Delete specified pages from the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/14903494355996

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 Microsoft Word file
Start Page
 startPage integer

Set the page number to begin deleting pages from
End Page
 endPage integer

Set the page number to stop deleting pages on. The default value is set to the last page of the Microsoft Word document provided
Page Numbers
 pageNumbers string

A comma separated list of page numbers of the pages to delete: 1,3,4
Culture Name
 cultureName string

Change the thread culture used to process the request

Returns

Body
DtoResponseDeleteWordPages

Word - Disable Tracked Changes

Operation ID:
Word_DisableTrackedChanges

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

Body
DtoResponseDisableTrackedChanges

Word - Enable Tracked Changes

Operation ID:
Word_EnableTrackedChanges

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

Body
DtoResponseEnableTrackedChanges

Word - Extract Pages

Operation ID:
Word_ExtractWordPages

Extract specified pages from the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/14902696561948

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 Microsoft Word file
Start Page
 startPage integer

Set the page number to begin extracting pages from
End Page
 endPage integer

Set the page number to stop extracting pages on. The default value is set to the last page of the Microsoft Word document provided
Page Numbers
 pageNumbers string

A comma separated list of page numbers of the pages to extract: 1,3,4
Culture Name
 cultureName string

Change the thread culture used to process the request

Returns

Body
DtoResponseExtractWordPages

Word - Extract Text

Operation ID:
Word_GetTextFromWord

Extract 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

Body
DtoResponseGetTextFromWord

Word - Extract Tracked Changes

Operation ID:
Word_GetTrackedChanges

Extract 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

Body
DtoResponseGetTrackedChanges

Word - Manage Tracked Changes

Operation ID:
Word_ManageTrackedChanges

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

Body
DtoResponseManageTrackedChanges

Word - Merge Files

Operation ID:
Word_MergeArrayOfDocumentsToWord

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

Body
DtoResponseMergeArrayOfDocumentsToWord

Word - Populate

Operation ID:
Word_PopulateWordDocument

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

Body
DtoResponsePopulateWordDocument

Word - Remove Headers and Footers

Operation ID:
Word_RemoveHeaderFooterWord

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

Body
DtoResponseRemoveHeaderFooterWord

Word - Remove Table of Contents

Operation ID:
Word_RemoveWordTableOfContents

Remove the 'Table of Contents' from the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/14544663512860

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
Table Of Contents Indexes
 tableOfContentsIndexes string

Set the index number(s) of the Tables of Contents to be removed

Returns

Body
DtoResponseRemoveWordTableOfContents

Word - Remove Watermark

Operation ID:
Word_RemoveWatermarksFromWord

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

Body
DtoResponseRemoveWatermarksFromWord

Word - Replace Text With Image

Operation ID:
Word_WordReplaceTextWithImage

Find and replace text contained within a Word document with an image - https://support.encodian.com/hc/en-gb/articles/15089626493340

Parameters

Name Key Required Type Description
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
Search Text
 SearchText True string

The text to locate and replace with the specified image
Image File Content
 imageFileContent True byte

The content of the image file
Skip First Page
 skipFirstPage boolean

Set whether to ignore the first page when searching for the text fragment
Apply To
 applyTo string

Set which pages within the document to search for the text fragment
Page Numbers
 pageNumbers string

Specify the page numbers to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'.
Ignore Page Numbers
 pageNumbersIgnore string

Specify the page numbers not to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'.
Culture Name
 cultureName string

Change the thread culture used to process the request

Returns

Body
DtoResponseWordReplaceTextWithImage

Word - Secure

Operation ID:
Word_SecureWordDocument

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

Body
DtoResponseSecureWordDocument

Word - Split

Operation ID:
Word_SplitWordDocument

Split the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/14575340646940

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 Microsoft Word file
Split Type
 splitType True string

Select how to split the file
Split Configuration
 splitConfiguration string

Provide a split configuration
Culture Name
 cultureName string

Change the thread culture used to process the request

Returns

Body
DtoResponseSplitWordDocument

Word - Update Hyperlinks

Operation ID:
Word_SearchAndReplaceHyperlink

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

Body
DtoResponseSearchAndReplaceHyperlink

Word - Update Table of Contents

Operation ID:
Word_UpdateWordTableOfContents

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

Body
DtoResponseUpdateWordTableOfContents

Definitions

DocumentArray

Name Path Type Description
Filename
 fileName string

The filename of the file
File Content
 fileContent byte

The file content of the file

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.

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.

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.

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.

DtoResponseDeleteWordPages

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.

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.

DtoResponseExtractWordPages

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.

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.

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.

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.

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.

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.

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.

DtoResponseRemoveWordTableOfContents

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.

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.

DtoResponseSplitWordDocument

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.

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.

DtoResponseWordReplaceTextWithImage

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.