v1.reports

Operation: POST /dataservice/v1/reports

create a new report template

def post(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.post()

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

Update the report template by report ID

def put(
    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.put()

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

Delete the report template and all report files associated with it

def delete(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()

Operation: GET /dataservice/v1/reports

@overload
def get() -> 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()

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

@overload
def get(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()