File Processing lets you effortlessly create, process, convert and update files.
Status: Preview |
Tier: Premium |
Version: v1 |
Name |
Summary |
EditDocument_DocxGetComments (GetDocxGetCommentsRequest reqConfig) |
Get comments from a Word DOCX document as a flat list |
Detect, check if text string is base 64 encoded |
|
Base 64 encode, convert binary or file data to a text string |
|
Base 64 decode, convert base 64 string to binary content |
|
Detect text encoding of file |
|
Find a string in text input |
|
Find a regular expression regex in text input |
|
Replace a string in text with another string value |
|
Replace a string in text with a regex regular expression string |
|
Detect line endings of a text file |
|
EditText_ChangeLineEndings (string lineEndingType, file inputFile) |
Set, change line endings of a text file |
Remove HTML from text string |
|
EditText_RemoveAllWhitespace (RemoveWhitespaceFromTextRequest request) |
Remove whitespace from text string |
EditText_TrimWhitespace (RemoveWhitespaceFromTextRequest request) |
Trim leading and trailing whitespace from text string |
Validate if a file is executable |
|
Create a web-based viewer |
|
Compress files to create a new zip archive |
|
ZipArchive_ZipCreateAdvanced (CreateZipArchiveRequest request) |
Compress files and folders to create a new zip archive with advanced options |
Extract, decompress files and folders from a zip archive |
|
ZipArchive_ZipEncryptAdvanced (ZipEncryptionAdvancedRequest encryptionRequest) |
Encrypt and password protect a zip file |
Decrypt and remove password protection on a zip file |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Input file to perform the operation on. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get comments from a Word DOCX document as a flat list
Description: Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
Syntax:
CloudmersiveFileProcessing.EditDocument_DocxGetComments (GetDocxGetCommentsRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Word DOCX Document comments request |
True |
Returns:
Description: Result of getting comments from a Word Document DOCX
Summary: Detect, check if text string is base 64 encoded
Description: Checks, detects if input string is base 64 encoded
Syntax:
CloudmersiveFileProcessing.EditText_Base64Detect (Base64DetectRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to detect if input content is base 64 encoded |
True |
Returns:
Type:Base64DetectResponse
Description: Result of base 64 detection
Summary: Base 64 encode, convert binary or file data to a text string
Description: Encodes / converts binary or file data to a text string
Syntax:
CloudmersiveFileProcessing.EditText_Base64Encode (Base64EncodeRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to encode content to Base 64 |
True |
Returns:
Type:Base64EncodeResponse
Description: Result of base 64 encoding
Summary: Base 64 decode, convert base 64 string to binary content
Description: Decodes / converts base 64 UTF-8 text string to binary content
Syntax:
CloudmersiveFileProcessing.EditText_Base64Decode (Base64DecodeRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to decode content from Base 64 into binary |
True |
Returns:
Type:Base64DecodeResponse
Description: Result of base 64 decoding
Summary: Detect text encoding of file
Description: Checks text encoding of file
Syntax:
CloudmersiveFileProcessing.EditText_TextEncodingDetect (file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:TextEncodingDetectResponse
Description: Result of detecting text encoding
Summary: Find a string in text input
Description: Finds all occurrences of the input string in the input content, and returns the matches
Syntax:
CloudmersiveFileProcessing.EditText_FindSimple (FindStringSimpleRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to find a string in a string |
True |
Returns:
Description: Result of finding a string
Summary: Find a regular expression regex in text input
Description: Find all occurrences of the input regular expression in the input content, and returns the matches
Syntax:
CloudmersiveFileProcessing.EditText_FindRegex (FindStringRegexRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to find a string in a string |
True |
Returns:
Description: Result of finding a string
Summary: Replace a string in text with another string value
Description: Replaces all occurrences of the input string in the input content, and returns the result
Syntax:
CloudmersiveFileProcessing.EditText_ReplaceSimple (ReplaceStringSimpleRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to replace a string in a string |
True |
Returns:
Type:ReplaceStringSimpleResponse
Description: Result of replacing a string
Summary: Replace a string in text with a regex regular expression string
Description: Replaces all occurrences of the input regular expression regex string in the input content, and returns the result
Syntax:
CloudmersiveFileProcessing.EditText_ReplaceRegex (ReplaceStringRegexRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to replace a regex string in a string |
True |
Returns:
Type:ReplaceStringRegexResponse
Description: Result of replacing a regex string
Summary: Detect line endings of a text file
Description: Detect line ending type (Windows, Unix or Mac) of an input file.
Syntax:
CloudmersiveFileProcessing.EditText_DetectLineEndings (file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:DetectLineEndingsResponse
Description: Result of base 64 decoding
Summary: Set, change line endings of a text file
Description: Sets the line ending type of a text file; set to Windows, Unix or Mac.
Syntax:
CloudmersiveFileProcessing.EditText_ChangeLineEndings (string lineEndingType, file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
lineEndingType |
string (Required; 'Windows' will use carriage return and line feed, 'Unix' wil) |
Required; 'Windows' will use carriage return and line feed, 'Unix' wil |
True |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Description: Result of performing a change line ending operation
Summary: Remove HTML from text string
Description: Removes HTML from text, leaving behind only text. Formatted text will become plain text. Important for protecting against HTML and Cross-Site-Scripting attacks.
Syntax:
CloudmersiveFileProcessing.EditText_RemoveHtml (RemoveHtmlFromTextRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to remove HTML from a string |
True |
Returns:
Type:RemoveHtmlFromTextResponse
Description: Result of removing HTML from a string
Summary: Remove whitespace from text string
Description: Removes all whitespace from text, leaving behind only non-whitespace characters. Whitespace includes newlines, spaces and other whitespace characters.
Syntax:
CloudmersiveFileProcessing.EditText_RemoveAllWhitespace (RemoveWhitespaceFromTextRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
RemoveWhitespaceFromTextRequest
|
Request to remove whitespace from a string |
True |
Returns:
Type:RemoveWhitespaceFromTextResponse
Description: Result of removing whitespace from a string
Summary: Trim leading and trailing whitespace from text string
Description: Trim leading and trailing whitespace from text, leaving behind a trimmed string. Whitespace includes newlines, spaces and other whitespace characters.
Syntax:
CloudmersiveFileProcessing.EditText_TrimWhitespace (RemoveWhitespaceFromTextRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
RemoveWhitespaceFromTextRequest
|
Request to remove whitespace from a string |
True |
Returns:
Type:RemoveWhitespaceFromTextResponse
Description: Result of removing whitespace from a string
Summary: Validate if a file is executable
Description: Validate if an input file is a binary executable file; if the document is not valid
Syntax:
CloudmersiveFileProcessing.ValidateDocument_ExecutableValidation (file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Description: Document validation result
Summary: Create a web-based viewer
Description: Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
Syntax:
CloudmersiveFileProcessing.ViewerTools_CreateSimple (file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:ViewerResponse
Description: Result of creating a viewer
Summary: Compress files to create a new zip archive
Description: Create a new zip archive by compressing input files.
Syntax:
CloudmersiveFileProcessing.ZipArchive_ZipCreate (file inputFile1, [Optional]file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile1 |
(First input file to perform the operation on.) |
First input file to perform the operation on. |
True |
|
inputFile2 |
(Second input file to perform the operation on.) |
Second input file to perform the operation on. |
False |
|
inputFile3 |
(Third input file to perform the operation on.) |
Third input file to perform the operation on. |
False |
|
inputFile4 |
(Fourth input file to perform the operation on.) |
Fourth input file to perform the operation on. |
False |
|
inputFile5 |
(Fifth input file to perform the operation on.) |
Fifth input file to perform the operation on. |
False |
|
inputFile6 |
(Sixth input file to perform the operation on.) |
Sixth input file to perform the operation on. |
False |
|
inputFile7 |
(Seventh input file to perform the operation on.) |
Seventh input file to perform the operation on. |
False |
|
inputFile8 |
(Eighth input file to perform the operation on.) |
Eighth input file to perform the operation on. |
False |
|
inputFile9 |
(Ninth input file to perform the operation on.) |
Ninth input file to perform the operation on. |
False |
|
inputFile10 |
(Tenth input file to perform the operation on.) |
Tenth input file to perform the operation on. |
False |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Compress files and folders to create a new zip archive with advanced options
Description: Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.
Syntax:
CloudmersiveFileProcessing.ZipArchive_ZipCreateAdvanced (CreateZipArchiveRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
Request to create a Zip Archive |
True |
Returns:
Type:ZipArchive_ZipCreateAdvancedResponse
Summary: Extract, decompress files and folders from a zip archive
Description: Extracts a zip archive by decompressing files, and folders.
Syntax:
CloudmersiveFileProcessing.ZipArchive_ZipExtract (file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:ZipExtractResponse
Description: Result of performing a zip extract operation
Summary: Encrypt and password protect a zip file
Description: Encrypts and password protects an existing zip file with the specified password and encryption algorithm
Syntax:
CloudmersiveFileProcessing.ZipArchive_ZipEncryptAdvanced (ZipEncryptionAdvancedRequest encryptionRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
encryptionRequest |
|
Request to encrypt an existing Zip Archive file and protect it with a password |
True |
Returns:
Type:ZipArchive_ZipEncryptAdvancedResponse
Summary: Decrypt and remove password protection on a zip file
Description: Decrypts and removes password protection from an encrypted zip file with the specified password
Syntax:
CloudmersiveFileProcessing.ZipArchive_ZipDecrypt (file inputFile, string zipPassword)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
zipPassword |
string (Required; Password for the input archive) |
Required; Password for the input archive |
True |
Returns:
Type:ZipArchive_ZipDecryptResponse
Summary:
Description: Request to decode content from Base 64 into binary
Properties:
Name |
Type |
Summary |
Base64ContentToDecode |
string
|
Input content to decode from Base 64 into binary |
Summary:
Description: Result of base 64 decoding
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
ContentResult |
string(byte)
|
Result of performing a base 64 decode operation, binary file content |
Summary:
Description: Request to detect if input content is base 64 encoded
Properties:
Name |
Type |
Summary |
Base64ContentToDetect |
string
|
Input content text to detect if it is base 64 encoded |
Summary:
Description: Result of base 64 detection
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
IsBase64Encoded |
boolean
|
True if the input string is base 64 encoded, false otherwise |
Summary:
Description: Request to encode content to Base 64
Properties:
Name |
Type |
Summary |
ContentToEncode |
string(byte)
|
Input content to encode into Base 64 |
Summary:
Description: Result of base 64 encoding
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Base64TextContentResult |
string
|
Result of performing a base 64 encoding operation, a text string representing the encoded original file content |
Summary:
Description: Result of performing a change line ending operation
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Text content result |
Summary:
Description: Request to create a Zip Archive
Properties:
Name |
Type |
Summary |
FilesInZip |
array of (ZipFile)
|
Top-level files in the root directory fo the zip file |
DirectoriesInZip |
array of (ZipDirectory)
|
Top-level directories in the root directory of the zip; directories can contain sub-directories and files |
Summary:
Description: Result of base 64 decoding
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
PrimaryNewlineType |
string
|
Type of newline in the file; possible vlaues are "Mac" (legacy Mac OS uses carriage return only); "Unix" (Unix and Linux OSes, and modern Mac OS); "Windows" (Windows operating systems) |
PrimaryNewlineTerminator |
string
|
Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed |
InputLength |
integer(int32)
|
Length of the input string in characters |
Summary:
Description: Validation error found in document
Properties:
Name |
Type |
Summary |
Description |
string
|
Description of the error |
Path |
string
|
XPath to the error |
Uri |
string
|
URI of the part in question |
IsError |
boolean
|
True if this is an error, false otherwise |
Summary:
Description: Document validation result
Properties:
Name |
Type |
Summary |
DocumentIsValid |
boolean
|
True if the document is valid and has no errors, false otherwise |
PasswordProtected |
boolean
|
True if the document is password protected, false otherwise |
ErrorCount |
integer(int32)
|
Number of validation errors found in the document |
WarningCount |
integer(int32)
|
Number of validation warnings found in the document |
ErrorsAndWarnings |
array of (DocumentValidationError)
|
Details of errors and warnings found |
Summary:
Description: Comment in a Word Document
Properties:
Name |
Type |
Summary |
Path |
string
|
Path to the comment in the document |
Author |
string
|
Author name of the comment |
AuthorInitials |
string
|
Initials of the author of the comment |
CommentText |
string
|
Text content of the comment |
CommentDate |
string(date-time)
|
Date timestamp of the comment |
IsTopLevel |
boolean
|
True if the comment is at the top level, false if this comment is a child reply of another comment |
IsReply |
boolean
|
True if this comment is a reply to another comment, false otherwise |
ParentCommentPath |
string
|
Path to the parent of this comment, if this comment is a reply, otherwise this value will be null |
Done |
boolean
|
True if this comment is marked as Done in Word, otherwise it is false |
Summary: Input file to perform the operation on.
Description: Input file to perform the operation on.
Properties:
Name |
Type |
Summary |
Summary:
Description: Individual regular expression match result of finding a target regex in a longer text string
Properties:
Name |
Type |
Summary |
CharacterOffsetStart |
integer(int32)
|
0-based index of the start of the match |
CharacterOffsetEnd |
integer(int32)
|
0-based index of the end of the match |
ContainingLine |
string
|
Text content of the line containing the match |
MatchValue |
string
|
The match value |
MatchGroups |
array of (string)
|
Regular expression regex match groups; these correspond to the match values |
Summary:
Description: Individual match result of finding a target string in a longer text string
Properties:
Name |
Type |
Summary |
CharacterOffsetStart |
integer(int32)
|
0-based index of the start of the match |
CharacterOffsetEnd |
integer(int32)
|
0-based index of the end of the match |
ContainingLine |
string
|
Text content of the line containing the match |
Summary:
Description: Request to find a string in a string
Properties:
Name |
Type |
Summary |
TextContent |
string
|
Input text content |
TargetRegex |
string
|
Target input regular expression (regex) to find |
MatchCase |
boolean
|
Set to True to match case, False to ignore case |
Summary:
Description: Result of finding a string
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Matches |
array of (FindRegexMatch)
|
Regular expression matches |
MatchCount |
integer(int32)
|
The number of matches |
Summary:
Description: Request to find a string in a string
Properties:
Name |
Type |
Summary |
TextContent |
string
|
Input text content |
TargetString |
string
|
Target input string to find |
Summary:
Description: Result of finding a string
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Matches |
array of (FindStringMatch)
|
Found matches |
MatchCount |
integer(int32)
|
The number of matches |
Summary:
Description: Result of getting comments from a Word Document DOCX
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Comments |
array of (DocxComment)
|
Comments in the document |
CommentCount |
integer(int32)
|
The number of comments in the document |
Summary:
Description: Input to a Get Word DOCX Document comments request
Properties:
Name |
Type |
Summary |
InputFileBytes |
string(byte)
|
Optional: Bytes of the input file to operate on |
InputFileUrl |
string
|
Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). |
Summary:
Description: Request to remove HTML from a string
Properties:
Name |
Type |
Summary |
TextContainingHtml |
string
|
Input text string to remove the HTML from |
Summary:
Description: Result of removing HTML from a string
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Result of performing a remove HTML from string operation |
Summary:
Description: Request to remove whitespace from a string
Properties:
Name |
Type |
Summary |
TextContainingWhitespace |
string
|
Input text string to remove the whitespace from |
Summary:
Description: Result of removing whitespace from a string
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Result of performing a remove whitespace from string operation |
Summary:
Description: Request to replace a regex string in a string
Properties:
Name |
Type |
Summary |
TextContent |
string
|
Input text content |
RegularExpressionString |
string
|
Target input regular expression (regex) string to match and be replaced; supports all regular expression values |
ReplaceWithString |
string
|
Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on |
Summary:
Description: Result of replacing a regex string
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Result of performing a base 64 decode operation, binary file content |
Summary:
Description: Request to replace a string in a string
Properties:
Name |
Type |
Summary |
TextContent |
string
|
Input text content |
TargetString |
string
|
Target input string to match and be replaced |
ReplaceWithString |
string
|
Replacement for target string |
Summary:
Description: Result of replacing a string
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Result of performing a replace string operation |
Summary:
Description: Result of detecting text encoding
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextEncoding |
string
|
Text encoding used in file; possible values are ASCII, UTF7, UTF8, UTF16, BigEndianUnicode and UTF32 |
Summary:
Description: Result of creating a viewer
Properties:
Name |
Type |
Summary |
HtmlEmbed |
string
|
|
Successful |
boolean
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Representation of a directory in a zip file
Properties:
Name |
Type |
Summary |
DirectoryName |
string
|
Name of this directory |
DirectoriesInDirectory |
array of (ZipDirectory)
|
Child directories contained directly in this directory |
FilesInDirectory |
array of (ZipFile)
|
Child files contained directly in this directory |
Summary:
Description: Request to encrypt an existing Zip Archive file and protect it with a password
Properties:
Name |
Type |
Summary |
InputFileContents |
string(byte)
|
Input Zip File archive contents in bytes |
Password |
string
|
Password to place on the Zip file; the longer the password, the more secure |
EncryptionAlgorithm |
string
|
Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256. |
Summary:
Description: Result of performing a zip extract operation
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if the operation was successful, false otherwise |
FilesInZip |
array of (ZipFile)
|
Top-level files in the root directory fo the zip file |
DirectoriesInZip |
array of (ZipDirectory)
|
Top-level directories in the root directory of the zip; directories can contain sub-directories and files |
Summary:
Description: Representation of a file in a zip file
Properties:
Name |
Type |
Summary |
FileName |
string
|
Name of this file |
FileContents |
string(byte)
|
Contents of this file |