PDF - Flatten Fields

** AVAILABLE OCTOBER / NOVEMBER 2024 **

Overview

The 'PDF - Flatten Fields' action selectively flattens fields within the PDF Form or Document provided. Fields can be selected by providing either the field names as a comma separated list (field1, field2, field3, etc) or specific pages can be targeted by providing a comma separated list of page numbers (1,4,5, etc) where all fields found on the specific pages would be flattened. 

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.

Default Options

The default 'PDF - Flatten Fields' flow action parameters are detailed below:

• File Content: A Base64 encoded representation of the PDF file to be processed.
• Field Names: A comma-separated string of the field names of the fields which are to be flattened
• Page Numbers: A comma-separated string of page numbers which contain fields which are to be flattened

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.

Return Parameters

The 'PDF - Flatten Fields' flow action returns the following data. 

Action Specific Return Values

• File Content - The processed PDF file (Base64)

Standard Return Values

• 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.