GoogleApi.HealthCare.V1beta1.Api.Projects.healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata

You're seeing just the function healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata, go back to GoogleApi.HealthCare.V1beta1.Api.Projects module for more information.
Link to this function

healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, optional_params \\ [], opts \\ [])

View Source

Specs

healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveSeriesMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieving metadata.

Parameters

  • connection (type: GoogleApi.HealthCare.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • dicom_stores_id (type: String.t) - Part of parent. See documentation of projectsId.
  • studies_id (type: String.t) - Part of dicomWebPath. The path of the RetrieveSeriesMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/metadata.
  • series_id (type: String.t) - Part of dicomWebPath. See documentation of studiesId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}} on success
  • {:error, info} on failure