Method: frames.retrieveFrames

Full name: projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames

frames.retrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See RetrieveTransaction.

For details on the implementation of frames.retrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement.

For samples that show how to call frames.retrieveFrames, see Retrieve DICOM data.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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


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

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:


For more information, see the Authentication Overview.