OpenText Connector 25.4
OpenText Connector Help

# ApiFieldName

The parameters `SourceFieldName`, `ApiFieldName`, and `ApiFieldType` map elements in the XML supplied to the update action to fields in Extended ECM. These parameters accept comma-separated lists of values, and each parameter must have the same number of values. Alternatively, you can use numbered parameters each with a single value.

- `SourceFieldName` specifies the name of an element in the update XML, to use for updating a field in Extended ECM.
- `ApiFieldName` specifies the name of the field in the Extended ECM API.
- `ApiFieldType` specifies the type of the field - one of `String`, `Boolean`, `Integer`, or `JSON`.

For example, with the following configuration:

    SourceFieldName0="description"
    ApiFieldName0="description"
    ApiFieldType0="String"

...you can supply the following XML to the `IdentifiersXML` parameter of the update action:

    <IdentifiersXML>
      <identifier value="AUTN_IDENTIFIER_OF_DOCUMENT_TO_UPDATE">
        <xmlmetadata>
          <description>The new description</description>
        </xmlmetadata>
      </identifier>
    </IdentifiersXML>

The connector then updates the "description" field through the OpenText ECM API.

Type: | String (comma-separated list)
Default: | "description","description_multilingual","name","name_multilingual","versions_control_advanced","apply_to","parent_id","metadata_token"
Required: | No
Configuration Section: | TaskName or FetchTasks
Example: | `ApiFieldName="description","description_multilingual","name","name_multilingual","versions_control_advanced","apply_to","parent_id","metadata_token"`
See Also: | ApiFieldType SourceFieldName

Copyright 2025 Open Text
Version 25.4 | Last updated October 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery OpenText Connector 25.4

Topic Title: ApiFieldName