Insert a FormField
Contents[ Hide ]
This REST API inserts a
FormField into a Word document.
Insert a FormField into a Word document REST API
nodePath(required) — the path to the node in the document tree.
You can use the following parameters in a REST request:
|Parameter Name||Data Type||Required/Optional||Description|
||string||Optional||Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.|
||string||Optional||Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.|
||string||Optional||Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.|
||string||Optional||Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.|
||string||Optional||Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.|
||string||Optional||The date and time to use for revisions.|
||string||Optional||The index of the node. A new form field will be inserted before the node with the specified node Id.|
$multipart/form-data request to combine one or more properties into a single body:
|Property Name||Data Type||Required/Optional||Description|
||FormField||Required||From field data.|
Note: to access this REST API, you need to register and get personal credentials. Use the ‘Quick Start’ guide to go through the procedure in a couple of minutes.
Insert a FormField into a Word document usage examples
How to insert a FormField into a Word document with cURL or Postman
One of the easiest and fastest ways to call a REST API is to use cURL or Postman:
Using SDK is the quickest way to speed up the development. Please take a look at the provided code examples to quickly call this web service from your favourite programming language:
- GitHub repository — explore Aspose.Words Cloud SDK Family. These software libraries take care of all low-level document-processing details.