Method: series.searchForInstances

Full name: projects.locations.datasets.dicomStores.studies.series.searchForInstances

series.searchForInstances returns a list of matching instances. See RetrieveTransaction.

For details on the implementation of series.searchForInstances, see Search transaction in the Cloud Healthcare API conformance statement.

For samples that show how to call series.searchForInstances, see Search for DICOM data.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{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 SearchForInstancesRequest DICOMweb request. For example, instances, series/{series_uid}/instances, or studies/{study_uid}/instances.

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.