Stay organized with collections
Save and categorize content based on your preferences.
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
GET https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/metadata}
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.retrieveMetadata DICOMweb request. For example, studies/{studyUid}/series/{seriesUid}/instances/{instanceUid}/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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003e\u003ccode\u003einstances.retrieveMetadata\u003c/code\u003e retrieves metadata for a specific DICOM instance, identified by study, series, and SOP Instance UID, with the bulk data removed.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e parameter, which is the DICOM store's name, and a \u003ccode\u003edicomWebPath\u003c/code\u003e parameter, specifying the study, series, and instance UIDs.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request method is \u003ccode\u003eGET\u003c/code\u003e, and the request body must be empty, resulting in an HTTP response that reflects the metadata.\u003c/p\u003e\n"],["\u003cp\u003eAccessing \u003ccode\u003einstances.retrieveMetadata\u003c/code\u003e requires the \u003ccode\u003ehealthcare.dicomStores.dicomWebRead\u003c/code\u003e IAM permission on the \u003ccode\u003eparent\u003c/code\u003e resource and one of the specified OAuth scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe full HTTP request is done through the provided URL which follows the gRPC Transcoding syntax.\u003c/p\u003e\n"]]],[],null,["# Method: instances.retrieveMetadata\n\n**Full name**: projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata\n\ninstances.retrieveMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).\n\nFor details on the implementation of instances.retrieveMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement.\n\nFor samples that show how to call instances.retrieveMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/metadata}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
