Documentation Center

topic

Retrieves the topic object in its many formats.

Description

The requested resource (content topic) is retrieved in one of many formats, ranging from HTML to PDF.

Parameters

action
topic
docid
The document id of requested resource.
scope
The scope of the search that was used to find this document, if it was opened from a search result list.
query
The search query that was used to find this document, if opened from a search result list.
tid
The unique ID of the search result list that was used to find this document.
format
The output format for the results. Either "html", "pdf", or "fo". 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=topic&docid=<value>&scope=<value>&query=<value>&tid=<value>&format=<value>&lang=<value>&pub=<value>

Successful Result

A rendering of the requested resource (content topic) in the requested format.

Failed Result

404 error if language version is not visible or if it is not available.

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