EditDocumentApi.md

Swagger\Client\EditDocumentApi

All URIs are relative to https://api.cloudmersive.com

Method	HTTP request	Description
editDocumentBeginEditing	POST /convert/edit/begin-editing	Begin editing a document
editDocumentDocxAcceptAllTrackChanges	POST /convert/edit/docx/track-changes/accept-all	Accept all tracked changes, revisions in a Word DOCX document
editDocumentDocxBody	POST /convert/edit/docx/get-body	Get body from a Word DOCX document
editDocumentDocxCreateBlankDocument	POST /convert/edit/docx/create/blank	Create a blank Word DOCX document
editDocumentDocxDeletePages	POST /convert/edit/docx/delete-pages	Delete, remove pages from a Word DOCX document
editDocumentDocxDeleteTableRow	POST /convert/edit/docx/delete-table-row	Deletes a table row in an existing table in a Word DOCX document
editDocumentDocxDeleteTableRowRange	POST /convert/edit/docx/delete-table-row/range	Deletes a range of multiple table rows in an existing table in a Word DOCX document
editDocumentDocxDisableTrackChanges	POST /convert/edit/docx/track-changes/disable	Disable track changes, revisions in a Word DOCX document
editDocumentDocxEnableTrackChanges	POST /convert/edit/docx/track-changes/enable	Enable track changes, revisions in a Word DOCX document
editDocumentDocxFindParagraph	POST /convert/edit/docx/find/paragraph	Find matching paragraphs in a Word DOCX document
editDocumentDocxGetComments	POST /convert/edit/docx/get-comments/flat-list	Get comments from a Word DOCX document as a flat list
editDocumentDocxGetCommentsHierarchical	POST /convert/edit/docx/get-comments/hierarchical	Get comments from a Word DOCX document hierarchically
editDocumentDocxGetContentControls	POST /convert/edit/docx/get-content-controls	Get all content controls (form fields) and values in a Word DOCX document
editDocumentDocxGetFormFields	POST /convert/edit/docx/get-form-fields	Get all form fields in a Word DOCX document
editDocumentDocxGetHeadersAndFooters	POST /convert/edit/docx/get-headers-and-footers	Get content of a footer from a Word DOCX document
editDocumentDocxGetImages	POST /convert/edit/docx/get-images	Get images from a Word DOCX document
editDocumentDocxGetMacroInformation	POST /convert/edit/docx/get-macros	Get macro information from a Word DOCX/DOCM document
editDocumentDocxGetMetadataProperties	POST /convert/edit/docx/get-metadata	Get all metadata properties in Word DOCX document
editDocumentDocxGetSections	POST /convert/edit/docx/get-sections	Get sections from a Word DOCX document
editDocumentDocxGetStyles	POST /convert/edit/docx/get-styles	Get styles from a Word DOCX document
editDocumentDocxGetTableByIndex	POST /convert/edit/docx/get-table/by-index	Get a specific table by index in a Word DOCX document
editDocumentDocxGetTableRow	POST /convert/edit/docx/get-table-row	Gets the contents of an existing table row in an existing table in a Word DOCX document
editDocumentDocxGetTables	POST /convert/edit/docx/get-tables	Get all tables in Word DOCX document
editDocumentDocxInsertCommentOnParagraph	POST /convert/edit/docx/insert-comment/on/paragraph	Insert a new comment into a Word DOCX document attached to a paragraph
editDocumentDocxInsertImage	POST /convert/edit/docx/insert-image	Insert image into a Word DOCX document
editDocumentDocxInsertParagraph	POST /convert/edit/docx/insert-paragraph	Insert a new paragraph into a Word DOCX document
editDocumentDocxInsertTable	POST /convert/edit/docx/insert-table	Insert a new table into a Word DOCX document
editDocumentDocxInsertTableRow	POST /convert/edit/docx/insert-table-row	Insert a new row into an existing table in a Word DOCX document
editDocumentDocxPages	POST /convert/edit/docx/get-pages	Get pages and content from a Word DOCX document
editDocumentDocxRemoveAllComments	POST /convert/edit/docx/comments/remove-all	Remove all comments from a Word DOCX document
editDocumentDocxRemoveHeadersAndFooters	POST /convert/edit/docx/remove-headers-and-footers	Remove headers and footers from Word DOCX document
editDocumentDocxRemoveObject	POST /convert/edit/docx/remove-object	Delete any object in a Word DOCX document
editDocumentDocxReplace	POST /convert/edit/docx/replace-all	Replace string in Word DOCX document
editDocumentDocxReplaceMulti	POST /convert/edit/docx/replace-all/multi	Replace multiple strings in Word DOCX document, return result
editDocumentDocxReplaceMultiEditSession	POST /convert/edit/docx/replace-all/multi/edit-session	Replace multiple strings in Word DOCX document, return edit session
editDocumentDocxReplaceParagraph	POST /convert/edit/docx/replace/paragraph	Replace matching paragraphs in a Word DOCX document
editDocumentDocxSetCustomMetadataProperties	POST /convert/edit/docx/set-metadata/custom-property	Set custom property metadata properties in Word DOCX document
editDocumentDocxSetFooter	POST /convert/edit/docx/set-footer	Set the footer in a Word DOCX document
editDocumentDocxSetFooterAddPageNumber	POST /convert/edit/docx/set-footer/add-page-number	Add page number to footer in a Word DOCX document
editDocumentDocxSetFormFields	POST /convert/edit/docx/set-form-fields	Set and fill values for form fields in a Word DOCX document
editDocumentDocxSetHeader	POST /convert/edit/docx/set-header	Set the header in a Word DOCX document
editDocumentDocxUpdateTableCell	POST /convert/edit/docx/update-table-cell	Update, set contents of a table cell in an existing table in a Word DOCX document
editDocumentDocxUpdateTableRow	POST /convert/edit/docx/update-table-row	Update, set contents of a table row in an existing table in a Word DOCX document
editDocumentFinishEditing	POST /convert/edit/finish-editing	Finish editing document, and download result from document editing
editDocumentPptxDeleteSlides	POST /convert/edit/pptx/delete-slides	Delete, remove slides from a PowerPoint PPTX presentation document
editDocumentPptxGetMacroInformation	POST /convert/edit/pptx/get-macros	Get macro information from a PowerPoint PPTX/PPTM presentation document
editDocumentPptxReplace	POST /convert/edit/pptx/replace-all	Replace string in PowerPoint PPTX presentation
editDocumentXlsxAppendRow	POST /convert/edit/xlsx/append-row	Append row to a Excel XLSX spreadsheet, worksheet
editDocumentXlsxClearCellByIndex	POST /convert/edit/xlsx/clear-cell/by-index	Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
editDocumentXlsxClearRow	POST /convert/edit/xlsx/clear-row	Clear row from a Excel XLSX spreadsheet, worksheet
editDocumentXlsxCreateBlankSpreadsheet	POST /convert/edit/xlsx/create/blank	Create a blank Excel XLSX spreadsheet
editDocumentXlsxCreateSpreadsheetFromData	POST /convert/edit/xlsx/create/from/data	Create a new Excel XLSX spreadsheet from column and row data
editDocumentXlsxDeleteWorksheet	POST /convert/edit/xlsx/delete-worksheet	Delete, remove worksheet from an Excel XLSX spreadsheet document
editDocumentXlsxDisableSharedWorkbook	POST /convert/edit/xlsx/configuration/disable-shared-workbook	Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
editDocumentXlsxEnableSharedWorkbook	POST /convert/edit/xlsx/configuration/enable-shared-workbook	Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
editDocumentXlsxGetCellByIdentifier	POST /convert/edit/xlsx/get-cell/by-identifier	Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
editDocumentXlsxGetCellByIndex	POST /convert/edit/xlsx/get-cell/by-index	Get cell from an Excel XLSX spreadsheet, worksheet by index
editDocumentXlsxGetColumns	POST /convert/edit/xlsx/get-columns	Get columns from a Excel XLSX spreadsheet, worksheet
editDocumentXlsxGetImages	POST /convert/edit/xlsx/get-images	Get images from a Excel XLSX spreadsheet, worksheet
editDocumentXlsxGetMacroInformation	POST /convert/edit/xlsx/get-macros	Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
editDocumentXlsxGetRowsAndCells	POST /convert/edit/xlsx/get-rows-and-cells	Get rows and cells from a Excel XLSX spreadsheet, worksheet
editDocumentXlsxGetSpecificRow	POST /convert/edit/xlsx/get-specific-row	Get a specific row from a Excel XLSX spreadsheet, worksheet by path
editDocumentXlsxGetStyles	POST /convert/edit/xlsx/get-styles	Get styles from a Excel XLSX spreadsheet, worksheet
editDocumentXlsxGetWorksheets	POST /convert/edit/xlsx/get-worksheets	Get worksheets from a Excel XLSX spreadsheet
editDocumentXlsxInsertWorksheet	POST /convert/edit/xlsx/insert-worksheet	Insert a new worksheet into an Excel XLSX spreadsheet
editDocumentXlsxRenameWorksheet	POST /convert/edit/xlsx/rename-worksheet	Rename a specific worksheet in a Excel XLSX spreadsheet
editDocumentXlsxSetCellByIdentifier	POST /convert/edit/xlsx/set-cell/by-identifier	Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
editDocumentXlsxSetCellByIndex	POST /convert/edit/xlsx/set-cell/by-index	Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index

