Add

This REST API adds a Field.

The request parameters are:

Parameter Name Type Query String/HTTPBody Description
insertBeforeNode string Query String: insertBeforeNode=“nodeId” The field will be inserted before a node with id=“nodeId”.

Usage examples with cURL and Postman

The following URIs are used to address REST resources:

~/{file-name}/fields/{index}
~/{file-name}/{nodePath}/fields/{index}

, where:

  • {file-name} is a filename of a document.
  • {nodePath} is a path to a node in a document. If this parameter is used, elements contained within a specified node will be processed:
    • sections/{sectionIndex} - references a section.
    • paragraphs/{paragraphIndex} - references a paragraph.
    • sections/{sectionIndex}/paragraphs/{paragraphIndex} - references a paragraph within a section.
  • {index} is the index of a specific field.

Important properties are the following:

Property Name Type Description
FieldCode string Returns field code.
LocaleId int Specifies LCID of the field.
Result string Returns field result.

You can carry out REST API interactions using cURL and Postman. Please read these instructions to receive a personal JWT_TOKEN for authorization.

Aspose.Words Cloud SDK Family

Using SDK is the best way to speed up the development. Please go to the GitHub repository to explore a wide family of our Cloud SDKs. These powerful libraries take care of all low-level programming details and let you focus on your primary tasks.

Usage examples in Python, Java, C#, etc.

The following code samples show how to interact with the REST API using almost any mainstream programming language.

You can find a lot of other examples in Python, Java, C#, JavaScript, PHP, C++, Golang, Ruby, Swift, Dart on GitHub. All codes are thoroughly tested and ready for production use.