Documentation Center

delete_index

Deletes a search category by name.

Description

After the search category has been deleted, your users immediately be unable to continue to use this category. However, this category's index will continue to be updated in your Lucene index until you complete a re-index.

Parameters

action
delete_index
name
The name of the search category.

Example URL

http://<host>:<port>/<context>/web/search.xql?action=delete_index&name=<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 application" permission, and the function will throw a permission exception if the permission is not available.