Get All Report Configurations

API Type

Web Services

Description

Retrieves all report configurations from the system.

Note: The Report Center component (sometimes referred to as AgileReports) can only be used by customers who purchased this component before April 1, 2020. This version is no longer available for purchase, including by current and previous purchasers of AgilePoint NX or the Report Center component. In AgilePoint NX v8.0 and higher, Report Center has been replaced with the Analytics Center component.

Syntax

public virtual WFReportConfigure[] GetAllReportConfigure()

Parameters

NameDescription
NoneNot Applicable

Output

WFReportConfigure object.

Example

IWFAdminService svc = GetAdminService();

try
	{
    WFReportConfigure[] reportConfigs = svc.GetAllReportConfigure();
    Console.WriteLine("This AgilePoint Server has {0} reports
    configured:", reportConfigs.Length);
    foreach (WFReportConfigure config in reportConfigs)
	   {
       Console.WriteLine("Report Name: {0}", config.ReportName);
	   }
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}
/*
This example produces the following results:
This AgilePoint Server has 1 reports configured:
Report Name:Average Process Time By Automatic Activities
*/

Supported Versions

3.2.0.4 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.