Documentation Center

save_index

Creates or modifies a search category.

Description

You must execute a re-index after creating or modifying a search cateogry

Parameters

action
save_index
standards
A comma delimited list of the standards to which this search category should apply. At this time, this parameter is not used by the application.
name
The name of the search category.
attr
If the search category searches an attribute specifically, the attribute should be provided as @class.
xpath
The XPath that the search category should use to execute its search. All XPaths must start with / or //

Example URL

http://<host>:<port>/<context>/web/search.xql?action=save_index&standards=<value>&name=<value>&attr=<value>&xpath=<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.