Documentation Center

keys

Returns a list of keys used in a publication.

Description

This function returns list of xml <onekey> elements with their metadata wrapped up in <publication> element with id and lang attributes in xml form.

Parameters

action
keys
area
The area of the requested resource e.g. 'live', 'holding'.
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=keys&area=<value>&lang=<value>&pub=<value>

Successful Result

List of xml key definitions with their metadata, or empty <lc:publication> if index does not exist.

Failed Result

404 error if language version is not visible.

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