editDocumentBeginEditing

string editDocumentBeginEditing($input_file)

Begin editing a document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentBeginEditing($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentBeginEditing: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxAcceptAllTrackChanges

string editDocumentDocxAcceptAllTrackChanges($input_file)

Accept all tracked changes, revisions in a Word DOCX document

Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxAcceptAllTrackChanges($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxAcceptAllTrackChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxBody

\Swagger\Client\Model\GetDocxBodyResponse editDocumentDocxBody($req_config)

Get body from a Word DOCX document

Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxBodyRequest(); // \Swagger\Client\Model\GetDocxBodyRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxBody($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxBody: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxBodyRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxBodyResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxCreateBlankDocument

\Swagger\Client\Model\CreateBlankDocxResponse editDocumentDocxCreateBlankDocument($input)

Create a blank Word DOCX document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\CreateBlankDocxRequest(); // \Swagger\Client\Model\CreateBlankDocxRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxCreateBlankDocument($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxCreateBlankDocument: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\CreateBlankDocxRequest	Document input request

Return type

\Swagger\Client\Model\CreateBlankDocxResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxDeletePages

string editDocumentDocxDeletePages($req_config)

Delete, remove pages from a Word DOCX document

Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\RemoveDocxPagesRequest(); // \Swagger\Client\Model\RemoveDocxPagesRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxDeletePages($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxDeletePages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\RemoveDocxPagesRequest	Document input request

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxDeleteTableRow

\Swagger\Client\Model\DeleteDocxTableRowResponse editDocumentDocxDeleteTableRow($req_config)

Deletes a table row in an existing table in a Word DOCX document

Deletes an existing table row in a Word DOCX Document and returns the result.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DeleteDocxTableRowRequest(); // \Swagger\Client\Model\DeleteDocxTableRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxDeleteTableRow($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxDeleteTableRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DeleteDocxTableRowRequest	Document input request

Return type

\Swagger\Client\Model\DeleteDocxTableRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxDeleteTableRowRange

\Swagger\Client\Model\DeleteDocxTableRowRangeResponse editDocumentDocxDeleteTableRowRange($req_config)

Deletes a range of multiple table rows in an existing table in a Word DOCX document

Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DeleteDocxTableRowRangeRequest(); // \Swagger\Client\Model\DeleteDocxTableRowRangeRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxDeleteTableRowRange($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxDeleteTableRowRange: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DeleteDocxTableRowRangeRequest	Document input request

Return type

\Swagger\Client\Model\DeleteDocxTableRowRangeResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxDisableTrackChanges

string editDocumentDocxDisableTrackChanges($input_file)

Disable track changes, revisions in a Word DOCX document

Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxDisableTrackChanges($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxDisableTrackChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxEnableTrackChanges

string editDocumentDocxEnableTrackChanges($input_file)

Enable track changes, revisions in a Word DOCX document

Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxEnableTrackChanges($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxEnableTrackChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxFindParagraph

\Swagger\Client\Model\FindDocxParagraphResponse editDocumentDocxFindParagraph($req_config)

Find matching paragraphs in a Word DOCX document

Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\FindDocxParagraphRequest(); // \Swagger\Client\Model\FindDocxParagraphRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxFindParagraph($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxFindParagraph: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\FindDocxParagraphRequest	Document input request

Return type

\Swagger\Client\Model\FindDocxParagraphResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetComments

\Swagger\Client\Model\GetDocxCommentsResponse editDocumentDocxGetComments($req_config)

Get comments from a Word DOCX document as a flat list

Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxGetCommentsRequest(); // \Swagger\Client\Model\GetDocxGetCommentsRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetComments($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetComments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxGetCommentsRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxCommentsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetCommentsHierarchical

\Swagger\Client\Model\GetDocxCommentsHierarchicalResponse editDocumentDocxGetCommentsHierarchical($req_config)

Get comments from a Word DOCX document hierarchically

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxGetCommentsHierarchicalRequest(); // \Swagger\Client\Model\GetDocxGetCommentsHierarchicalRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetCommentsHierarchical($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetCommentsHierarchical: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxGetCommentsHierarchicalRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxCommentsHierarchicalResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetContentControls

\Swagger\Client\Model\GetDocxContentControlsResponse editDocumentDocxGetContentControls($input_file)

Get all content controls (form fields) and values in a Word DOCX document

Returns all the content controls, used for creating form fields, in a Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxGetContentControls($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetContentControls: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\GetDocxContentControlsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetFormFields

\Swagger\Client\Model\GetDocxGetFormFieldsResponse editDocumentDocxGetFormFields($input_file)

Get all form fields in a Word DOCX document

Returns all the content controls, used for creating form fields, as well as handlebar style text-based form fields such as "{{FieldName}}", in a Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxGetFormFields($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetFormFields: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\GetDocxGetFormFieldsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetHeadersAndFooters

\Swagger\Client\Model\GetDocxHeadersAndFootersResponse editDocumentDocxGetHeadersAndFooters($req_config)

Get content of a footer from a Word DOCX document

Returns the footer content from a Word Document (DOCX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxHeadersAndFootersRequest(); // \Swagger\Client\Model\GetDocxHeadersAndFootersRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetHeadersAndFooters($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetHeadersAndFooters: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxHeadersAndFootersRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxHeadersAndFootersResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetImages

\Swagger\Client\Model\GetDocxImagesResponse editDocumentDocxGetImages($req_config)

Get images from a Word DOCX document

Returns the images defined in the Word Document (DOCX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxImagesRequest(); // \Swagger\Client\Model\GetDocxImagesRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetImages($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetImages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxImagesRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxImagesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetMacroInformation

\Swagger\Client\Model\GetMacrosResponse editDocumentDocxGetMacroInformation($input_file)

Get macro information from a Word DOCX/DOCM document

Returns information about the Macros (e.g. VBA) defined in the Word Document

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxGetMacroInformation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetMacroInformation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\GetMacrosResponse

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetMetadataProperties

\Swagger\Client\Model\GetDocxMetadataPropertiesResponse editDocumentDocxGetMetadataProperties($input_file)

Get all metadata properties in Word DOCX document

Returns all the metadata properties in an Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxGetMetadataProperties($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetMetadataProperties: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\GetDocxMetadataPropertiesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetSections

\Swagger\Client\Model\GetDocxSectionsResponse editDocumentDocxGetSections($req_config)

Get sections from a Word DOCX document

Returns the sections defined in the Word Document (DOCX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxSectionsRequest(); // \Swagger\Client\Model\GetDocxSectionsRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetSections($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetSections: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxSectionsRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxSectionsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetStyles

\Swagger\Client\Model\GetDocxStylesResponse editDocumentDocxGetStyles($req_config)

Get styles from a Word DOCX document

Returns the styles defined in the Word Document (DOCX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxStylesRequest(); // \Swagger\Client\Model\GetDocxStylesRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetStyles($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetStyles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxStylesRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxStylesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetTableByIndex

\Swagger\Client\Model\GetDocxTableByIndexResponse editDocumentDocxGetTableByIndex($req_config)

Get a specific table by index in a Word DOCX document

Returns the specific table object by its 0-based index in an Office Word Document (DOCX)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxTableByIndexRequest(); // \Swagger\Client\Model\GetDocxTableByIndexRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetTableByIndex($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetTableByIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxTableByIndexRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxTableByIndexResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetTableRow

\Swagger\Client\Model\GetDocxTableRowResponse editDocumentDocxGetTableRow($req_config)

Gets the contents of an existing table row in an existing table in a Word DOCX document

Gets the contents of an existing table row in a Word DOCX Document and returns the result.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxTableRowRequest(); // \Swagger\Client\Model\GetDocxTableRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetTableRow($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetTableRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxTableRowRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxTableRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxGetTables

\Swagger\Client\Model\GetDocxTablesResponse editDocumentDocxGetTables($req_config)

Get all tables in Word DOCX document

Returns all the table objects in an Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxTablesRequest(); // \Swagger\Client\Model\GetDocxTablesRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxGetTables($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxGetTables: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxTablesRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxTablesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxInsertCommentOnParagraph

\Swagger\Client\Model\InsertDocxCommentOnParagraphResponse editDocumentDocxInsertCommentOnParagraph($req_config)

Insert a new comment into a Word DOCX document attached to a paragraph

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxInsertCommentOnParagraphRequest(); // \Swagger\Client\Model\DocxInsertCommentOnParagraphRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxInsertCommentOnParagraph($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxInsertCommentOnParagraph: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxInsertCommentOnParagraphRequest	Document input request

Return type

\Swagger\Client\Model\InsertDocxCommentOnParagraphResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxInsertImage

\Swagger\Client\Model\DocxInsertImageResponse editDocumentDocxInsertImage($req_config)

Insert image into a Word DOCX document

Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxInsertImageRequest(); // \Swagger\Client\Model\DocxInsertImageRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxInsertImage($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxInsertImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxInsertImageRequest	Document input request

Return type

\Swagger\Client\Model\DocxInsertImageResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxInsertParagraph

\Swagger\Client\Model\InsertDocxInsertParagraphResponse editDocumentDocxInsertParagraph($req_config)

Insert a new paragraph into a Word DOCX document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\InsertDocxInsertParagraphRequest(); // \Swagger\Client\Model\InsertDocxInsertParagraphRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxInsertParagraph($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxInsertParagraph: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\InsertDocxInsertParagraphRequest	Document input request

Return type

\Swagger\Client\Model\InsertDocxInsertParagraphResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxInsertTable

\Swagger\Client\Model\InsertDocxTablesResponse editDocumentDocxInsertTable($req_config)

Insert a new table into a Word DOCX document

Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\InsertDocxTablesRequest(); // \Swagger\Client\Model\InsertDocxTablesRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxInsertTable($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxInsertTable: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\InsertDocxTablesRequest	Document input request

Return type

\Swagger\Client\Model\InsertDocxTablesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxInsertTableRow

\Swagger\Client\Model\InsertDocxTableRowResponse editDocumentDocxInsertTableRow($req_config)

Insert a new row into an existing table in a Word DOCX document

Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\InsertDocxTableRowRequest(); // \Swagger\Client\Model\InsertDocxTableRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxInsertTableRow($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxInsertTableRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\InsertDocxTableRowRequest	Document input request

Return type

\Swagger\Client\Model\InsertDocxTableRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxPages

\Swagger\Client\Model\GetDocxPagesResponse editDocumentDocxPages($req_config)

Get pages and content from a Word DOCX document

Returns the pages and contents of each page defined in the Word Document (DOCX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\GetDocxPagesRequest(); // \Swagger\Client\Model\GetDocxPagesRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxPages($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxPages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\GetDocxPagesRequest	Document input request

Return type

\Swagger\Client\Model\GetDocxPagesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxRemoveAllComments

string editDocumentDocxRemoveAllComments($input_file)

Remove all comments from a Word DOCX document

Removes all of the comments from a Word Document.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentDocxRemoveAllComments($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxRemoveAllComments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxRemoveHeadersAndFooters

\Swagger\Client\Model\RemoveDocxHeadersAndFootersResponse editDocumentDocxRemoveHeadersAndFooters($req_config)

Remove headers and footers from Word DOCX document

Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\RemoveDocxHeadersAndFootersRequest(); // \Swagger\Client\Model\RemoveDocxHeadersAndFootersRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxRemoveHeadersAndFooters($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxRemoveHeadersAndFooters: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\RemoveDocxHeadersAndFootersRequest	Document input request

Return type

\Swagger\Client\Model\RemoveDocxHeadersAndFootersResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxRemoveObject

\Swagger\Client\Model\DocxRemoveObjectResponse editDocumentDocxRemoveObject($req_config)

Delete any object in a Word DOCX document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxRemoveObjectRequest(); // \Swagger\Client\Model\DocxRemoveObjectRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxRemoveObject($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxRemoveObject: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxRemoveObjectRequest	Document input request

Return type

\Swagger\Client\Model\DocxRemoveObjectResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxReplace

string editDocumentDocxReplace($req_config)

Replace string in Word DOCX document

Replace all instances of a string in an Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\ReplaceStringRequest(); // \Swagger\Client\Model\ReplaceStringRequest | Document string replacement configuration input

try {
    $result = $apiInstance->editDocumentDocxReplace($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxReplace: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\ReplaceStringRequest	Document string replacement configuration input

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxReplaceMulti

string editDocumentDocxReplaceMulti($req_config)

Replace multiple strings in Word DOCX document, return result

Replace all instances of multiple strings in an Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\MultiReplaceStringRequest(); // \Swagger\Client\Model\MultiReplaceStringRequest | Document string replacement configuration input

try {
    $result = $apiInstance->editDocumentDocxReplaceMulti($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxReplaceMulti: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\MultiReplaceStringRequest	Document string replacement configuration input

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxReplaceMultiEditSession

\Swagger\Client\Model\DocumentEditingEditSession editDocumentDocxReplaceMultiEditSession($req_config)

Replace multiple strings in Word DOCX document, return edit session

Replace all instances of multiple strings in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\MultiReplaceStringRequest(); // \Swagger\Client\Model\MultiReplaceStringRequest | Document string replacement configuration input

try {
    $result = $apiInstance->editDocumentDocxReplaceMultiEditSession($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxReplaceMultiEditSession: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\MultiReplaceStringRequest	Document string replacement configuration input

Return type

\Swagger\Client\Model\DocumentEditingEditSession

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxReplaceParagraph

\Swagger\Client\Model\ReplaceDocxParagraphResponse editDocumentDocxReplaceParagraph($req_config)

Replace matching paragraphs in a Word DOCX document

Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\ReplaceDocxParagraphRequest(); // \Swagger\Client\Model\ReplaceDocxParagraphRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxReplaceParagraph($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxReplaceParagraph: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\ReplaceDocxParagraphRequest	Document input request

Return type

\Swagger\Client\Model\ReplaceDocxParagraphResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxSetCustomMetadataProperties

string editDocumentDocxSetCustomMetadataProperties($input)

Set custom property metadata properties in Word DOCX document

Sets the custom property metadata for the metadata properties in an Office Word Document (docx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\DocxSetCustomMetadataPropertiesRequest(); // \Swagger\Client\Model\DocxSetCustomMetadataPropertiesRequest | 

try {
    $result = $apiInstance->editDocumentDocxSetCustomMetadataProperties($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxSetCustomMetadataProperties: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\DocxSetCustomMetadataPropertiesRequest

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxSetFooter

\Swagger\Client\Model\DocxSetFooterResponse editDocumentDocxSetFooter($req_config)

Set the footer in a Word DOCX document

Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxSetFooterRequest(); // \Swagger\Client\Model\DocxSetFooterRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxSetFooter($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxSetFooter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxSetFooterRequest	Document input request

Return type

\Swagger\Client\Model\DocxSetFooterResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxSetFooterAddPageNumber

\Swagger\Client\Model\DocxSetFooterResponse editDocumentDocxSetFooterAddPageNumber($req_config)

Add page number to footer in a Word DOCX document

Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxSetFooterAddPageNumberRequest(); // \Swagger\Client\Model\DocxSetFooterAddPageNumberRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxSetFooterAddPageNumber($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxSetFooterAddPageNumber: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxSetFooterAddPageNumberRequest	Document input request

Return type

\Swagger\Client\Model\DocxSetFooterResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxSetFormFields

string editDocumentDocxSetFormFields($req_config)

Set and fill values for form fields in a Word DOCX document

Modifies a Office Word Document (docx) by filling in form fields using the provided values.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxSetFormFieldsRequest(); // \Swagger\Client\Model\DocxSetFormFieldsRequest | 

try {
    $result = $apiInstance->editDocumentDocxSetFormFields($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxSetFormFields: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxSetFormFieldsRequest

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxSetHeader

\Swagger\Client\Model\DocxSetHeaderResponse editDocumentDocxSetHeader($req_config)

Set the header in a Word DOCX document

Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\DocxSetHeaderRequest(); // \Swagger\Client\Model\DocxSetHeaderRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxSetHeader($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxSetHeader: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\DocxSetHeaderRequest	Document input request

Return type

\Swagger\Client\Model\DocxSetHeaderResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxUpdateTableCell

\Swagger\Client\Model\UpdateDocxTableCellResponse editDocumentDocxUpdateTableCell($req_config)

Update, set contents of a table cell in an existing table in a Word DOCX document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\UpdateDocxTableCellRequest(); // \Swagger\Client\Model\UpdateDocxTableCellRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxUpdateTableCell($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxUpdateTableCell: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\UpdateDocxTableCellRequest	Document input request

Return type

\Swagger\Client\Model\UpdateDocxTableCellResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentDocxUpdateTableRow

\Swagger\Client\Model\UpdateDocxTableRowResponse editDocumentDocxUpdateTableRow($req_config)

Update, set contents of a table row in an existing table in a Word DOCX document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\UpdateDocxTableRowRequest(); // \Swagger\Client\Model\UpdateDocxTableRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentDocxUpdateTableRow($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxUpdateTableRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\UpdateDocxTableRowRequest	Document input request

Return type

\Swagger\Client\Model\UpdateDocxTableRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentFinishEditing

string editDocumentFinishEditing($req_config)

Finish editing document, and download result from document editing

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\FinishEditingRequest(); // \Swagger\Client\Model\FinishEditingRequest | Cloudmersive Document URL to complete editing on

try {
    $result = $apiInstance->editDocumentFinishEditing($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentFinishEditing: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\FinishEditingRequest	Cloudmersive Document URL to complete editing on

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentPptxDeleteSlides

string editDocumentPptxDeleteSlides($req_config)

Delete, remove slides from a PowerPoint PPTX presentation document

Edits the input PowerPoint PPTX presentation document to remove the specified slides

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\RemovePptxSlidesRequest(); // \Swagger\Client\Model\RemovePptxSlidesRequest | Presentation input request

try {
    $result = $apiInstance->editDocumentPptxDeleteSlides($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentPptxDeleteSlides: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\RemovePptxSlidesRequest	Presentation input request

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentPptxGetMacroInformation

\Swagger\Client\Model\GetMacrosResponse editDocumentPptxGetMacroInformation($input_file)

Get macro information from a PowerPoint PPTX/PPTM presentation document

Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentPptxGetMacroInformation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentPptxGetMacroInformation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\GetMacrosResponse

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentPptxReplace

string editDocumentPptxReplace($req_config)

Replace string in PowerPoint PPTX presentation

Replace all instances of a string in an Office PowerPoint Document (pptx)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\ReplaceStringRequest(); // \Swagger\Client\Model\ReplaceStringRequest | Replacement document configuration input

try {
    $result = $apiInstance->editDocumentPptxReplace($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentPptxReplace: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\ReplaceStringRequest	Replacement document configuration input

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxAppendRow

\Swagger\Client\Model\AppendXlsxRowResponse editDocumentXlsxAppendRow($input)

Append row to a Excel XLSX spreadsheet, worksheet

Appends a row to the end of an Excel Spreadsheet worksheet.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\AppendXlsxRowRequest(); // \Swagger\Client\Model\AppendXlsxRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxAppendRow($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxAppendRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\AppendXlsxRowRequest	Document input request

Return type

\Swagger\Client\Model\AppendXlsxRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxClearCellByIndex

\Swagger\Client\Model\ClearXlsxCellResponse editDocumentXlsxClearCellByIndex($input)

Clear cell contents in an Excel XLSX spreadsheet, worksheet by index

Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\ClearXlsxCellRequest(); // \Swagger\Client\Model\ClearXlsxCellRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxClearCellByIndex($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxClearCellByIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\ClearXlsxCellRequest	Document input request

Return type

\Swagger\Client\Model\ClearXlsxCellResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxClearRow

\Swagger\Client\Model\ClearXlsxRowResponse editDocumentXlsxClearRow($input)

Clear row from a Excel XLSX spreadsheet, worksheet

Clears data from a specific row in the Excel Spreadsheet worksheet, leaving a blank row. Use the Get Rows And Cells API to enumerate available rows in a spreadsheet.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\ClearXlsxRowRequest(); // \Swagger\Client\Model\ClearXlsxRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxClearRow($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxClearRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\ClearXlsxRowRequest	Document input request

Return type

\Swagger\Client\Model\ClearXlsxRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxCreateBlankSpreadsheet

\Swagger\Client\Model\CreateBlankSpreadsheetResponse editDocumentXlsxCreateBlankSpreadsheet($input)

Create a blank Excel XLSX spreadsheet

Returns a blank Excel XLSX Spreadsheet (XLSX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\CreateBlankSpreadsheetRequest(); // \Swagger\Client\Model\CreateBlankSpreadsheetRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxCreateBlankSpreadsheet($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxCreateBlankSpreadsheet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\CreateBlankSpreadsheetRequest	Document input request

Return type

\Swagger\Client\Model\CreateBlankSpreadsheetResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxCreateSpreadsheetFromData

\Swagger\Client\Model\CreateSpreadsheetFromDataResponse editDocumentXlsxCreateSpreadsheetFromData($input)

Create a new Excel XLSX spreadsheet from column and row data

Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\CreateSpreadsheetFromDataRequest(); // \Swagger\Client\Model\CreateSpreadsheetFromDataRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxCreateSpreadsheetFromData($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxCreateSpreadsheetFromData: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\CreateSpreadsheetFromDataRequest	Document input request

Return type

\Swagger\Client\Model\CreateSpreadsheetFromDataResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxDeleteWorksheet

string editDocumentXlsxDeleteWorksheet($req_config)

Delete, remove worksheet from an Excel XLSX spreadsheet document

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$req_config = new \Swagger\Client\Model\RemoveXlsxWorksheetRequest(); // \Swagger\Client\Model\RemoveXlsxWorksheetRequest | Spreadsheet input request

try {
    $result = $apiInstance->editDocumentXlsxDeleteWorksheet($req_config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxDeleteWorksheet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
req_config	\Swagger\Client\Model\RemoveXlsxWorksheetRequest	Spreadsheet input request

Return type

string

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxDisableSharedWorkbook

\Swagger\Client\Model\DisableSharedWorkbookResponse editDocumentXlsxDisableSharedWorkbook($input)

Disable Shared Workbook (legacy) in Excel XLSX spreadsheet

Disable the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\DisableSharedWorkbookRequest(); // \Swagger\Client\Model\DisableSharedWorkbookRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxDisableSharedWorkbook($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxDisableSharedWorkbook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\DisableSharedWorkbookRequest	Document input request

Return type

\Swagger\Client\Model\DisableSharedWorkbookResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxEnableSharedWorkbook

\Swagger\Client\Model\EnableSharedWorkbookResponse editDocumentXlsxEnableSharedWorkbook($input)

Enable Shared Workbook (legacy) in Excel XLSX spreadsheet

Enables the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\EnableSharedWorkbookRequest(); // \Swagger\Client\Model\EnableSharedWorkbookRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxEnableSharedWorkbook($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxEnableSharedWorkbook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\EnableSharedWorkbookRequest	Document input request

Return type

\Swagger\Client\Model\EnableSharedWorkbookResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetCellByIdentifier

\Swagger\Client\Model\GetXlsxCellByIdentifierResponse editDocumentXlsxGetCellByIdentifier($input)

Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier

Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxCellByIdentifierRequest(); // \Swagger\Client\Model\GetXlsxCellByIdentifierRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetCellByIdentifier($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetCellByIdentifier: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxCellByIdentifierRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxCellByIdentifierResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetCellByIndex

\Swagger\Client\Model\GetXlsxCellResponse editDocumentXlsxGetCellByIndex($input)

Get cell from an Excel XLSX spreadsheet, worksheet by index

Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxCellRequest(); // \Swagger\Client\Model\GetXlsxCellRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetCellByIndex($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetCellByIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxCellRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxCellResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetColumns

\Swagger\Client\Model\GetXlsxColumnsResponse editDocumentXlsxGetColumns($input)

Get columns from a Excel XLSX spreadsheet, worksheet

Returns the columns defined in the Excel Spreadsheet worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxColumnsRequest(); // \Swagger\Client\Model\GetXlsxColumnsRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetColumns($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetColumns: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxColumnsRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxColumnsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetImages

\Swagger\Client\Model\GetXlsxImagesResponse editDocumentXlsxGetImages($input)

Get images from a Excel XLSX spreadsheet, worksheet

Returns the images defined in the Excel Spreadsheet worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxImagesRequest(); // \Swagger\Client\Model\GetXlsxImagesRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetImages($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetImages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxImagesRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxImagesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetMacroInformation

\Swagger\Client\Model\GetMacrosResponse editDocumentXlsxGetMacroInformation($input_file)

Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet

Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->editDocumentXlsxGetMacroInformation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetMacroInformation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\GetMacrosResponse

Authorization

Apikey

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetRowsAndCells

\Swagger\Client\Model\GetXlsxRowsAndCellsResponse editDocumentXlsxGetRowsAndCells($input)

Get rows and cells from a Excel XLSX spreadsheet, worksheet

Returns the rows and cells defined in the Excel Spreadsheet worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxRowsAndCellsRequest(); // \Swagger\Client\Model\GetXlsxRowsAndCellsRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetRowsAndCells($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetRowsAndCells: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxRowsAndCellsRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxRowsAndCellsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetSpecificRow

\Swagger\Client\Model\GetXlsxSpecificRowResponse editDocumentXlsxGetSpecificRow($input)

Get a specific row from a Excel XLSX spreadsheet, worksheet by path

Returns the specific row and its cells defined in the Excel Spreadsheet worksheet based on the specified path.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxSpecificRowRequest(); // \Swagger\Client\Model\GetXlsxSpecificRowRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetSpecificRow($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetSpecificRow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxSpecificRowRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxSpecificRowResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetStyles

\Swagger\Client\Model\GetXlsxStylesResponse editDocumentXlsxGetStyles($input)

Get styles from a Excel XLSX spreadsheet, worksheet

Returns the style defined in the Excel Spreadsheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxStylesRequest(); // \Swagger\Client\Model\GetXlsxStylesRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetStyles($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetStyles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxStylesRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxStylesResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxGetWorksheets

\Swagger\Client\Model\GetXlsxWorksheetsResponse editDocumentXlsxGetWorksheets($input)

Get worksheets from a Excel XLSX spreadsheet

Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\GetXlsxWorksheetsRequest(); // \Swagger\Client\Model\GetXlsxWorksheetsRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxGetWorksheets($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxGetWorksheets: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\GetXlsxWorksheetsRequest	Document input request

Return type

\Swagger\Client\Model\GetXlsxWorksheetsResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxInsertWorksheet

\Swagger\Client\Model\InsertXlsxWorksheetResponse editDocumentXlsxInsertWorksheet($input)

Insert a new worksheet into an Excel XLSX spreadsheet

Inserts a new worksheet into an Excel Spreadsheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\InsertXlsxWorksheetRequest(); // \Swagger\Client\Model\InsertXlsxWorksheetRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxInsertWorksheet($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxInsertWorksheet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\InsertXlsxWorksheetRequest	Document input request

Return type

\Swagger\Client\Model\InsertXlsxWorksheetResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxRenameWorksheet

\Swagger\Client\Model\RenameXlsxWorksheetResponse editDocumentXlsxRenameWorksheet($input)

Rename a specific worksheet in a Excel XLSX spreadsheet

Edits the input Excel XLSX spreadsheet document to rename a specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\RenameXlsxWorksheetRequest(); // \Swagger\Client\Model\RenameXlsxWorksheetRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxRenameWorksheet($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxRenameWorksheet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\RenameXlsxWorksheetRequest	Document input request

Return type

\Swagger\Client\Model\RenameXlsxWorksheetResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxSetCellByIdentifier

\Swagger\Client\Model\SetXlsxCellByIdentifierResponse editDocumentXlsxSetCellByIdentifier($input)

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\SetXlsxCellByIdentifierRequest(); // \Swagger\Client\Model\SetXlsxCellByIdentifierRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxSetCellByIdentifier($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxSetCellByIdentifier: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\SetXlsxCellByIdentifierRequest	Document input request

Return type

\Swagger\Client\Model\SetXlsxCellByIdentifierResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editDocumentXlsxSetCellByIndex

\Swagger\Client\Model\SetXlsxCellResponse editDocumentXlsxSetCellByIndex($input)

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index

Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\SetXlsxCellRequest(); // \Swagger\Client\Model\SetXlsxCellRequest | Document input request

try {
    $result = $apiInstance->editDocumentXlsxSetCellByIndex($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentXlsxSetCellByIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input	\Swagger\Client\Model\SetXlsxCellRequest	Document input request

Return type

\Swagger\Client\Model\SetXlsxCellResponse

Authorization

Apikey

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]