xf_aggregate
Manually initiates a forms aggregation event on the server. This will push appropriately aged forms to the aggregation server, based on the server's global configuration settings. This is usually initiated by a scheduled job.
Parameters
- action
- xf_aggregate
Example URL
http://<host>:<port>/<context>/web/audit.xql?action=xf_aggregate
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.