Documentation Center

metadata

Allows the fetching of different types of document metadata.

Description

Request all the metadata from a publication language version, according to the specified 'type' (default=toc_info).

Parameters

action
metadata
docid
The document id of requested resource.
area
The area of the requested resource e.g. 'live', 'holding'.
type
Type of metadata requested (e.g. toc_info or image).
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=metadata&docid=<value>&area=<value>&type=<value>&lang=<value>&pub=<value>

Successful Result

Requested metadata, e.g. from LiveContent-DITA:toc_info() in DITA.xql. All metadata is wrapped in a DOCUMENT element.

Failed Result

Returns <lc:failedref> in DOCUMENT element, if pub language version is not visible or toc.xml is not available. In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>). Refer to API Error Code Reference.