xml_filtered

Returns a resource as filtered xml.

Description

This function locates the specified resource and returns it, filtered against DITA/filter.xsl using the filter file for this publication language version and the personalization values in effect, in xml form.

Parameters

action
xml_filtered
docid
The document id of requested resource.
scope
if query provided, scope of query to run against resource.
area
The area of the requested resource e.g. 'live', 'holding'.
query
if provided, search query to run against resource.
resource
The name of the requested resource.
filename
filename of requested resource.
type
type of resource e.g. 'doc', 'toc', 'doctoc'.
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=xml_filtered&docid=<value>&scope=<value>&area=<value>&query=<value>&resource=<value>&filename=<value>&type=<value>&lang=<value>&pub=<value>

Successful Result

Filtered xml result, or <lc:failedref> if resource does not exist.

Failed Result

404 error if  language version is not visible.

Permission exception if  user does not have 'View source XML' permission.

Permission exception if  resource is in 'holding' area and user does not have 'Manage apps' permission.