v1.reports

Operation: GET /dataservice/v1/reports

Get all reports information

def get_all_report_templates() -> ReportSummaryResponse: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.v1.reports.get_all_report_templates()

Operation: POST /dataservice/v1/reports

create a new report template

def create_report_template(
    payload: ExecutiveSummaryReport,
) -> ReportInfo: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.v1.reports.create_report_template()

Operation: GET /dataservice/v1/reports/{reportId}

Get the report template information by report ID

def get_report_template_by_id(
    report_id: str,
) -> ReportSummaryResponse: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.v1.reports.get_report_template_by_id()

Operation: PUT /dataservice/v1/reports/{reportId}

Update the report template by report ID

def update_report_template(
    report_id: str, payload: ExecutiveSummaryReport
) -> ReportInfo: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.v1.reports.update_report_template()

Operation: DELETE /dataservice/v1/reports/{reportId}

Delete the report template and all report files associated with it

def delete_report_template(
    report_id: str,
) -> UpdateReportTemplateResponse: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.v1.reports.delete_report_template()