_reports

class appian_locust._reports._Reports(interactor: appian_locust._interactor._Interactor)

Bases: appian_locust._base._Base

get_all(search_string: str = None, locust_request_label: str = 'Reports.Feed') → Dict[str, Any]

Retrieves all the available “reports” and associated metadata from “Appian-Tempo-Reports”

Note: All the retrieved data about reports is stored in the private variable self._reports

Returns (dict): List of reports and associated metadata

Examples

>>> self.appian.reports.get_all()
get_report(report_name: str, exact_match: bool = True) → Dict[str, Any]

Get the information about specific report by name.

Parameters
  • report_name (str) – Name of the report

  • exact_match (bool) – Should report name match exactly or to be partial match. Default : True

Returns (dict): Specific Report’s info

Raises: In case of report is not found in the system, it throws an “Exception”

Example

If full name of report is known,

>>> self.appian.reports.get("report_name")

If only partial name is known,

>>> self.appian.reports.get("report_name", exact_match=False)
get_reports_interface(locust_request_label: str = 'Reports.Interface') → Dict[str, Any]
get_reports_nav(locust_request_label: str = 'Reports.Nav') → Dict[str, Any]
visit(report_name: str, exact_match: bool = True) → Dict[str, Any]

This function calls the API for the specific report to get its “form” data

Parameters
  • report_name (str) – Name of the report to be called.

  • exact_match (bool, optional) – Should report name match exactly or to be partial match. Default : True

Returns (dict): Response of report’s Get UI call in dictionary

Examples

If full name of report is known,

>>> self.appian.reports.visit("report_name")

If only partial name is known,

>>> self.appian.reports.visit("report_name", exact_match=False)
visit_and_get_form(report_name: str, exact_match: bool = True)appian_locust.uiform.SailUiForm