Documentation Center

delete_pub

Delete a sitemap for a publication.

Description

Delete the sitemap file used by Web Crawlers. All document sitemaps can be deleted by passing an empty publication id.

Parameters

action
delete_pub
lang
A language version of a publication. If this parameter is empty, delete all language sitemaps within the 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. If this parameter is empty, delete all publication sitemaps.

Example URL

http://<host>:<port>/<context>/web/sitemap.xql?action=delete_pub&lang=<value>&pub=<value>

Successful Result

If successful, the requested publications are removed from the sitemap. This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure. 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.