xml
Returns a resource as unfiltered xml.
Description
This function locates the specified resource and returns it, unfiltered, in xml form.
Parameters
- action
- xml
- 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.
- filename
- filename of requested resource.
- format
- indicates the format of the XML. A value of "filtered" indicates that the XML should be filtered with any current contextual information. A value of "metadata" indicates that only the object's metadata block should be returned. A value of "topiclist" indicates that list of the topics in the named publication should be returned; with this format only the pub and lang parameters apply.
- 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&docid=<value>&scope=<value>&area=<value>&query=<value>&filename=<value>&format=<value>&type=<value>&lang=<value>&pub=<value>
Successful Result
Unfiltered 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.