Documentation Center

delete_pub

If lang is provided, deletes that language version; otherwise, deletes all language versions of the pub.

Description

Resource must not be visible or locked by another process.

Parameters

action
delete_pub
delete_forms
A "true" or "false" flag to delete all doc-attached forms that are associated with this publication. Defaults to "true".
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/pub.xql?action=delete_pub&delete_forms=<value>&lang=<value>&pub=<value>

Successful Result

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.

Failed Result

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