Documentation Center

where_used

Lists publications that contain an object with a specified ID and version number.

Description

Given an object ID and version, return an XML structure containing the names of publications and language versions on the server that contain an object with that ID and version. An object may be a topic, map, media file or other publication resource. By default the function searches all publications and language versions. Use the optional pub and/or lang parameters to narrow the search.

Parameters

action
where_used
obj_id
The id attribute of the object.
lang
(optional) A language version of a publication.
pub
(optional) A publication, which is a logical grouping of information (topics and multimedia) related to a specific subject, containing one or more language versions.
obj_version
The version number of the object as recorded in its metadata file.

Example URL

http://<host>:<port>/<context>/web/pub.xql?action=where_used&obj_id=<value>&lang=<value>&pub=<value>&obj_version=<value>

Successful Result

A <pubs> structure containing a <pub> element for each publication/language version where found; if not found, an empty <pubs> element.

Failed Result

Accessing this API feature requires the "Use application" permission, and the function will throw a permission exception if the permission is not available.