Documentation Center

delete_resource

Deletes specified resource from the holding area of the language version.

Description

This is a more robust description of the API function.

Parameters

action
delete_resource
resource
Resource to remove.
type
Type of resource: doc, media or toc.
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_resource&resource=<value>&type=<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 return a 401 Unauthorized (html/401unauthorized.html) page if the permission is not available.