Open topic with navigation

# GetTagNames

Returns the names of all fields in IDOL Server that have the specified type or field code.

Fields return with their full path, which indicates their hierarchical position in IDOL Server (for example, `DOCUMENT/DRETITLE` or `World/Continent/Country/Region/Town`). IDOL Server creates this hierarchy when it indexes the documents. If you index XML files, their hierarchy is translated into the field path. If you index IDX files, the IDXFieldPrefix configuration parameter specifies a basic XML hierarchy for the IDX files.

The action returns the attribute `code="NN"`, which specifies the unique field code assigned to each field. For example:

    <responsedata>
       <autn:name code="19">XML/DOCUMENT/COUNTRY/CAPITAL</autn:name>
       <autn:name code="45">XML/DOCUMENT/COUNTRY/LANGUAGE</autn:name>
       <autn:name code="61">XML/DOCUMENT/COUNTRY/POPULATION</autn:name>
       <autn:number_of_fields>3</autn:number_of_fields>
    ...
    </responsedata>

The action also returns a summary count of how many fields of each field type exist. For example:

    <responsedata>
       <autn:name code="19">XML/DOCUMENT/COUNTRY/CAPITAL</autn:name>
    ...
       <autn:count type="index">2</autn:count>
       <autn:count type="reference">1</autn:count>
       <autn:count type="date">2</autn:count>
       <autn:count type="expire">0</autn:count>
    </responsedata>

## Example

    http://12.3.4.56:9000/action=GetTagNames&FieldType=INDEX&FieldCode=23+45

This action uses port `9000` to request a list of the field names for the Index fields that have the field codes 23 and 45 assigned to them in IDOL Server, which is located on a machine with the IP address `12.3.4.56`.

## Parameters

Parameter | Description | Required
--- | --- | ---
BaseFieldCodeOnly | Restricts the output to base field codes. |
FieldCode | The field codes of the fields to return. |
FieldType | The field types of the fields to return. |
MaxValues | The maximum number of top results to display. |
OutputEncoding | The encoding to convert the results to. |
Start | Print results from this position onwards. |
Synchronous | Whether to run the action synchronously or asynchronously. |
TypeDetails | Shows the properties associated with each field name and code. |

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close We welcome your comments! To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm