Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

Gets a list of all reports for a project. Throws an IllegalArgumentException when any of the following occurs: If the project name is omitted in the Gateway scope , or if project does not exist.

Client permissions restrictions


Panel
titleSyntax
Info

This function accepts keyword arguments.

system.report.getReportNamesAsList(project)

  • Parameters

String project - The name of the project where the reports are located. Optional in client scope. Optional in Session Client scope and Perspective Session scope.

  • Returns

List - A list of report paths for the project. Returns an empty list if the project has no reports.

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# Gets a list of reports for the current project and prints it.
reports = system.report.getReportNamesAsList()
for report in reports:
    print report

"""Output from the above example looks like the following:
Comparisons
Line Reports/Line 1/Defect rates
Line Reports/Line 1/Production
Line Reports/Line 2/Defect Rates
"""
Panel
titleKeywords

system report getReportNamesAsList, report.getReportNamesAsList