system.report.getReportNamesAsList
This function is used in Python Scripting.
Description
Gets a list of all reports for a project.
Client Permission Restrictions
This scripting function has no Client Permission restrictions.
Syntax
This function accepts keyword arguments.
system.report.getReportNamesAsList ( project )
Parameters
Type | Parameter | Description |
---|---|---|
String | project | The name of the project where the reports are located. Optional in Client scope. |
Returns
List - A list of report paths for the project. Returns an empty list if the project has no reports.
Throws
IllegalArgumentException - Thrown when any of the following occurs: If the project name is omitted in the Gateway scope, project does not exist.
Scope
All
Code Examples
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
Comparisons
Line Reports/Line 1/Defect rates
Line Reports/Line 1/Production
Line Reports/Line 2/Defect Rates