Convert API lets you effortlessly convert file formats and types.
Status: Preview |
Tier: Premium |
Version: v1 |
Name |
Summary |
Get document type information |
|
Convert Document to PDF |
|
Convert Document to PNG array |
|
ConvertDocument_AutodetectToTxt (file inputFile, [Optional]string textFormattingMode) |
Convert Document to Text (txt) |
Compare Two Word DOCX |
|
Convert CSV to JSON conversion |
|
Convert CSV to Excel XLSX Spreadsheet |
|
Convert Word DOC (97-03) Document to DOCX |
|
Convert Word DOC (97-03) Document to PDF |
|
Convert Word DOC (97-03) Document to Text (txt) |
|
Convert Word DOCX Document to PDF |
|
ConvertDocument_DocxToTxt (file inputFile, [Optional]string textFormattingMode) |
Convert Word DOCX Document to Text (txt) |
Begin editing a document |
|
EditDocument_DocxCreateBlankDocument (CreateBlankDocxRequest input) |
Create a blank Word DOCX document |
EditDocument_DocxDeletePages (RemoveDocxPagesRequest reqConfig) |
Delete, remove pages from a Word DOCX document |
EditDocument_DocxDeleteTableRow (DeleteDocxTableRowRequest reqConfig) |
Deletes a table row in an existing table in a Word DOCX document |
EditDocument_DocxDeleteTableRowRange (DeleteDocxTableRowRangeRequest reqConfig) |
Deletes a range of multiple table rows in an existing table in a Word |
Get body from a Word DOCX document |
|
EditDocument_DocxGetCommentsHierarchical (GetDocxGetCommentsHierarchicalRequest reqConfig) |
Get comments from a Word DOCX document hierarchically |
EditDocument_DocxGetHeadersAndFooters (GetDocxHeadersAndFootersRequest reqConfig) |
Get content of a footer from a Word DOCX document |
Get images from a Word DOCX document |
|
Get pages and content from a Word DOCX document |
|
EditDocument_DocxGetSections (GetDocxSectionsRequest reqConfig) |
Get sections from a Word DOCX document |
Get styles from a Word DOCX document |
|
EditDocument_DocxGetTableRow (GetDocxTableRowRequest reqConfig) |
Gets the contents of an existing table row in an existing table in a W |
EditDocument_DocxGetTableByIndex (GetDocxTableByIndexRequest reqConfig) |
Get a specific table by index in a Word DOCX document |
Get all tables in Word DOCX document |
|
EditDocument_DocxInsertCommentOnParagraph (DocxInsertCommentOnParagraphRequest reqConfig) |
Insert a new comment into a Word DOCX document attached to a paragraph |
EditDocument_DocxInsertImage (DocxInsertImageRequest reqConfig) |
Insert image into a Word DOCX document |
EditDocument_DocxInsertParagraph (InsertDocxInsertParagraphRequest reqConfig) |
Insert a new paragraph into a Word DOCX document |
EditDocument_DocxInsertTable (InsertDocxTablesRequest reqConfig) |
Insert a new table into a Word DOCX document |
EditDocument_DocxInsertTableRow (InsertDocxTableRowRequest reqConfig) |
Insert a new row into an existing table in a Word DOCX document |
EditDocument_DocxRemoveHeadersAndFooters (RemoveDocxHeadersAndFootersRequest reqConfig) |
Remove headers and footers from Word DOCX document |
EditDocument_DocxRemoveObject (DocxRemoveObjectRequest reqConfig) |
Delete any object in a Word DOCX document |
Replace string in Word DOCX document |
|
Set the footer in a Word DOCX document |
|
EditDocument_DocxSetFooterAddPageNumber (DocxSetFooterAddPageNumberRequest reqConfig) |
Add page number to footer in a Word DOCX document |
Set the header in a Word DOCX document |
|
EditDocument_DocxUpdateTableCell (UpdateDocxTableCellRequest reqConfig) |
Update, set contents of a table cell in an existing table in a Word DO |
EditDocument_DocxUpdateTableRow (UpdateDocxTableRowRequest reqConfig) |
Update, set contents of a table row in an existing table in a Word DOCX document |
Finish editing document, and download result from document editing |
|
EditDocument_PptxDeleteSlides (RemovePptxSlidesRequest reqConfig) |
Delete, remove slides from a PowerPoint PPTX presentation document |
Replace string in PowerPoint PPTX presentation |
|
EditDocument_XlsxClearCellByIndex (ClearXlsxCellRequest input) |
Clear cell contents in an Excel XLSX spreadsheet, worksheet by index |
EditDocument_XlsxCreateBlankSpreadsheet (CreateBlankSpreadsheetRequest input) |
Create a blank Excel XLSX spreadsheet |
EditDocument_XlsxCreateSpreadsheetFromData (CreateSpreadsheetFromDataRequest input) |
Create a new Excel XLSX spreadsheet from column and row data |
EditDocument_XlsxDeleteWorksheet (RemoveXlsxWorksheetRequest reqConfig) |
Delete, remove worksheet from an Excel XLSX spreadsheet document |
EditDocument_XlsxGetCellByIdentifier (GetXlsxCellByIdentifierRequest input) |
Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier |
Get cell from an Excel XLSX spreadsheet, worksheet by index |
|
Get rows and cells from a Excel XLSX spreadsheet, worksheet |
|
Get images from a Excel XLSX spreadsheet, worksheet |
|
EditDocument_XlsxGetRowsAndCells (GetXlsxRowsAndCellsRequest input) |
Get rows and cells from a Excel XLSX spreadsheet, worksheet |
Get styles from a Excel XLSX spreadsheet, worksheet |
|
EditDocument_XlsxGetWorksheets (GetXlsxWorksheetsRequest input) |
Get worksheets from a Excel XLSX spreadsheet |
EditDocument_XlsxInsertWorksheet (InsertXlsxWorksheetRequest input) |
Insert a new worksheet into an Excel XLSX spreadsheet |
EditDocument_XlsxSetCellByIdentifier (SetXlsxCellByIdentifierRequest input) |
Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c |
Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index |
|
Convert HTML to Word DOCX Document |
|
Convert HTML document file to PDF Document |
|
Convert HTML document file to PNG image array |
|
HTML Document file to Text (txt) |
|
ConvertImage_MultipageImageFormatConvert (string format1, string format2, file inputFile) |
Multi-page image format conversion |
Get information about an image |
|
Change image DPI |
|
ConvertImage_ImageFormatConvert (string format1, string format2, file inputFile) |
Image format conversion |
ConvertData_JsonToXml (ConvertData_JsonToXmlParameterJsonObject JsonObject) |
Convert JSON to XML conversion |
Merge Two Word DOCX Together |
|
Merge Multple Word DOCX Together |
|
Merge Two PDF Files Together |
|
Merge Multple PDF Files Together |
|
Merge Multple PNG Files Together |
|
Merge Two PowerPoint PPTX Together |
|
Merge Multple PowerPoint PPTX Together |
|
Merge Two Text (TXT) Files Together |
|
Merge Multple Text (TXT) Files Together |
|
Merge Two Excel XLSX Together |
|
Merge Multple Excel XLSX Together |
|
Convert PDF to Word DOCX Document |
|
Convert PDF to Word DOCX Document based on rasterized version of the PDF |
|
Convert PDF to PNG Image Array |
|
Convert PDF to Single PNG image |
|
Convert PDF to PowerPoint PPTX Presentation |
|
ConvertDocument_PdfToTxt (file inputFile, [Optional]string textFormattingMode) |
Convert PDF Document to Text (txt) |
Convert PNG Array to PDF |
|
Convert PowerPoint PPT (97-03) Presentation to PDF |
|
Convert PowerPoint PPT (97-03) Presentation to PPTX |
|
Convert PowerPoint PPTX Presentation to PDF |
|
Convert PowerPoint PPTX Presentation to Text (txt) |
|
SplitDocument_Docx (file inputFile, [Optional]boolean returnDocumentContents) |
Split a single Word Document DOCX into Separate Documents by Page |
SplitDocument_PdfByPage (file inputFile, [Optional]boolean returnDocumentContents) |
Split a PDF file into separate PDF files, one per page |
SplitDocument_Pptx (file inputFile, [Optional]boolean returnDocumentContents) |
Split a single PowerPoint Presentation PPTX into Separate Slides |
Split a single Text file (txt) into lines |
|
Split a single Text file (txt) by a string delimiter |
|
SplitDocument_Xlsx (file inputFile, [Optional]boolean returnDocumentContents) |
Split a single Excel XLSX into Separate Worksheets |
ConvertTemplate_ApplyHtmlTemplate (HtmlTemplateApplicationRequest value) |
Apply HTML template |
Autodetect content type and validate |
|
Validate a Word document (DOCX) |
|
Validate a JSON file |
|
Validate a PDF document file |
|
Validate a PowerPoint presentation (PPTX) |
|
Validate a Excel document (XLSX) |
|
Validate an XML file |
|
Convert HTML string to PDF |
|
Convert HTML string to PNG screenshot |
|
Convert HTML string to text (txt) |
|
Convert Markdown to HTML |
|
Convert a URL to PDF |
|
Take screenshot of URL |
|
Convert website URL page to text (txt) |
|
Convert Excel XLS (97-03) Spreadsheet to CSV |
|
Convert Excel (97-2003) XLS to JSON conversion |
|
Convert Excel XLS (97-03) Spreadsheet to PDF |
|
Convert Excel XLS (97-03) Spreadsheet to XLSX |
|
ConvertDocument_XlsxToCsv (file inputFile, [Optional]string outputEncoding) |
Convert Excel XLSX Spreadsheet to CSV |
Convert Excel XLSX to JSON conversion |
|
Convert Excel XLSX Spreadsheet to PDF |
|
Convert Excel XLSX Spreadsheet to Text (txt) |
|
Adds an attribute to all XML nodes matching XPath expression |
|
ConvertData_XmlEditAddChildWithXPath (file inputFile, string XPathExpression, string XmlNodeToAdd) |
Adds an XML node as a child to XML nodes matching XPath expression |
ConvertData_XmlRemoveWithXPath (string XPathExpression, file inputFile) |
Remove, delete XML nodes and items matching XPath expression |
ConvertData_XmlEditRemoveAllChildNodesWithXPath (file inputFile, string XPathExpression) |
Removes, deletes all children of nodes matching XPath expression, but |
Replaces XML nodes matching XPath expression with new node |
|
ConvertData_XmlEditSetValueWithXPath (file inputFile, string XPathExpression, string XmlValue) |
Sets the value contents of XML nodes matching XPath expression |
ConvertData_XmlQueryWithXQuery (file inputFile, string XQuery) |
Query an XML file using XQuery query, get results |
Query multiple XML files using XQuery query, get results |
|
ConvertData_XmlFilterWithXPath (string XPathExpression, file inputFile) |
Filter, select XML nodes using XPath expression, get results |
Convert XML to JSON conversion |
|
ConvertData_XmlTransformWithXsltToXml (file inputFile, file transformFile) |
Transform XML document file with XSLT into a new XML document |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Input file to perform the operation on. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get document type information
Description: Auto-detects a document's type information; does not require file extension. Analyzes file contents to confirm file type. Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type. Supports over 100 image file formats, Office document file formats, PDF, and more.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_AutodetectGetInfo (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: Result of an autodetect/get-info operation
Summary: Convert Document to PDF
Description: Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_AutodetectToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Document to PNG array
Description: Automatically detect file type and convert it to an array of PNG images. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_AutodetectToPngArray (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: Result of converting an autodetected input to a PNG array
Summary: Convert Document to Text (txt)
Description: Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_AutodetectToTxt (file inputFile, [Optional]string textFormattingMode)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
textFormattingMode |
string (Optional; specify how whitespace should be handled when converting the) |
Optional; specify how whitespace should be handled when converting the |
False |
Returns:
Type:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Compare Two Word DOCX
Description: Compare two Office Word Documents (docx) files and highlight the differences
Syntax:
CloudmersiveDocumentConversion.CompareDocument_Docx (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert CSV to JSON conversion
Description: Convert a CSV file to a JSON object array
Syntax:
CloudmersiveDocumentConversion.ConvertData_CsvToJson (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:array of (ConvertData_CsvToJsonResponseItem)
Summary: Convert CSV to Excel XLSX Spreadsheet
Description: Convert CSV file to Office Excel XLSX Workbooks file format.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_CsvToXlsx (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Word DOC (97-03) Document to DOCX
Description: Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_DocToDocx (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Word DOC (97-03) Document to PDF
Description: Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_DocToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Word DOC (97-03) Document to Text (txt)
Description: Convert Office Word DOC (97-03) Document (doc) to text
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_DocToTxt (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:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Convert Word DOCX Document to PDF
Description: Convert Office Word Documents (docx) to standard PDF
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_DocxToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Word DOCX Document to Text (txt)
Description: Convert Office Word Documents (docx) to text
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_DocxToTxt (file inputFile, [Optional]string textFormattingMode)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
textFormattingMode |
string (Optional; specify how whitespace should be handled when converting the) |
Optional; specify how whitespace should be handled when converting the |
False |
Returns:
Type:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Begin editing a document
Description: Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.
Syntax:
CloudmersiveDocumentConversion.EditDocument_BeginEditing (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:string
Summary: Create a blank Word DOCX document
Description: Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxCreateBlankDocument (CreateBlankDocxRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Create Blank Word Document request |
True |
Returns:
Description: Result of creating a blank Word document
Summary: Delete, remove pages from a Word DOCX document
Description: Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxDeletePages (RemoveDocxPagesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Remove Word DOCX Document Pages request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Deletes a table row in an existing table in a Word DOCX document
Description: Deletes an existing table row in a Word DOCX Document and returns the result.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxDeleteTableRow (DeleteDocxTableRowRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a delete DOCX table row request |
True |
Returns:
Type:DeleteDocxTableRowResponse
Description: Result of running an Delete Table Row command
Summary: Deletes a range of multiple table rows in an existing table in a Word
Description: Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxDeleteTableRowRange (DeleteDocxTableRowRangeRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
DeleteDocxTableRowRangeRequest
|
Input to a delete DOCX table row range request |
True |
Returns:
Type:DeleteDocxTableRowRangeResponse
Description: Result of running an Delete Table Row Range command
Summary: Get body from a Word DOCX document
Description: Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxBody (GetDocxBodyRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Body request |
True |
Returns:
Type:GetDocxBodyResponse
Description: Result of running a Get-Body command
Summary: Get comments from a Word DOCX document hierarchically
Description: Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetCommentsHierarchical (GetDocxGetCommentsHierarchicalRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
GetDocxGetCommentsHierarchicalRequest
|
Input to a Get Word DOCX Document comments hierarchically request |
True |
Returns:
Type:GetDocxCommentsHierarchicalResponse
Description: Result of getting comments hierarchically from a Word Document DOCX
Summary: Get content of a footer from a Word DOCX document
Description: Returns the footer content from a Word Document (DOCX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetHeadersAndFooters (GetDocxHeadersAndFootersRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
GetDocxHeadersAndFootersRequest
|
Input to a Get Tables request |
True |
Returns:
Type:GetDocxHeadersAndFootersResponse
Description: Result of running a Get-Tables command
Summary: Get images from a Word DOCX document
Description: Returns the images defined in the Word Document (DOCX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetImages (GetDocxImagesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Images request |
True |
Returns:
Description: Result of running a Get-Images command
Summary: Get pages and content from a Word DOCX document
Description: Returns the pages and contents of each page defined in the Word Document (DOCX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxPages (GetDocxPagesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Word DOCX Document Pages request |
True |
Returns:
Type:GetDocxPagesResponse
Description: Result of getting pages from a Word Document DOCX
Summary: Get sections from a Word DOCX document
Description: Returns the sections defined in the Word Document (DOCX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetSections (GetDocxSectionsRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Sections request |
True |
Returns:
Description: Result of running a Get-Sections command
Summary: Get styles from a Word DOCX document
Description: Returns the styles defined in the Word Document (DOCX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetStyles (GetDocxStylesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Tables request |
True |
Returns:
Description: Result of running a Get-Tables command
Summary: Gets the contents of an existing table row in an existing table in a W
Description: Gets the contents of an existing table row in a Word DOCX Document and returns the result.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetTableRow (GetDocxTableRowRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a get DOCX table row request |
True |
Returns:
Description: Result of running an Get Table Row command
Summary: Get a specific table by index in a Word DOCX document
Description: Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetTableByIndex (GetDocxTableByIndexRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Tables by Index request |
True |
Returns:
Type:GetDocxTableByIndexResponse
Description: Result of running a Get-Tables by Index command
Summary: Get all tables in Word DOCX document
Description: Returns all the table objects in an Office Word Document (docx)
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxGetTables (GetDocxTablesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Get Tables request |
True |
Returns:
Description: Result of running a Get-Tables command
Summary: Insert a new comment into a Word DOCX document attached to a paragraph
Description: Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxInsertCommentOnParagraph (DocxInsertCommentOnParagraphRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
DocxInsertCommentOnParagraphRequest
|
Input to a Insert Comment on Paragraph request |
True |
Returns:
Type:InsertDocxCommentOnParagraphResponse
Description: Result of running an Insert-Comment-on-Paragraph command
Summary: Insert image into a Word DOCX document
Description: Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxInsertImage (DocxInsertImageRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to set-footer command |
True |
Returns:
Description: Result of running a set-footer command
Summary: Insert a new paragraph into a Word DOCX document
Description: Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxInsertParagraph (InsertDocxInsertParagraphRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
InsertDocxInsertParagraphRequest
|
Input to a Insert Paragraph request |
True |
Returns:
Type:InsertDocxInsertParagraphResponse
Description: Result of running an Insert-Paragraph command
Summary: Insert a new table into a Word DOCX document
Description: Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxInsertTable (InsertDocxTablesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Insert Tables request |
True |
Returns:
Description: Result of running an Insert-Tables command
Summary: Insert a new row into an existing table in a Word DOCX document
Description: Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxInsertTableRow (InsertDocxTableRowRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Insert Table Row request |
True |
Returns:
Type:InsertDocxTableRowResponse
Description: Result of running an Insert-Table Row command
Summary: Remove headers and footers from Word DOCX document
Description: Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxRemoveHeadersAndFooters (RemoveDocxHeadersAndFootersRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
RemoveDocxHeadersAndFootersRequest
|
Input to a Remove Headers and Footers request |
True |
Returns:
Type:RemoveDocxHeadersAndFootersResponse
Description: Result of running a Remove Headers and Footers command
Summary: Delete any object in a Word DOCX document
Description: Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxRemoveObject (DocxRemoveObjectRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Insert Paragraph request |
True |
Returns:
Description: Result of running an Remove-Object command
Summary: Replace string in Word DOCX document
Description: Replace all instances of a string in an Office Word Document (docx)
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxReplace (ReplaceStringRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a string replacement request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Set the footer in a Word DOCX document
Description: Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxSetFooter (DocxSetFooterRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to set-footer command |
True |
Returns:
Description: Result of running a set-footer command
Summary: Add page number to footer in a Word DOCX document
Description: Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxSetFooterAddPageNumber (DocxSetFooterAddPageNumberRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
DocxSetFooterAddPageNumberRequest
|
Input to set-footer/add-page-number command |
True |
Returns:
Description: Result of running a set-footer command
Summary: Set the header in a Word DOCX document
Description: Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxSetHeader (DocxSetHeaderRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a set-header command |
True |
Returns:
Description: Result of running a set-header command
Summary: Update, set contents of a table cell in an existing table in a Word DO
Description: Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxUpdateTableCell (UpdateDocxTableCellRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Update Table Cell request |
True |
Returns:
Type:UpdateDocxTableCellResponse
Description: Result of running an Update Table Cell command
Summary: Update, set contents of a table row in an existing table in a Word DOCX document
Description: Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
Syntax:
CloudmersiveDocumentConversion.EditDocument_DocxUpdateTableRow (UpdateDocxTableRowRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Update Table Row request |
True |
Returns:
Type:UpdateDocxTableRowResponse
Description: Result of running an Update Table Row command
Summary: Finish editing document, and download result from document editing
Description: Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
Syntax:
CloudmersiveDocumentConversion.EditDocument_FinishEditing (FinishEditingRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Finish Editing request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Delete, remove slides from a PowerPoint PPTX presentation document
Description: Edits the input PowerPoint PPTX presentation document to remove the specified slides
Syntax:
CloudmersiveDocumentConversion.EditDocument_PptxDeleteSlides (RemovePptxSlidesRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Remove PowerPoint PPTX Presentation Slides request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Replace string in PowerPoint PPTX presentation
Description: Replace all instances of a string in an Office PowerPoint Document (pptx)
Syntax:
CloudmersiveDocumentConversion.EditDocument_PptxReplace (ReplaceStringRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a string replacement request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
Description: Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxClearCellByIndex (ClearXlsxCellRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Clear Cell in XLSX Worksheet request |
True |
Returns:
Description: Result of running a Clear XLSX Cell command
Summary: Create a blank Excel XLSX spreadsheet
Description: Returns a blank Excel XLSX Spreadsheet (XLSX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxCreateBlankSpreadsheet (CreateBlankSpreadsheetRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Create Blank Spreadsheet request |
True |
Returns:
Type:CreateBlankSpreadsheetResponse
Description: Result of creating a blank worksheet
Summary: Create a new Excel XLSX spreadsheet from column and row data
Description: Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxCreateSpreadsheetFromData (CreateSpreadsheetFromDataRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
CreateSpreadsheetFromDataRequest
|
Input to Create a new Spreadsheet request |
True |
Returns:
Type:CreateSpreadsheetFromDataResponse
Description: Result of creating a new worksheet from rows and cells
Summary: Delete, remove worksheet from an Excel XLSX spreadsheet document
Description: Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxDeleteWorksheet (RemoveXlsxWorksheetRequest reqConfig)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
reqConfig |
|
Input to a Remove Excel XLSX Spreadsheet worksheet request |
True |
Returns:
Type:EditDocument_XlsxDeleteWorksheetResponse
Summary: Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
Description: Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetCellByIdentifier (GetXlsxCellByIdentifierRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
GetXlsxCellByIdentifierRequest
|
Input to a Get Cell by cell identifier request |
True |
Returns:
Type:GetXlsxCellByIdentifierResponse
Description: Result of running a Get-Cell command
Summary: Get cell from an Excel XLSX spreadsheet, worksheet by index
Description: Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetCellByIndex (GetXlsxCellRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Cell request |
True |
Returns:
Type:GetXlsxCellResponse
Description: Result of running a Get-Cell command
Summary: Get rows and cells from a Excel XLSX spreadsheet, worksheet
Description: Returns the rows and cells defined in the Excel Spreadsheet worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetColumns (GetXlsxColumnsRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Columns request |
True |
Returns:
Description: Result of running a Get-Columns command
Summary: Get images from a Excel XLSX spreadsheet, worksheet
Description: Returns the images defined in the Excel Spreadsheet worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetImages (GetXlsxImagesRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Images request |
True |
Returns:
Description: Result of running a Get-Images command
Summary: Get rows and cells from a Excel XLSX spreadsheet, worksheet
Description: Returns the rows and cells defined in the Excel Spreadsheet worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetRowsAndCells (GetXlsxRowsAndCellsRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Worksheets request |
True |
Returns:
Type:GetXlsxRowsAndCellsResponse
Description: Result of running a Get-Worksheets command
Summary: Get styles from a Excel XLSX spreadsheet, worksheet
Description: Returns the style defined in the Excel Spreadsheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetStyles (GetXlsxStylesRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Worksheets request |
True |
Returns:
Description: Result of running a Get-Worksheets command
Summary: Get worksheets from a Excel XLSX spreadsheet
Description: Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxGetWorksheets (GetXlsxWorksheetsRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Worksheets request |
True |
Returns:
Type:GetXlsxWorksheetsResponse
Description: Result of running a Get-Worksheets command
Summary: Insert a new worksheet into an Excel XLSX spreadsheet
Description: Inserts a new worksheet into an Excel Spreadsheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxInsertWorksheet (InsertXlsxWorksheetRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Get Worksheets request |
True |
Returns:
Type:InsertXlsxWorksheetResponse
Description: Result of running a Get-Worksheets command
Summary: Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c
Description: Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxSetCellByIdentifier (SetXlsxCellByIdentifierRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
SetXlsxCellByIdentifierRequest
|
Input to a Set Cell by identifier in XLSX Worksheets request |
True |
Returns:
Type:SetXlsxCellByIdentifierResponse
Description: Result of running a Set Cell by identifier in XLSX Worksheets command
Summary: Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
Description: Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
Syntax:
CloudmersiveDocumentConversion.EditDocument_XlsxSetCellByIndex (SetXlsxCellRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Input to a Set Cell in XLSX Worksheets request |
True |
Returns:
Type:SetXlsxCellResponse
Description: Result of running a Set Cell in XLSX Worksheets command
Summary: Convert HTML to Word DOCX Document
Description: Convert HTML to Office Word Document (DOCX) format
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_HtmlToDocx (HtmlToOfficeRequest inputRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputRequest |
|
Details of the HTML to Office request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert HTML document file to PDF Document
Description: Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_HtmlToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert HTML document file to PNG image array
Description: Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_HtmlToPng (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:PdfToPngResult
Description: Result of converting a PDF to a PNG array
Summary: HTML Document file to Text (txt)
Description: HTML document to text
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_HtmlToTxt (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:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Multi-page image format conversion
Description: Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
Syntax:
CloudmersiveDocumentConversion.ConvertImage_MultipageImageFormatConvert (string format1, string format2, file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
format1 |
string (Input file format as a 3+ letter file extension. You can also provide) |
Input file format as a 3+ letter file extension. You can also provide |
True |
|
format2 |
string (Output (convert to this format) file format as a 3+ letter file extens) |
Output (convert to this format) file format as a 3+ letter file extens |
True |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:MultipageImageFormatConversionResult
Description: Result of converting a multi-page image into individual pages with a different format
Summary: Get information about an image
Description: Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more
Syntax:
CloudmersiveDocumentConversion.ConvertImage_GetImageInfo (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:GetImageInfoResult
Description: Result of running a get-info operation on an image
Summary: Change image DPI
Description: Resize an image to have a different DPI
Syntax:
CloudmersiveDocumentConversion.ConvertImage_ImageSetDPI (integer dpi, file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
dpi |
integer(int32) (New DPI in pixels-per-inch, for example 300 DPI or 600 DPI) |
New DPI in pixels-per-inch, for example 300 DPI or 600 DPI |
True |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Image format conversion
Description: Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
Syntax:
CloudmersiveDocumentConversion.ConvertImage_ImageFormatConvert (string format1, string format2, file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
format1 |
string (Input file format as a 3+ letter file extension. You can also provide) |
Input file format as a 3+ letter file extension. You can also provide |
True |
|
format2 |
string (Output (convert to this format) file format as a 3+ letter file extens) |
Output (convert to this format) file format as a 3+ letter file extens |
True |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert JSON to XML conversion
Description: Convert a JSON object into XML
Syntax:
CloudmersiveDocumentConversion.ConvertData_JsonToXml (ConvertData_JsonToXmlParameterJsonObject JsonObject)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
JsonObject |
ConvertData_JsonToXmlParameterJsonObject
|
|
True |
Returns:
Type:string(byte)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Merge Two Word DOCX Together
Description: Combine two Office Word Documents (docx) into one single Office Word document
Syntax:
CloudmersiveDocumentConversion.MergeDocument_Docx (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Merge Multple Word DOCX Together
Description: Combine multiple Office Word Documents (docx) into one single Office Word document
Syntax:
CloudmersiveDocumentConversion.MergeDocument_DocxMulti (file inputFile1, 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. |
True |
|
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: Merge Two PDF Files Together
Description: Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document
Syntax:
CloudmersiveDocumentConversion.MergeDocument_Pdf (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Merge Multple PDF Files Together
Description: Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document
Syntax:
CloudmersiveDocumentConversion.MergeDocument_PdfMulti (file inputFile1, 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. |
True |
|
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: Merge Multple PNG Files Together
Description: Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
Syntax:
CloudmersiveDocumentConversion.MergeDocument_Png (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Merge Two PowerPoint PPTX Together
Description: Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation
Syntax:
CloudmersiveDocumentConversion.MergeDocument_Pptx (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Merge Multple PowerPoint PPTX Together
Description: Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation
Syntax:
CloudmersiveDocumentConversion.MergeDocument_PptxMulti (file inputFile1, 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. |
True |
|
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: Merge Two Text (TXT) Files Together
Description: Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.
Syntax:
CloudmersiveDocumentConversion.MergeDocument_Txt (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:MergeDocument_TxtResponse
Summary: Merge Multple Text (TXT) Files Together
Description: Combine multiple Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.
Syntax:
CloudmersiveDocumentConversion.MergeDocument_TxtMulti (file inputFile1, 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. |
True |
|
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: Merge Two Excel XLSX Together
Description: Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet
Syntax:
CloudmersiveDocumentConversion.MergeDocument_Xlsx (file inputFile1, file inputFile2)
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 (more than 2 can be supplied).) |
Second input file to perform the operation on (more than 2 can be supplied). |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Merge Multple Excel XLSX Together
Description: Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet
Syntax:
CloudmersiveDocumentConversion.MergeDocument_XlsxMulti (file inputFile1, 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. |
True |
|
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: Convert PDF to Word DOCX Document
Description: Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PdfToDocx (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PDF to Word DOCX Document based on rasterized version of the PDF
Description: Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF. Converts a PDF at high fidelity into Word format.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PdfToDocxRasterize (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PDF to PNG Image Array
Description: Convert PDF document to PNG array, one image per page.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PdfToPngArray (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:PdfToPngResult
Description: Result of converting a PDF to a PNG array
Summary: Convert PDF to Single PNG image
Description: Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single "tall" image
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PdfToPngSingle (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PDF to PowerPoint PPTX Presentation
Description: Convert standard PDF to Office PowerPoint Presentation (pptx). Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PdfToPptx (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PDF Document to Text (txt)
Description: PDF document to text
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PdfToTxt (file inputFile, [Optional]string textFormattingMode)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
textFormattingMode |
string (Optional; specify how whitespace should be handled when converting PDF) |
Optional; specify how whitespace should be handled when converting PDF |
False |
Returns:
Type:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Convert PNG Array to PDF
Description: Convert an array of PNG images, one image per page, into a newly-created PDF. Supports images of different sizes as input.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PngArrayToPdf (file inputFile1, 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. |
True |
|
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: Convert PowerPoint PPT (97-03) Presentation to PDF
Description: Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PptToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PowerPoint PPT (97-03) Presentation to PPTX
Description: Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PptToPptx (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PowerPoint PPTX Presentation to PDF
Description: Convert Office PowerPoint Documents (pptx) to standard PDF
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PptxToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert PowerPoint PPTX Presentation to Text (txt)
Description: Convert Office PowerPoint Documents (pptx) to standard Text
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_PptxToTxt (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:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Split a single Word Document DOCX into Separate Documents by Page
Description: Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
Syntax:
CloudmersiveDocumentConversion.SplitDocument_Docx (file inputFile, [Optional]boolean returnDocumentContents)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
returnDocumentContents |
boolean (Set to true to return the contents of each Worksheet directly, set to) |
Set to true to return the contents of each Worksheet directly, set to |
False |
Returns:
Description: The result of splitting a Word document into individual Word DOCX pages
Summary: Split a PDF file into separate PDF files, one per page
Description: Split an input PDF file into separate pages, comprised of one PDF file per page.
Syntax:
CloudmersiveDocumentConversion.SplitDocument_PdfByPage (file inputFile, [Optional]boolean returnDocumentContents)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
returnDocumentContents |
boolean (Set to true to directly return all of the document contents in the Doc) |
Set to true to directly return all of the document contents in the Doc |
False |
Returns:
Type:SplitPdfResult
Description: Result of performing a PDF file split operation
Summary: Split a single PowerPoint Presentation PPTX into Separate Slides
Description: Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.
Syntax:
CloudmersiveDocumentConversion.SplitDocument_Pptx (file inputFile, [Optional]boolean returnDocumentContents)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
returnDocumentContents |
boolean (Set to true to return the contents of each presentation directly, set) |
Set to true to return the contents of each presentation directly, set |
False |
Returns:
Type:SplitPptxPresentationResult
Description: The result of splitting a presentation into individual PowerPoint PPTX slides
Summary: Split a single Text file (txt) into lines
Description: Split a Text (txt) Document by line, returning each line separately in order. Supports multiple types of newlines.
Syntax:
CloudmersiveDocumentConversion.SplitDocument_TxtByLine (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:SplitTextDocumentByLinesResult
Description: The result of splitting a Text document into separate lines
Summary: Split a single Text file (txt) by a string delimiter
Description: Split a Text (txt) Document by a string delimiter, returning each component of the string as an array of strings.
Syntax:
CloudmersiveDocumentConversion.SplitDocument_TxtByString (file inputFile, string splitDelimiter, [Optional]boolean skipEmptyElements)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
splitDelimiter |
string (Required; String to split up the input file on) |
Required; String to split up the input file on |
True |
|
skipEmptyElements |
boolean (Optional; If true, empty elements will be skipped in the output) |
Optional; If true, empty elements will be skipped in the output |
False |
Returns:
Type:SplitTextDocumentByStringResult
Description: The result of splitting a Text document into separate elements
Summary: Split a single Excel XLSX into Separate Worksheets
Description: Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.
Syntax:
CloudmersiveDocumentConversion.SplitDocument_Xlsx (file inputFile, [Optional]boolean returnDocumentContents)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
returnDocumentContents |
boolean (Set to true to return the contents of each Worksheet directly, set to) |
Set to true to return the contents of each Worksheet directly, set to |
False |
Returns:
Description: The result of splitting a spreadsheet into individual Excel XLSX worksheets
Summary: Apply HTML template
Description: Apply operations to fill in an HTML template, generating a final HTML result
Syntax:
CloudmersiveDocumentConversion.ConvertTemplate_ApplyHtmlTemplate (HtmlTemplateApplicationRequest value)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
value |
HtmlTemplateApplicationRequest
|
HTML template application request |
True |
Returns:
Type:HtmlTemplateApplicationResponse
Description: Response from an HTML template application
Summary: Autodetect content type and validate
Description: Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_AutodetectValidation (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:AutodetectDocumentValidationResult
Description: Document validation result
Summary: Validate a Word document (DOCX)
Description: Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_DocxValidation (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: Validate a JSON file
Description: Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_JsonValidation (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: Validate a PDF document file
Description: Validate a PDF document; if the document is not valid, identifies the errors in the document
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_PdfValidation (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: Validate a PowerPoint presentation (PPTX)
Description: Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_PptxValidation (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: Validate a Excel document (XLSX)
Description: Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_XlsxValidation (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: Validate an XML file
Description: Validate an XML document file; if the document is not valid, identifies the errors in the document
Syntax:
CloudmersiveDocumentConversion.ValidateDocument_XmlValidation (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: Convert HTML string to PDF
Description: Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_HtmlToPdf (HtmlToPdfRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Details of the HTML to PDF request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert HTML string to PNG screenshot
Description: Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_HtmlToPng (HtmlToPngRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Details of the HTML to PNG request |
True |
Returns:
Type:ConvertWeb_HtmlToPngResponse
Summary: Convert HTML string to text (txt)
Description: Converts an HTML string input into text (txt); extracts text from HTML
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_HtmlToTxt (HtmlToTextRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Details of the HTML to Text request |
True |
Returns:
Type:HtmlToTextResponse
Description: Result of running the HTML to Text operation
Summary: Convert Markdown to HTML
Description: Convert a markdown file (.md) to HTML
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_MdToHtml (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:HtmlMdResult
Description: Result from converting a Markdown file to HTML
Summary: Convert a URL to PDF
Description: Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_UrlToPdf (ScreenshotRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Details of the screenshot request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Take screenshot of URL
Description: Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_UrlToScreenshot (ScreenshotRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Details of the screenshot request |
True |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert website URL page to text (txt)
Description: Converts a website URL page into text (txt); extracts text from HTML
Syntax:
CloudmersiveDocumentConversion.ConvertWeb_UrlToTxt (UrlToTextRequest input)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
input |
|
Details of the URL website to Text request |
True |
Returns:
Type:UrlToTextResponse
Description: Result of running the URL website to Text operation
Summary: Convert Excel XLS (97-03) Spreadsheet to CSV
Description: Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_XlsToCsv (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Excel (97-2003) XLS to JSON conversion
Description: Convert an Excel (97-2003) XLS file to a JSON object array
Syntax:
CloudmersiveDocumentConversion.ConvertData_XlsToJson (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:array of (ConvertData_XlsToJsonResponseItem)
Summary: Convert Excel XLS (97-03) Spreadsheet to PDF
Description: Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_XlsToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Excel XLS (97-03) Spreadsheet to XLSX
Description: Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_XlsToXlsx (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Excel XLSX Spreadsheet to CSV
Description: Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_XlsxToCsv (file inputFile, [Optional]string outputEncoding)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
|
outputEncoding |
string (Optional, set the output text encoding for the result; possible values) |
Optional, set the output text encoding for the result; possible values |
False |
Returns:
Type:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Excel XLSX to JSON conversion
Description: Convert an Excel XLSX file to a JSON object array
Syntax:
CloudmersiveDocumentConversion.ConvertData_XlsxToJson (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:array of (ConvertData_XlsxToJsonResponseItem)
Summary: Convert Excel XLSX Spreadsheet to PDF
Description: Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_XlsxToPdf (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:string(binary)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary: Convert Excel XLSX Spreadsheet to Text (txt)
Description: Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
Syntax:
CloudmersiveDocumentConversion.ConvertDocument_XlsxToTxt (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:TextConversionResult
Description: Text conversion result from converting a document to Plain Text (TXT) format
Summary: Adds an attribute to all XML nodes matching XPath expression
Description: Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlEditAddAttributeWithXPath (file inputFile, string XPathExpression, string XmlAttributeName, string XmlAttributeValue)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
|
XmlAttributeName |
string (Name of the XML attribute to add) |
Name of the XML attribute to add |
True |
|
XmlAttributeValue |
string (Value of the XML attribute to add) |
Value of the XML attribute to add |
True |
Returns:
Type:XmlAddAttributeWithXPathResult
Description: Result of performing a add attribute node operation on XML input using XPath
Summary: Adds an XML node as a child to XML nodes matching XPath expression
Description: Return the reuslts of editing an XML document by adding an XML node as a child to all of the nodes that match an input XPath expression.
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlEditAddChildWithXPath (file inputFile, string XPathExpression, string XmlNodeToAdd)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
|
XmlNodeToAdd |
string (XML Node to add as a child) |
XML Node to add as a child |
True |
Returns:
Type:XmlAddChildWithXPathResult
Description: Result of performing a add child node operation on XML input using XPath
Summary: Remove, delete XML nodes and items matching XPath expression
Description: Return the reuslts of editing an XML document by removing all of the nodes that match an input XPath expression
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlRemoveWithXPath (string XPathExpression, file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Description: Result of performing a filter operation on XML input using XPath
Summary: Removes, deletes all children of nodes matching XPath expression, but
Description: Return the reuslts of editing an XML document by removing all child nodes of the nodes that match an input XPath expression.
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlEditRemoveAllChildNodesWithXPath (file inputFile, string XPathExpression)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
Returns:
Type:XmlRemoveAllChildrenWithXPathResult
Description: Result of performing a remove all child nodes operation on XML input using XPath
Summary: Replaces XML nodes matching XPath expression with new node
Description: Return the reuslts of editing an XML document by replacing all of the nodes that match an input XPath expression with a new XML node expression.
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlEditReplaceWithXPath (file inputFile, string XPathExpression, string XmlNodeReplacement)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
|
XmlNodeReplacement |
string (XML Node replacement content) |
XML Node replacement content |
True |
Returns:
Type:XmlReplaceWithXPathResult
Description: Result of performing a replace node operation on XML input using XPath
Summary: Sets the value contents of XML nodes matching XPath expression
Description: Return the reuslts of editing an XML document by setting the contents of all of the nodes that match an input XPath expression. Supports elements and attributes.
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlEditSetValueWithXPath (file inputFile, string XPathExpression, string XmlValue)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
|
XmlValue |
string (XML Value to set into the matching XML nodes) |
XML Value to set into the matching XML nodes |
True |
Returns:
Type:XmlSetValueWithXPathResult
Description: Result of performing a set value operation on XML input using XPath
Summary: Query an XML file using XQuery query, get results
Description: Return the reuslts of querying a single XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for a single XML document as input. Provided XML document is automatically loaded as the default context; to access elements in the document, simply refer to them without a document reference, such as bookstore/book
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlQueryWithXQuery (file inputFile, string XQuery)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
XQuery |
string (Valid XML XQuery 3.1 or earlier query expression; multi-line expressio) |
Valid XML XQuery 3.1 or earlier query expression; multi-line expressio |
True |
Returns:
Description: Result of performing an XQuery operation on an XML document.
Summary: Query multiple XML files using XQuery query, get results
Description: Return the reuslts of querying an XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for multiple XML documents as input. You can refer to the contents of a given document by name, for example doc("books.xml") or doc("restaurants.xml") if you included two input files named books.xml and restaurants.xml. If input files contain no file name, they will default to file names input1.xml, input2.xml and so on.
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlQueryWithXQueryMulti (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, string XQuery)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile1 |
(First input XML file to perform the operation on.) |
First input XML file to perform the operation on. |
True |
|
inputFile2 |
(Second input XML file to perform the operation on.) |
Second input XML file to perform the operation on. |
False |
|
inputFile3 |
(Third input XML file to perform the operation on.) |
Third input XML file to perform the operation on. |
False |
|
inputFile4 |
(Fourth input XML file to perform the operation on.) |
Fourth input XML file to perform the operation on. |
False |
|
inputFile5 |
(Fifth input XML file to perform the operation on.) |
Fifth input XML file to perform the operation on. |
False |
|
inputFile6 |
(Sixth input XML file to perform the operation on.) |
Sixth input XML file to perform the operation on. |
False |
|
inputFile7 |
(Seventh input XML file to perform the operation on.) |
Seventh input XML file to perform the operation on. |
False |
|
inputFile8 |
(Eighth input XML file to perform the operation on.) |
Eighth input XML file to perform the operation on. |
False |
|
inputFile9 |
(Ninth input XML file to perform the operation on.) |
Ninth input XML file to perform the operation on. |
False |
|
inputFile10 |
(Tenth input XML file to perform the operation on.) |
Tenth input XML file to perform the operation on. |
False |
|
XQuery |
string (Valid XML XQuery 3.1 or earlier query expression; multi-line expressio) |
Valid XML XQuery 3.1 or earlier query expression; multi-line expressio |
True |
Returns:
Type:XmlQueryWithXQueryMultiResult
Description: Result of performing an XQuery operation on multiple XML documents.
Summary: Filter, select XML nodes using XPath expression, get results
Description: Return the reuslts of filtering, selecting an XML document with an XPath expression
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlFilterWithXPath (string XPathExpression, file inputFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
XPathExpression |
string (Valid XML XPath query expression) |
Valid XML XPath query expression |
True |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
True |
Returns:
Description: Result of performing a filter operation on XML input using XPath
Summary: Convert XML to JSON conversion
Description: Convert an XML string or file into JSON
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlToJson (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:ConvertData_XmlToJsonResponse
Summary: Transform XML document file with XSLT into a new XML document
Description: Convert an XML string or file into JSON
Syntax:
CloudmersiveDocumentConversion.ConvertData_XmlTransformWithXsltToXml (file inputFile, file transformFile)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
inputFile |
(Input XML file to perform the operation on.) |
Input XML file to perform the operation on. |
True |
|
transformFile |
(Input XSLT file to use to transform the input XML file.) |
Input XSLT file to use to transform the input XML file. |
True |
Returns:
Type:string(byte)OutputContent
Title: OutputContent
Description: Output file content from the operation
Summary:
Description: Alternate file format possibility
Properties:
Name |
Type |
Summary |
DetectedFileExtension |
string
|
Detected file extension of the file format, with a leading period |
DetectedMimeType |
string
|
MIME type of this file extension |
Probability |
number(double)
|
Probability that this extension is the right one; possible values are between 0.0 (lowest confidence) and 1.0 (highest confidence) |
Summary:
Description: Document validation result
Properties:
Name |
Type |
Summary |
DocumentIsValid |
boolean
|
True if the document is valid and has no errors, false otherwise |
ErrorCount |
integer(int32)
|
Number of validation errors found in the document |
ErrorsAndWarnings |
array of (DocumentValidationError)
|
Details of errors and warnings found |
FileFormatExtension |
string
|
|
WarningCount |
integer(int32)
|
Number of validation warnings found in the document |
Summary:
Description: Result of an autodetect/get-info operation
Properties:
Name |
Type |
Summary |
AlternateFileTypeCandidates |
array of (AlternateFileFormatCandidate)
|
Alternate file type options and their probability |
Author |
string
|
User name of the creator/author of the document, if available, null if not available |
DateModified |
string(date-time)
|
The timestamp that the document was last modified, if available, null if not available |
DetectedFileExtension |
string
|
Detected file extension of the file format, with a leading period |
DetectedMimeType |
string
|
MIME type of this file extension |
PageCount |
integer(int64)
|
Number of pages in a page-based document; for presentations, this is the number of slides and for a spreadsheet this is the number of worksheets. Contains 0 when the page count cannot be determined, or if the concept of page count does not apply (e.g. for an image) |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of converting an autodetected input to a PNG array
Properties:
Name |
Type |
Summary |
PngResultPages |
array of (ConvertedPngPage)
|
Array of converted pages |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Input to a Clear Cell in XLSX Worksheet request
Properties:
Name |
Type |
Summary |
CellIndex |
integer(int32)
|
0-based index of the cell, 0, 1, 2, ... in the row to clear |
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). |
RowIndex |
integer(int32)
|
0-based index of the row, 0, 1, 2, ... to clear |
WorksheetToUpdate |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Clear XLSX Cell command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: A single converted page
Properties:
Name |
Type |
Summary |
PageNumber |
integer(int32)
|
Page number of the converted page, starting with 1 |
URL |
string
|
URL to the PNG file of this page; file is stored in an in-memory cache and will be deleted |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Input to a Create Blank Word Document request
Properties:
Name |
Type |
Summary |
InitialText |
string
|
Optional; initial text to include in the document |
Summary:
Description: Result of creating a blank Word document
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Create Blank Spreadsheet request
Properties:
Name |
Type |
Summary |
WorksheetName |
string
|
The blank Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1 |
Summary:
Description: Result of creating a blank worksheet
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to Create a new Spreadsheet request
Properties:
Name |
Type |
Summary |
Rows |
array of (XlsxSpreadsheetRow)
|
Required; Rows and cells to populate the spreadsheet with |
WorksheetName |
string
|
Optional; The new Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1 |
Summary:
Description: Result of creating a new worksheet from rows and cells
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a delete DOCX table row range 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). |
TablePath |
string
|
Path to the table to delete the row from |
TableRowRowIndexEnd |
integer(int32)
|
0-based index of the row to stop deleting rows (e.g. 0, 1, 2, ...) in the table |
TableRowRowIndexStart |
integer(int32)
|
0-based index of the row to begin deleting rows (e.g. 0, 1, 2, ...) in the table |
Summary:
Description: Result of running an Delete Table Row Range command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a delete DOCX table row 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). |
TablePath |
string
|
Path to the table to delete the row from |
TableRowRowIndex |
integer(int32)
|
0-based index of the row to delete (e.g. 0, 1, 2, ...) in the table |
Summary:
Description: Result of running an Delete Table Row command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Validation error found in document
Properties:
Name |
Type |
Summary |
Description |
string
|
Description of the error |
IsError |
boolean
|
True if this is an error, false otherwise |
Path |
string
|
XPath to the error |
Uri |
string
|
URI of the part in question |
Summary:
Description: Document validation result
Properties:
Name |
Type |
Summary |
DocumentIsValid |
boolean
|
True if the document is valid and has no errors, false otherwise |
ErrorCount |
integer(int32)
|
Number of validation errors found in the document |
ErrorsAndWarnings |
array of (DocumentValidationError)
|
Details of errors and warnings found |
WarningCount |
integer(int32)
|
Number of validation warnings found in the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
AllParagraphs |
array of (DocxParagraph)
|
All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document |
AllTables |
array of (DocxTable)
|
All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
Summary:
Description: Style in an Excel spreadsheet
Properties:
Name |
Type |
Summary |
BuiltInID |
integer(int32)
|
Built=in ID of the cell style |
FormatID |
integer(int32)
|
Format ID of the cell style |
Name |
string
|
Name of the style |
Path |
string
|
The Path of the location of this object; leave blank for new rows |
Summary:
Description: Comment in a Word Document
Properties:
Name |
Type |
Summary |
Author |
string
|
Author name of the comment |
AuthorInitials |
string
|
Initials of the author of the comment |
CommentDate |
string(date-time)
|
Date timestamp of the comment |
CommentText |
string
|
Text content of the comment |
Done |
boolean
|
True if this comment is marked as Done in Word, otherwise it is false |
IsReply |
boolean
|
True if this comment is a reply to another comment, false otherwise |
IsTopLevel |
boolean
|
True if the comment is at the top level, false if this comment is a child reply of another comment |
ParentCommentPath |
string
|
Path to the parent of this comment, if this comment is a reply, otherwise this value will be null |
Path |
string
|
Path to the comment in the document |
Summary:
Description: Footer in a Word Document (DOCX)
Properties:
Name |
Type |
Summary |
Paragraphs |
array of (DocxParagraph)
|
Paragraphs in this footer |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
SectionsWithFooter |
array of (DocxSection)
|
Sections that the footer is applied to |
Summary:
Description: Header of a Word Document (DOCX)
Properties:
Name |
Type |
Summary |
Paragraphs |
array of (DocxParagraph)
|
Paragraphs in this header |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
SectionsWithHeader |
array of (DocxSection)
|
Sections that the header is applied to |
Summary:
Description:
Properties:
Name |
Type |
Summary |
ImageContentsURL |
string
|
URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents. |
ImageDataContentType |
string
|
Read-only; image data MIME content-type |
ImageDataEmbedId |
string
|
Read-only; internal ID for the image contents |
ImageDescription |
string
|
The Description of the image |
ImageHeight |
integer(int64)
|
Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height |
ImageId |
integer(int64)
|
The Id of the image |
ImageInternalFileName |
string
|
Read-only; internal file name/path for the image |
ImageName |
string
|
The Name of the image |
ImageWidth |
integer(int64)
|
Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height |
InlineWithText |
boolean
|
True if the image is inline with the text; false if it is floating |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
XOffset |
integer(int64)
|
X (horizontal) offset of the image |
YOffset |
integer(int64)
|
Y (vertical) offset of the image |
Summary:
Description: Input to a Insert Comment on Paragraph request
Properties:
Name |
Type |
Summary |
CommentToInsert |
|
Comment in a Word Document |
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). |
ParagraphPath |
string
|
Path to the paragraph to attach the comment to. You can get the Path by retrieving all of the Paragraphs in document by calling Get Body and taking the Path property of the desired paragraph to add the comment to. |
Summary:
Description: Input to set-footer command
Properties:
Name |
Type |
Summary |
HeightInEMUs |
integer(int64)
|
Optional: The height of the image in EMUs |
ImageToAdd |
|
|
InputDocumentFileBytes |
string(byte)
|
Optional: Bytes of the input file to operate on |
InputDocumentFileUrl |
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). |
InputImageFileBytes |
string(byte)
|
Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd. |
InputImageFileUrl |
string
|
Optional: URL of an image file to operate on as input; if you supply this value do not supply InputImageFileBytes or ImageToAdd. 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). |
InsertPath |
string
|
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject |
InsertPlacement |
string
|
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) |
WidthInEMUs |
integer(int64)
|
Optional: The width of the image in EMUs |
Summary:
Description: Result of running a set-footer command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: One page in a Word Document DOCX
Properties:
Name |
Type |
Summary |
PageNumber |
integer(int32)
|
Page number of this page, 1-based |
Paragraphs |
array of (DocxParagraph)
|
All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document |
Summary:
Description: A paragraph in a Word Document (DOCX) file; there is where text, content and formatting are stored - similar to the paragraph tag in HTML
Properties:
Name |
Type |
Summary |
ContentRuns |
array of (DocxRun)
|
The content runs in the paragraph - this is where text is stored; similar to a span in HTML |
ParagraphIndex |
integer(int32)
|
The index of the paragraph; 0-based |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
StyleID |
string
|
Style ID of the style applied to the paragraph; null if no style is applied |
Summary:
Description: Input to a Insert Paragraph 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). |
PathToObjectToRemove |
string
|
Path within the document of the object to delete; fill in the PathToObjectToRemove field using the Path value from an existing object. |
Summary:
Description: Result of running an Remove-Object command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: A content run in a Word Document (DOCX) file
Properties:
Name |
Type |
Summary |
Bold |
boolean
|
True to make the text bold, false otherwise |
FontFamily |
string
|
Font Family name for the text, e.g. "Arial" or "Times New Roman" |
FontSize |
string
|
Font size in font points (e.g. "24") |
Italic |
boolean
|
True to make the text italic, false otherwise |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
RunIndex |
integer(int32)
|
Index of the run, 0-based |
TextItems |
array of (DocxText)
|
Text items inside the run; this is where the actual text content is stored |
Underline |
string
|
Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None |
Summary:
Description: Section of a Word Document (DOCX)
Properties:
Name |
Type |
Summary |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
StartingPageNumbers |
array of (integer(int32))
|
Page numbers that the section starts at, typically just one |
Summary:
Description: Input to set-footer/add-page-number command
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). |
PrependText |
string
|
Optional: extra text to add before the page number, for example if you want to show "Page 1" then you can set PrependText to "Page" |
Summary:
Description: Input to set-footer command
Properties:
Name |
Type |
Summary |
FooterToApply |
|
Footer in a Word Document (DOCX) |
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: Result of running a set-footer command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a set-header command
Properties:
Name |
Type |
Summary |
HeaderToApply |
|
Header of a Word Document (DOCX) |
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: Result of running a set-header command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Style in a DOCX Word Document
Properties:
Name |
Type |
Summary |
Bold |
boolean
|
Style applies bold formatting |
FontFamily |
string
|
Font family |
FontSize |
string
|
Font size |
Italic |
boolean
|
Style applies italic formatting |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
StyleID |
string
|
ID of the style |
Underline |
boolean
|
Style applies underline formatting |
Summary:
Description: A table in a Word Document (DOCX) file
Properties:
Name |
Type |
Summary |
BottomBorderColor |
string
|
HTML-style color hex value (do not include a #) |
BottomBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
BottomBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
BottomBorderType |
string
|
Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
CellHorizontalBorderColor |
string
|
HTML-style color hex value (do not include a #) |
CellHorizontalBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
CellHorizontalBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
CellHorizontalBorderType |
string
|
Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
CellVerticalBorderColor |
string
|
HTML-style color hex value (do not include a #) |
CellVerticalBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
CellVerticalBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
CellVerticalBorderType |
string
|
Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
EndBorderColor |
string
|
HTML-style color hex value (do not include a #) |
EndBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
EndBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
EndBorderType |
string
|
Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
LeftBorderColor |
string
|
HTML-style color hex value (do not include a #) |
LeftBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
LeftBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
LeftBorderType |
string
|
Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
Path |
string
|
The Path of the location of this table object; leave blank for new tables |
RightBorderColor |
string
|
HTML-style color hex value (do not include a #) |
RightBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
RightBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
RightBorderType |
string
|
Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
StartBorderColor |
string
|
HTML-style color hex value (do not include a #) |
StartBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
StartBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
StartBorderType |
string
|
Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
TableID |
string
|
The ID of the table; leave blank for new tables |
TableIndentationMode |
string
|
Table indentation type |
TableIndentationWidth |
integer(int32)
|
Table indentation width |
TableRows |
array of (DocxTableRow)
|
Rows in the table; this is where the contents is located |
TopBorderColor |
string
|
HTML-style color hex value (do not include a #) |
TopBorderSize |
integer(int32)
|
Width of the border in points (1/72nd of an inch) |
TopBorderSpace |
integer(int32)
|
Spacing around the border in points (1/72nd of an inch) |
TopBorderType |
string
|
Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave |
Width |
string
|
The Width of the table, or 0 if not specified |
WidthType |
string
|
The Width configuration type of the table |
Summary:
Description: A cell in a Word Document (DOCX) file
Properties:
Name |
Type |
Summary |
CellIndex |
integer(int32)
|
The index of the cell, 0-based |
CellShadingColor |
string
|
Color of the cell shading |
CellShadingFill |
string
|
Fill of the cell shading |
CellShadingPattern |
string
|
Pattern of the cell shading |
CellWidth |
string
|
Width of the cell |
CellWidthMode |
string
|
Width mode of the cell; can be auto (for automatic) or manual |
Paragraphs |
array of (DocxParagraph)
|
Paragraphs inside the cell; this is where the contents of the cell are stored |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
Summary:
Description: A row in a Word Document (DOCX) file
Properties:
Name |
Type |
Summary |
Path |
string
|
The Path of the location of this table row object; leave blank for new tables |
RowCells |
array of (DocxTableCell)
|
Cells in the row; this is where the contents of the row is stored |
RowIndex |
integer(int32)
|
Index of the row, 0-based |
Summary:
Description: Unit of text content in a Word Document (DOCX) file
Properties:
Name |
Type |
Summary |
Path |
string
|
The Path of the location of this object; leave blank for new tables |
TextContent |
string
|
Text string containing the text content of this text content item |
TextIndex |
integer(int32)
|
Index of the text content in the run; 0-based |
Summary:
Description: Top-level Comment in a Word Document
Properties:
Name |
Type |
Summary |
Author |
string
|
Author name of the comment |
AuthorInitials |
string
|
Initials of the author of the comment |
CommentDate |
string(date-time)
|
Date timestamp of the comment |
CommentText |
string
|
Text content of the comment |
Done |
boolean
|
True if this comment is marked as Done in Word, otherwise it is false |
Path |
string
|
Path to the comment in the document |
ReplyChildComments |
array of (DocxComment)
|
Child comments, that are replies to this one |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: EXIF tag and value
Properties:
Name |
Type |
Summary |
DataType |
string
|
Date type of the EXIF value |
DataValue |
string
|
Value, formatted as a string of the EXIF value |
Tag |
string
|
Tag name for the EXIF value |
Summary: Input file to perform the operation on.
Description: Input file to perform the operation on.
Properties:
Name |
Type |
Summary |
Summary:
Description: Input to a Finish Editing request
Properties:
Name |
Type |
Summary |
InputFileUrl |
string
|
URL of a document being edited to get the contents of. |
Summary:
Description: Input to a Get Body 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: Result of running a Get-Body command
Properties:
Name |
Type |
Summary |
Body |
|
|
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Result of getting comments hierarchically from a Word Document DOCX
Properties:
Name |
Type |
Summary |
Comments |
array of (DocxTopLevelComment)
|
Comments in the document |
Successful |
boolean
|
True if successful, false otherwise |
TopLevelCommentCount |
integer(int32)
|
The number of comments in the document |
Summary:
Description: Input to a Get Word DOCX Document comments hierarchically 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: Input to a Get Tables 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: Result of running a Get-Tables command
Properties:
Name |
Type |
Summary |
Footers |
array of (DocxFooter)
|
|
Headers |
array of (DocxHeader)
|
|
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Images 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: Result of running a Get-Images command
Properties:
Name |
Type |
Summary |
Images |
array of (DocxImage)
|
Images in the DOCX document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Word DOCX Document Pages 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: Result of getting pages from a Word Document DOCX
Properties:
Name |
Type |
Summary |
PageCount |
integer(int32)
|
Count of pages |
Pages |
array of (DocxPage)
|
Pages in the document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Sections 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: Result of running a Get-Sections command
Properties:
Name |
Type |
Summary |
Sections |
array of (DocxSection)
|
Sections in the DOCX document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Tables 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: Result of running a Get-Tables command
Properties:
Name |
Type |
Summary |
Styles |
array of (DocxStyle)
|
Styles in the DOCX document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Tables by Index 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). |
TableIndex |
integer(int32)
|
0-based index of the table to retrieve from the Word Document |
Summary:
Description: Result of running a Get-Tables by Index command
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Table |
|
A table in a Word Document (DOCX) file |
Summary:
Description: Input to a get DOCX table row 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). |
TablePath |
string
|
Path to the table to retrievew the row from |
TableRowRowIndex |
integer(int32)
|
0-based index of the row to retrieve (e.g. 0, 1, 2, ...) in the table |
Summary:
Description: Result of running an Get Table Row command
Properties:
Name |
Type |
Summary |
RowResult |
|
A row in a Word Document (DOCX) file |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Tables 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: Result of running a Get-Tables command
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Tables |
array of (DocxTable)
|
Tables in the DOCX file |
Summary:
Description: Result of running a get-info operation on an image
Properties:
Name |
Type |
Summary |
BitDepth |
integer(int32)
|
Bit depth of the image |
ColorCount |
integer(int32)
|
Unique colors in the image |
ColorSpace |
string
|
Color space of the image |
ColorType |
string
|
Color type of the image |
Comment |
string
|
Comment string in the image |
CompressionLevel |
integer(int32)
|
Compression level value from 0 (lowest quality) to 100 (highest quality) |
DPI |
number(double)
|
DPI (pixels per unit, e.g. pixels per inch) of the image |
DPIUnit |
string
|
Units of the DPI measurement; can be either in Inches or Centimeters |
ExifProfileName |
string
|
Name of the EXIF profile used |
ExifValues |
array of (ExifValue)
|
EXIF tags and values embedded in the image |
HasTransparency |
boolean
|
True if the image contains transparency, otherwise false |
Height |
integer(int32)
|
Height in pixels of the image |
ImageFormat |
string
|
Image format |
ImageHashSignature |
string
|
SHA256 hash signature of the image |
MimeType |
string
|
MIME type of the image format |
Successful |
boolean
|
|
Width |
integer(int32)
|
Width in pixels of the image |
Summary:
Description: Input to a Get Cell by cell identifier request
Properties:
Name |
Type |
Summary |
CellIdentifier |
string
|
Required; Excel cell identifier, e.g. A1, B22, C33, etc. |
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). |
WorksheetToQuery |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Get-Cell command
Properties:
Name |
Type |
Summary |
Cell |
|
Cell in an Excel Spreadsheet worksheet |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Cell request
Properties:
Name |
Type |
Summary |
CellIndex |
integer(int32)
|
0-based index of the cell, 0, 1, 2, ... in the row to retrieve |
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). |
RowIndex |
integer(int32)
|
0-based index of the row, 0, 1, 2, ... to retrieve |
WorksheetToQuery |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Get-Cell command
Properties:
Name |
Type |
Summary |
Cell |
|
Cell in an Excel Spreadsheet worksheet |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Columns 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). |
WorksheetToQuery |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Get-Columns command
Properties:
Name |
Type |
Summary |
Columns |
array of (XlsxSpreadsheetColumn)
|
Spreadsheet Columns in the XLSX document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Images 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). |
WorksheetToQuery |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Get-Images command
Properties:
Name |
Type |
Summary |
Images |
array of (XlsxImage)
|
Spreadsheet Images in the XLSX document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Worksheets 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). |
WorksheetToQuery |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Get-Worksheets command
Properties:
Name |
Type |
Summary |
Rows |
array of (XlsxSpreadsheetRow)
|
Spreadsheet Rows in the Excel XLSX document |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Worksheets 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: Result of running a Get-Worksheets command
Properties:
Name |
Type |
Summary |
CellStyles |
array of (DocxCellStyle)
|
Cell styles |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Worksheets 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: Result of running a Get-Worksheets command
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
Worksheets |
array of (XlsxWorksheet)
|
Worksheets in the Excel XLSX spreadsheet |
Summary:
Description: Result from converting a Markdown file to HTML
Properties:
Name |
Type |
Summary |
Html |
string
|
Resulting HTML from the conversion |
Successful |
boolean
|
True if operation was successful, false otherwise |
Summary:
Description: HTML template application request
Properties:
Name |
Type |
Summary |
HtmlTemplate |
string
|
HTML template input as a string |
HtmlTemplateUrl |
string
|
URL to HTML template input |
Operations |
array of (HtmlTemplateOperation)
|
Operations to apply to this template |
Summary:
Description: Response from an HTML template application
Properties:
Name |
Type |
Summary |
FinalHtml |
string
|
Final HTML result of all operations on input |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Action |
integer(int32)
|
Operation action to take; possible values are "Replace" Values: [] |
MatchAgsint |
string
|
For Replace operations, the string to match against (to be replaced with ReplaceWith string) |
ReplaceWith |
string
|
For Replace operations, the string to Replace the original string with |
Summary:
Description: Details of the HTML to Office request
Properties:
Name |
Type |
Summary |
Html |
string
|
HTML to render to Office format |
Summary:
Description: Details of the HTML to PDF request
Properties:
Name |
Type |
Summary |
ExtraLoadingWait |
integer(int32)
|
Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. |
Html |
string
|
HTML to render to PDF |
Summary:
Description: Details of the HTML to PNG request
Properties:
Name |
Type |
Summary |
ExtraLoadingWait |
integer(int32)
|
Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. |
Html |
string
|
HTML to render to PNG (screenshot) |
ScreenshotHeight |
integer(int32)
|
Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot |
ScreenshotWidth |
integer(int32)
|
Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot |
Summary:
Description: Details of the HTML to Text request
Properties:
Name |
Type |
Summary |
Html |
string
|
HTML to extract the text from |
Summary:
Description: Result of running the HTML to Text operation
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Text content result from the HTML input |
Summary:
Description: Result of running an Insert-Comment-on-Paragraph command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Insert Paragraph 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). |
InsertPath |
string
|
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject |
InsertPlacement |
string
|
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) |
ParagraphToInsert |
|
A paragraph in a Word Document (DOCX) file; there is where text, content and formatting are stored - similar to the paragraph tag in HTML |
Summary:
Description: Result of running an Insert-Paragraph command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Insert Table Row request
Properties:
Name |
Type |
Summary |
ExistingTablePath |
string
|
Required; the path to the existing table to modify |
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). |
InsertPlacement |
string
|
Optional; default is TableEnd. Placement Type of the insert; possible values are: TableStart (very beginning of the table), TableEnd (very end of the document), or a 0-based row index number as an integer, 0 being the first row in the table, 1 being the second row in the table, 2 being the third row in the table, etc. to insert this row after |
RowToInsert |
|
A row in a Word Document (DOCX) file |
Summary:
Description: Result of running an Insert-Table Row command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Insert Tables 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). |
InsertPath |
string
|
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject |
InsertPlacement |
string
|
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) |
TableToInsert |
|
A table in a Word Document (DOCX) file |
Summary:
Description: Result of running an Insert-Tables command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Get Worksheets 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). |
WorksheetToInsert |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Get-Worksheets command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Result of converting a multi-page image into individual pages with a different format
Properties:
Name |
Type |
Summary |
PageCount |
integer(int32)
|
The number of pages in the converted output |
Pages |
array of (PageConversionResult)
|
Converted page results |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Converted page as an image
Properties:
Name |
Type |
Summary |
FileBytes |
string(byte)
|
File bytes (contents) of the image in converted file format |
Filename |
string
|
File name of the image in the converted file format |
Summary:
Description: A single PDF file corresponding to one page in the original document
Properties:
Name |
Type |
Summary |
DocumentContents |
string(byte)
|
If returnDocumentContents is set to true, will contain the contents of the document; otherwise will be set to null and the document contents will be available via the URL parameter |
PageNumber |
integer(int32)
|
Page number of the converted page, starting with 1 for the first page |
URL |
string
|
URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted |
Summary:
Description: Result of converting a PDF to a PNG array
Properties:
Name |
Type |
Summary |
PngResultPages |
array of (ConvertedPngPage)
|
Array of converted pages |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: A single Excel XLSX file corresponding to one worksheet (tab) in the original spreadsheet
Properties:
Name |
Type |
Summary |
PresentationContents |
string(byte)
|
Contents of the presentation in bytes |
SlideNumber |
integer(int32)
|
Worksheet number of the converted page, starting with 1 for the left-most worksheet |
URL |
string
|
URL to the PPTX file of this slide; file is stored in an in-memory cache and will be deleted |
Summary:
Description: Input to a Remove Headers and Footers 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). |
RemoveFooters |
boolean
|
True if you would like to remove all footers from the input document, false otherwise |
RemoveHeaders |
boolean
|
True if you would like to remove all headers from the input document, false otherwise |
Summary:
Description: Result of running a Remove Headers and Footers command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL of the resulting edited document; this is a secure URL and cannot be downloaded without adding the Apikey header; it is also temporary, stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Remove Word DOCX Document Pages request
Properties:
Name |
Type |
Summary |
EndDeletePageNumber |
integer(int32)
|
Page number (1-based) to stop deleting pages; inclusive |
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). |
StartDeletePageNumber |
integer(int32)
|
Page number (1-based) to start deleting pages; inclusive |
Summary:
Description: Input to a Remove PowerPoint PPTX Presentation Slides request
Properties:
Name |
Type |
Summary |
EndDeleteSlideNumber |
integer(int32)
|
Slide number (1-based) to stop deleting slides; inclusive |
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). |
StartDeleteSlideNumber |
integer(int32)
|
Slide number (1-based) to start deleting slides; inclusive |
Summary:
Description: Input to a Remove Excel XLSX Spreadsheet worksheet 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). |
WorksheetToRemove |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Input to a string replacement 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). |
MatchCase |
boolean
|
True if the case should be matched, false for case insensitive match |
MatchString |
string
|
String to search for and match against, to be replaced |
ReplaceString |
string
|
String to replace the matched values with |
Summary:
Description: Details of the screenshot request
Properties:
Name |
Type |
Summary |
ExtraLoadingWait |
integer(int32)
|
Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds) |
ScreenshotHeight |
integer(int32)
|
Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot |
ScreenshotWidth |
integer(int32)
|
Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024 |
Url |
string
|
URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports. |
Summary:
Description: Input to a Set Cell by identifier in XLSX Worksheets request
Properties:
Name |
Type |
Summary |
CellIdentifier |
string
|
The Excel cell identifier (e.g. A1, B2, C33, etc.) of the cell to update |
CellValue |
|
Cell in an Excel Spreadsheet worksheet |
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). |
WorksheetToUpdate |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Set Cell by identifier in XLSX Worksheets command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Set Cell in XLSX Worksheets request
Properties:
Name |
Type |
Summary |
CellIndex |
integer(int32)
|
0-based index of the cell, 0, 1, 2, ... in the row to set |
CellValue |
|
Cell in an Excel Spreadsheet worksheet |
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). |
RowIndex |
integer(int32)
|
0-based index of the row, 0, 1, 2, ... to set |
WorksheetToUpdate |
|
A worksheet (tab) in an Excel (XLSX) spreadsheet |
Summary:
Description: Result of running a Set Cell in XLSX Worksheets command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: A single Word DOCX file corresponding to one page in the original document
Properties:
Name |
Type |
Summary |
DocumentContents |
string(byte)
|
Contents of the document in bytes |
PageNumber |
integer(int32)
|
Page number of the converted page, starting with 1 for the first page |
URL |
string
|
URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted |
Summary:
Description: The result of splitting a Word document into individual Word DOCX pages
Properties:
Name |
Type |
Summary |
ResultDocuments |
array of (SplitDocumentResult)
|
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing a PDF file split operation
Properties:
Name |
Type |
Summary |
Documents |
array of (PdfDocument)
|
PDF documents as output |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: The result of splitting a presentation into individual PowerPoint PPTX slides
Properties:
Name |
Type |
Summary |
ResultPresentations |
array of (PresentationResult)
|
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: The result of splitting a Text document into separate lines
Properties:
Name |
Type |
Summary |
LineCount |
integer(int32)
|
The count of lines in the text file |
ResultLines |
array of (TextDocumentLine)
|
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: The result of splitting a Text document into separate elements
Properties:
Name |
Type |
Summary |
ElementCount |
integer(int32)
|
The count of elements in the text file |
ResultElements |
array of (TextDocumentElement)
|
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: The result of splitting a spreadsheet into individual Excel XLSX worksheets
Properties:
Name |
Type |
Summary |
ResultWorksheets |
array of (WorksheetResult)
|
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Text conversion result from converting a document to Plain Text (TXT) format
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if the operation was successful, false otherwise |
TextResult |
string
|
Plain Text (TXT) format conversion result of the input document. The text result is returned as a string. |
Summary:
Description: A single element of a Text document
Properties:
Name |
Type |
Summary |
ElementContents |
string
|
The text contents of a single element of a text file |
ElementNumber |
integer(int32)
|
The 1-based line index of the element |
Summary:
Description: A single line of a Text document
Properties:
Name |
Type |
Summary |
LineContents |
string
|
The text contents of a single line of a text file |
LineNumber |
integer(int32)
|
The 1-based line index of the line |
Summary:
Description: Input to a Update Table Cell request
Properties:
Name |
Type |
Summary |
CellToUpdate |
|
A cell in a Word Document (DOCX) file |
ExistingTablePath |
string
|
Required; the path to the existing table to modify |
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). |
TableCellIndex |
integer(int32)
|
0-based index of the Table Cell (within the row) to update |
TableRowIndex |
integer(int32)
|
0-based index of the Table Row to update |
Summary:
Description: Result of running an Update Table Cell command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Input to a Update Table Row request
Properties:
Name |
Type |
Summary |
ExistingTablePath |
string
|
Required; the path to the existing table to modify |
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). |
RowToUpdate |
|
A row in a Word Document (DOCX) file |
TableRowIndex |
integer(int32)
|
0-based index of the Table Row to update |
Summary:
Description: Result of running an Update Table Row command
Properties:
Name |
Type |
Summary |
EditedDocumentURL |
string
|
URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. |
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Details of the URL website to Text request
Properties:
Name |
Type |
Summary |
Url |
string
|
URL of the website to extract the text from |
Summary:
Description: Result of running the URL website to Text operation
Properties:
Name |
Type |
Summary |
Successful |
boolean
|
True if successful, false otherwise |
TextContentResult |
string
|
Text content result from the URL website input |
Summary:
Description: A single Excel XLSX file corresponding to one worksheet (tab) in the original spreadsheet
Properties:
Name |
Type |
Summary |
URL |
string
|
URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted |
WorksheetContents |
string(byte)
|
Contents of the worksheet in bytes |
WorksheetName |
string
|
The name of the worksheet |
WorksheetNumber |
integer(int32)
|
Worksheet number of the converted page, starting with 1 for the left-most worksheet |
Summary:
Description:
Properties:
Name |
Type |
Summary |
ImageContentsURL |
string
|
URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents. |
ImageDataContentType |
string
|
Read-only; image data MIME content-type |
ImageDataEmbedId |
string
|
Read-only; internal ID for the image contents |
ImageInternalFileName |
string
|
Read-only; internal file name/path for the image |
Path |
string
|
The Path of the location of this object; leave blank for new rows |
Summary:
Description: Cell in an Excel Spreadsheet worksheet
Properties:
Name |
Type |
Summary |
CellIdentifier |
string
|
Cell reference of the cell, e.g. A1, Z22, etc. |
Formula |
string
|
|
Path |
string
|
The Path of the location of this object; leave blank for new rows |
StyleIndex |
integer(int32)
|
Identifier for the style to apply to this style |
TextValue |
string
|
Text value of the cell |
Summary:
Description: Column in an Excel spreadsheet worksheet
Properties:
Name |
Type |
Summary |
HeadingCell |
|
Cell in an Excel Spreadsheet worksheet |
Path |
string
|
The Path of the location of this object; leave blank for new rows |
Summary:
Description: Row in an Excel spreadsheet worksheet
Properties:
Name |
Type |
Summary |
Cells |
array of (XlsxSpreadsheetCell)
|
Spreadsheet Cells in the spreadsheet row |
Path |
string
|
The Path of the location of this object; leave blank for new rows |
Summary:
Description: A worksheet (tab) in an Excel (XLSX) spreadsheet
Properties:
Name |
Type |
Summary |
Path |
string
|
The Path of the location of this object; leave blank for new worksheets |
WorksheetName |
string
|
User-facing name of the worksheet tab |
Summary:
Description: Result of performing a add attribute node operation on XML input using XPath
Properties:
Name |
Type |
Summary |
NodesEditedCount |
integer(int32)
|
Count of the matching results |
ResultingXmlDocument |
string
|
Resulting, modified XML document |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing a add child node operation on XML input using XPath
Properties:
Name |
Type |
Summary |
NodesEditedCount |
integer(int32)
|
Count of the matching results |
ResultingXmlDocument |
string
|
Resulting, modified XML document |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing a filter operation on XML input using XPath
Properties:
Name |
Type |
Summary |
ResultCount |
integer(int32)
|
Count of the matching results |
Successful |
boolean
|
True if the operation was successful, false otherwise |
XmlNodes |
array of (string)
|
Matching selected XML nodes as strings |
Summary:
Description: Result of performing an XQuery operation on multiple XML documents.
Properties:
Name |
Type |
Summary |
ErrorMessage |
string
|
If an error occurs, additional details on the error |
ResultingXml |
string
|
Resulting XML result output |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing an XQuery operation on an XML document.
Properties:
Name |
Type |
Summary |
ErrorMessage |
string
|
If an error occurs, additional details on the error |
ResultingXml |
string
|
Resulting XML result output |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing a remove all child nodes operation on XML input using XPath
Properties:
Name |
Type |
Summary |
NodesEditedCount |
integer(int32)
|
Count of the matching results |
ResultingXmlDocument |
string
|
Resulting, modified XML document |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing a filter operation on XML input using XPath
Properties:
Name |
Type |
Summary |
NodesRemovedCount |
integer(int32)
|
Count of the matching results |
ResultingXmlDocument |
string
|
Resulting, modified XML document with matching nodes removed as a string |
Successful |
boolean
|
True if the operation was successful, false otherwise |
XmlNodesRemoved |
array of (string)
|
Matching selected XML nodes as strings |
Summary:
Description: Result of performing a replace node operation on XML input using XPath
Properties:
Name |
Type |
Summary |
NodesEditedCount |
integer(int32)
|
Count of the matching results |
ResultingXmlDocument |
string
|
Resulting, modified XML document |
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of performing a set value operation on XML input using XPath
Properties:
Name |
Type |
Summary |
NodesEditedCount |
integer(int32)
|
Count of the matching results |
ResultingXmlDocument |
string
|
Resulting, modified XML document |
Successful |
boolean
|
True if the operation was successful, false otherwise |