cloudmersive_convert_api_client.TransformDocumentApi

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

Method	HTTP request	Description
transform_document_docx_replace	POST /convert/transform/docx/replace-all	Replace string in Word DOCX document, return result
transform_document_docx_replace_edit_session	POST /convert/transform/docx/replace-all/edit-session	Replace string in Word DOCX document, return edit session
transform_document_docx_table_fill_in	POST /convert/transform/docx/table/fill/data	Fill in data in a table in a Word DOCX document, return result
transform_document_docx_table_fill_in_edit_session	POST /convert/transform/docx/table/fill/data/edit-session	Fill in data in a table in a Word DOCX document, return edit session
transform_document_docx_table_fill_in_multi	POST /convert/transform/docx/table/fill/data/multi	Fill in data in multiple tables in a Word DOCX document, return result
transform_document_pptx_replace	POST /convert/transform/pptx/replace-all	Replace string in PowerPoint PPTX presentation, return result

transform_document_docx_replace

str transform_document_docx_replace(match_string, replace_string, input_file=input_file, input_file_url=input_file_url, match_case=match_case)

Replace string in Word DOCX document, return result

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

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.TransformDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
match_string = 'match_string_example' # str | String to search for and match against, to be replaced
replace_string = 'replace_string_example' # str | String to replace the matched values with
input_file = '/path/to/file.txt' # file | Optional: Input file to perform the operation on. (optional)
input_file_url = 'input_file_url_example' # str | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). (optional)
match_case = true # bool | Optional: True if the case should be matched, false for case insensitive match. Default is false. (optional)

try:
    # Replace string in Word DOCX document, return result
    api_response = api_instance.transform_document_docx_replace(match_string, replace_string, input_file=input_file, input_file_url=input_file_url, match_case=match_case)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformDocumentApi->transform_document_docx_replace: %s\n" % e)

Parameters

Name	Type	Description	Notes
match_string	str	String to search for and match against, to be replaced
replace_string	str	String to replace the matched values with
input_file	file	Optional: Input file to perform the operation on.	[optional]
input_file_url	str	Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).	[optional]
match_case	bool	Optional: True if the case should be matched, false for case insensitive match. Default is false.	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

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

transform_document_docx_replace_edit_session

DocumentTransformEditSession transform_document_docx_replace_edit_session(match_string, replace_string, input_file=input_file, input_file_url=input_file_url, match_case=match_case)

Replace string in Word DOCX document, return edit session

Replace all instances of a string 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

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.TransformDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
match_string = 'match_string_example' # str | String to search for and match against, to be replaced
replace_string = 'replace_string_example' # str | String to replace the matched values with
input_file = '/path/to/file.txt' # file | Optional: Input file to perform the operation on. (optional)
input_file_url = 'input_file_url_example' # str | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). (optional)
match_case = true # bool | Optional: True if the case should be matched, false for case insensitive match. Default is false. (optional)

try:
    # Replace string in Word DOCX document, return edit session
    api_response = api_instance.transform_document_docx_replace_edit_session(match_string, replace_string, input_file=input_file, input_file_url=input_file_url, match_case=match_case)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformDocumentApi->transform_document_docx_replace_edit_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
match_string	str	String to search for and match against, to be replaced
replace_string	str	String to replace the matched values with
input_file	file	Optional: Input file to perform the operation on.	[optional]
input_file_url	str	Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).	[optional]
match_case	bool	Optional: True if the case should be matched, false for case insensitive match. Default is false.	[optional]

Return type

DocumentTransformEditSession

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

transform_document_docx_table_fill_in

str transform_document_docx_table_fill_in(request)

Fill in data in a table in a Word DOCX document, return result

Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.TransformDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
request = cloudmersive_convert_api_client.DocxTableTableFillRequest() # DocxTableTableFillRequest | 

try:
    # Fill in data in a table in a Word DOCX document, return result
    api_response = api_instance.transform_document_docx_table_fill_in(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	DocxTableTableFillRequest

Return type

str

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]

transform_document_docx_table_fill_in_edit_session

DocumentTransformEditSession transform_document_docx_table_fill_in_edit_session(request)

Fill in data in a table in a Word DOCX document, return edit session

Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. 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

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.TransformDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
request = cloudmersive_convert_api_client.DocxTableTableFillRequest() # DocxTableTableFillRequest | 

try:
    # Fill in data in a table in a Word DOCX document, return edit session
    api_response = api_instance.transform_document_docx_table_fill_in_edit_session(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in_edit_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	DocxTableTableFillRequest

Return type

DocumentTransformEditSession

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]

transform_document_docx_table_fill_in_multi

str transform_document_docx_table_fill_in_multi(request)

Fill in data in multiple tables in a Word DOCX document, return result

Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.TransformDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
request = cloudmersive_convert_api_client.DocxTableTableFillMultiRequest() # DocxTableTableFillMultiRequest | 

try:
    # Fill in data in multiple tables in a Word DOCX document, return result
    api_response = api_instance.transform_document_docx_table_fill_in_multi(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in_multi: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	DocxTableTableFillMultiRequest

Return type

str

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]

transform_document_pptx_replace

str transform_document_pptx_replace(match_string, replace_string, input_file=input_file, input_file_url=input_file_url, match_case=match_case)

Replace string in PowerPoint PPTX presentation, return result

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

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.TransformDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
match_string = 'match_string_example' # str | String to search for and match against, to be replaced
replace_string = 'replace_string_example' # str | String to replace the matched values with
input_file = '/path/to/file.txt' # file | Optional: Input file to perform the operation on. (optional)
input_file_url = 'input_file_url_example' # str | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). (optional)
match_case = true # bool | Optional: True if the case should be matched, false for case insensitive match. Default is false. (optional)

try:
    # Replace string in PowerPoint PPTX presentation, return result
    api_response = api_instance.transform_document_pptx_replace(match_string, replace_string, input_file=input_file, input_file_url=input_file_url, match_case=match_case)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransformDocumentApi->transform_document_pptx_replace: %s\n" % e)

Parameters

Name	Type	Description	Notes
match_string	str	String to search for and match against, to be replaced
replace_string	str	String to replace the matched values with
input_file	file	Optional: Input file to perform the operation on.	[optional]
input_file_url	str	Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).	[optional]
match_case	bool	Optional: True if the case should be matched, false for case insensitive match. Default is false.	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

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

Files

TransformDocumentApi.md

Latest commit

History

TransformDocumentApi.md

File metadata and controls

cloudmersive_convert_api_client.TransformDocumentApi

transform_document_docx_replace

Example

Parameters

Return type

Authorization

HTTP request headers

transform_document_docx_replace_edit_session

Example

Parameters

Return type

Authorization

HTTP request headers

transform_document_docx_table_fill_in

Example

Parameters

Return type

Authorization

HTTP request headers

transform_document_docx_table_fill_in_edit_session

Example

Parameters

Return type

Authorization

HTTP request headers

transform_document_docx_table_fill_in_multi

Example

Parameters

Return type

Authorization

HTTP request headers

transform_document_pptx_replace

Example

Parameters

Return type

Authorization

HTTP request headers