Documentation Center

write

Store an analytic report in XML format.

Description

This XML instance contains the metadata about the report, as well as a snapshot of the report content.

Parameters

action
write
xml
XML instance of a form being stored.

Example URL

http://<host>:<port>/<context>/web/analytics.xql?action=write&xml=<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 "Use analytics" permission; the function will throw a permission exception if the permission is not available.