Documentation Center

indexterms

Retrieves index terms from the publication.

Description

Fetches index terms (indexterms.xml) and provides either the XML or HTML representation of the list.

Parameters

action
indexterms
term
A specific term within the top level of the index to target. Only terms and links below this top level term are returned. This parameter is only used if format is set to html.
format
The output format for the results. Either "html" or "xml". Defaults to "html"
lang
A language version of a publication.
pub
A publication, which is a logical grouping of information (topics and multimedia) related to a specific subject, containing one or more language versions.

Example URL

http://<host>:<port>/<context>/web/content.xql?action=indexterms&term=<value>&format=<value>&lang=<value>&pub=<value>

Successful Result

In default case (no @term, format=html) returns an HTML formatted list of index terms; if @term is specified, only terms which match that attribute are returned. If format=xml, the indexterms.xml file for the specified publication language version is returned.

Failed Result

404 error if  language version is not visible or if indexterms.xml is not available.

Permission exception if  user does not have 'Use application' permission.