Get

This REST API retrieves a Field.

REST API

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 an index of a field.

The important properties are described below:

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

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use cURL command-line tool to access Aspose.Words web services easily. The following example shows how to make calls to Cloud API with cURL.

Cloud SDK Family

Using an SDK is the best way to speed up the development. An SDK takes care of low-level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Words Cloud SDKs.

The following code examples demonstrate how to make calls to Aspose.Words web services using various SDKs: