Word - Optimise

** AVAILABLE SEPTEMBER / OCTOBER 2024 **

Overview

The 'Word - Optimise' flow action optimises the content of the Microsoft Word document provided to the version selected. 

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Parameters

The default 'Word - Optimise' flow action parameters are detailed below:

• Filename: The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file'
• File Content: The file content of the source Microsoft Word file
• Version: A Base64 encoded representation of the image

File Content

Please refer to the Obtaining the 'File Contents' Parameter article for guidance on how to obtain the 'File Content' parameter ready to provide to an Encodian flow action. 

Advanced Parameters

The advanced 'Word - Optimise' flow action parameters are detailed below:

• Culture Name: This setting is used to set the culture for the document prior to conversion. Please refer to the Culture Names article for a list of supported cultures

Return Parameters

The 'Word - Replace Text with Image' flow action returns the following data. 

Standard Return Values

• FileContent - The processed document content (Base 64).
• OperationId - The unique ID assigned to this operation.
• HttpStatusCode - The HTTP Status code for the response.
• HttpStatusMessage - The HTTP Status message for the response.
• Errors - An array of error messages should an error occur.
• Operation Status - Indicates whether the operation has been completed, has been queued or has failed.