Customer Reports¶

class icometrix_sdk.resources.customer_reports.CustomerReports(api, polling_interval=2)¶

Bases: object

download_customer_report_file(customer_report_file, out_path=None)¶

Download a file created by icobrain for a customer_report

Parameters:

customer_report_file (CustomerReportFile) – The file entity you want to download
out_path (str | None) – A path to write the file to

Returns:

download_customer_report_files(customer_report, out_path)¶

Download all files created by icobrain for a customer_report

Parameters:

customer_report (CustomerReportEntity) – The customer report you want to download the files from
out_path (str) – A folder path to write the files to

Returns:

get_all(project_id, **kwargs)¶

Get al customer reports for a project

Parameters:: project_id (str) – The ID of the project you want to fetch the customer-reports from
Returns:: A Paginated response containing customer-reports
Return type:: PaginatedResponse[CustomerReportEntity]

get_all_for_study(study_uri, **kwargs)¶

Get a single customer-report based on the customer-report uri

get_one(customer_report_uri)¶

Get a single customer-report based on the customer-report uri

Parameters:: customer_report_uri (str) – the uri of the customer-report
Returns:: A single customer-report or 404
Return type:: CustomerReportEntity

wait_for_customer_report_for_study(project_id, study_instance_uid, report_type)¶

After data has been imported a customer report will be created

Parameters:

Returns:

Return type:

CustomerReportEntity

wait_for_results(customer_reports)¶

Wait until processing has finished and the result files are available on the customer report

Parameters:: customer_reports (List[CustomerReportEntity]) – A list of customer reports
Returns:
Return type:: List[CustomerReportEntity]