Report

class Report(report_id=None, name=None, position_source_id=None, position_source_type=None, report_type=None, parameters=None, earliest_start_date=None, latest_end_date=None, latest_execution_time=None, status=ReportStatus.new, percentage_complete=None)

General report class

Methods

__init__(report_id=None, name=None, position_source_id=None, position_source_type=None, report_type=None, parameters=None, earliest_start_date=None, latest_end_date=None, latest_execution_time=None, status=ReportStatus.new, percentage_complete=None)

delete()

Delete a report from Marquee

classmethod from_target(report)

classmethod get(report_id, acceptable_types=None)

get_most_recent_job()

Retrieve the most current report job

run(start_date=None, end_date=None, backcast=False, is_async=True)

Run a report with the given date range

Parameters:

• start_date (Optional[date]) – start date (optional)

• end_date (Optional[date]) – end date (optional)

• backcast (bool) – set to true if the report should be backcasted; defaults to false

• is_async (bool) – return immediately (true) or wait for results (false); defaults to true

save()

Create a report in Marquee if it doesn’t exist. Update the report if it does.

schedule(start_date=None, end_date=None, backcast=None)

Schedule a report with the given date range

Parameters:

• start_date (Optional[date]) – start date (optional)

• end_date (Optional[date]) – end date (optional)

• backcast (Optional[bool]) – set to true if the report should be backcasted

set_position_source(entity_id)

Set position source type and position source ID