reports-system-reporting

Returns system messages from the specified time period. Querying large time periods may take a significant amount of time to return and may cause the web server to timeout. Smaller time periods should be used when feasible. The SOAP name of this function is: ReportsSystemReporting

Synopsis

system-report nodeset reports-system-reporting(start, end, max-items);
dateTime start;
dateTime end;
int max-items;

Parameters

dateTime start - Starting date for the report. (Required)
dateTime end - Ending date for the report. (Required)
int max-items - Return at most this many entries from the system reporting. The newest entries will be returned if more than this many entries occur in the time period. Default value: 10000.

Return Value

system-report nodeset - An xml node containing the results of this report build.

Exceptions

reports-system-reporting - Thrown when there is an error building the report.

Authentication

Like all Watson Explorer Engine API functions with the exception of ping, the reports-system-reporting function requires authentication.

When using REST, you can simply pass v.username and v.password as CGI parameters via HTTP or HTTPS to authenticate the REST call to the reports-system-reporting function.

When using the SOAP API, you can pass credentials as parameters on an endpoint, or you can leverage the authentication method that is supported by all Watson Explorer Engine functions. Each provides a setAuthentication method that can be passed an authentication object to provide the username and password under which a function executes. An example of this in Java for a SOAP call to the reports-system-reporting function is the following:

    Authentication authentication = new Authentication();
    authentication.setUsername("joe-user");
    authentication.setPassword("joes-password");

    ReportsSystemReporting foo = new ReportsSystemReporting();
    foo.setAuthentication(authentication);

A single authentication object would typically be reused throughout each individual application.