getStudyMetrics method

Future<StudyMetrics> getStudyMetrics(
  1. String study, {
  2. String? $fields,
})

GetStudyMetrics returns metrics for a study.

Request parameters:

study - Required. The study resource path. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+/dicomStores/\[^/\]+/dicomWeb/studies/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a StudyMetrics.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<StudyMetrics> getStudyMetrics(
  core.String study, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$study') + ':getStudyMetrics';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return StudyMetrics.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}