get_list_reports#

Service.get_list_reports(r_type: str | None = 'name') → list#

Get a list of top-level reports in the database.

This method can get either a list of the names of the top-level reports or a list of Report items corresponding to these reports.

Parameters:

r_typestr, optional: Type of object to return. The default is "name", which returns a list of the names of the reports. If you set the value for this parameter to "report", this method returns a list of the Report items corresponding to these reports.

Returns:

list: List of the top-level reports in the database. The list can be of the names of these reports or the Report items corresponding to these reports.

Raises:

ConnectionToServiceError: There is no ADR service associated with the current object.

Examples

import ansys.dynamicreporting.core as adr
adr_service = adr.Service(ansys_installation=r'C:\Program Files\ANSYS Inc\v232')
adr_service.connect(url='http://localhost:8020')
top_reports = adr_service.get_list_reports()