get_report

Service.get_report(report_name: str) → Report

Get a Report item that corresponds to a report in the database with a given name.

Parameters:

report_namestr

Name of the report in the database. The name must be for a top-level report, not a name of a subsection within a report.

Returns:

Object

Report object. If no such object can be found, None is returned.

Raises:

ConnectionToServiceError

There is no ADR service associated with the current object.

MissingReportError

The service does not have a report with the input name.

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')
my_report = adr_service.get_report(report_name = "Top Level Report')