Method: instances.retrieveInstance

Full name: projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance

instances.retrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See RetrieveTransaction.

For details on the implementation of instances.retrieveInstance, see DICOM study/series/instances and DICOM instances in the Cloud Healthcare API conformance statement.

For samples that show how to call instances.retrieveInstance, see Retrieve an instance.

HTTP request

GET https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the DICOM store that is being accessed. For example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/dicomStores/{dicomStoreId}.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead
dicomWebPath

string

Required. The path of the instances.retrieveInstance DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}.

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.