Method: instances.retrieveMetadata

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

instances.retrieveMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See RetrieveTransaction.

For details on the implementation of instances.retrieveMetadata, see Metadata resources in the Cloud Healthcare API conformance statement.

For samples that show how to call instances.retrieveMetadata, see Retrieve metadata.

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 instances.retrieveMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata.

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.