GoogleApi.HealthCare.V1.Api.Projects.healthcare_projects_locations_datasets_dicom_stores_studies_delete

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

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

View Source

Specs

healthcare_projects_locations_datasets_dicom_stores_studies_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a study while a delete operation is running for that study could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteStudy, see Deleting a study, series, or instance.

Parameters

  • connection (type: GoogleApi.HealthCare.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent.
  • 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 DeleteStudy request. For example, studies/{study_uid}.
  • 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.V1.Model.Operation{}} on success
  • {:error, info} on failure