Skip to main content
Version: 8.1

system.report.getReportNamesAsList

This function is used in Python Scripting.

Description​

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 Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

tip

This function accepts keyword arguments.

system.report.getReportNamesAsList(project)

Parameters​

TypeParameterDescription
StringprojectThe name of the project where the reports are located. Optional in 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

Code Example​

Code 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
"""