Documentation Center

view

A list of the documents available as a site map.

Description

Web crawlers need a description of documents that are not normally described as HTML files. This function returns the list of valid documents.

Parameters

action
view

Example URL

http://<host>:<port>/<context>/web/sitemap.xql?action=view

Successful Result

If successful, return a sitemap XML instance describing the publications within the Content Delivery application. The XML adheres to the sitemap spec. (see www.sitemap.org). 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.

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.