Click or drag to resize

ExplorerOperationsGetReports Method

Retrieves list of reports.

Namespace:  Cobra.WebService.ClientAPI.Application.Explorer
Assembly:  Cobra.WebService.ClientAPI (in Cobra.WebService.ClientAPI.dll) Version: 8.4.717.3176 (8.4.0717.3176)
Syntax
C#
Copy
public ReportCollection GetReports(
	ReportsFilter reportsFilter
)

Parameters

reportsFilter
Type: Cobra.Model.WebServiceReportsFilter
An instance of ReportsFilter class containing the filters applied to the list of reports.

Return Value

Type: ReportCollection
An instance of ReportCollection class containing the list of reports.
Exceptions
ExceptionCondition
InvalidOperationExceptionThrown when state of the instance of the CobraServices that generated the current ExplorerOperations is not in opened state.
Examples
This example shows how to retrieve list of configurations.
C#
Copy
using Cobra.Model.WebService;
using Cobra.WebService.ClientAPI.Application.Explorer;
using Cobra.WebService.ClientAPI.Client;

.
.
.

CobraServices cobraServices = new CobraServices();
cobraServices.ServiceIdentityData.Username = "SYSADMIN";
cobraServices.ServiceIdentityData.SecurePassword = new SecurePassword();
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('P');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('A');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('S');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('S');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('W');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('O');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('R');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('D');
cobraServices.ServiceIdentityData.DataSourceKey = "COBRA";

LoginResult loginResult = cobraServices.Login();
if (!loginResult.Success) {
    Console.WriteLine("Login failed.");
    return;
}

Console.WriteLine("Login Success.");

ExplorerOperations explorerOperations = cobraServices.CreateServiceOperations<ExplorerOperations>();
ReportsFilter reportsFilter = explorerOperations.CreateExplorerOperationsServiceArguments<ReportsFilter>();

Console.WriteLine("Retrieving list of reports...");
ReportCollection reports = explorerOperations.GetReports(reportsFilter);

bool hasError = false;
foreach (ServiceMessage serviceMessage in reports.GetMessages()) {
    Console.WriteLine("Message Type: {0}", serviceMessage.MessageType);
    Console.WriteLine("Message: {0}", serviceMessage.Message);

    if (serviceMessage.MessageType == MessageType.Error || serviceMessage.MessageType == MessageType.ValidationError) {
        hasError = true;
    }
}

if (!hasError) {
    foreach (Configuration report in reports) {
        Console.WriteLine("Name: {0}", report.Name);
        Console.WriteLine("Description: {0}", report.Description);
    }

    Console.WriteLine("Retrieving list of reports completed successfully.");
}
else
    Console.WriteLine("Retrieving list of reports did not completed successfully.");

cobraServices.Logout();
See Also