Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource

The "studies" collection of methods.

Inheritance
System.Object
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class StudiesResource

Constructors

StudiesResource(IClientService)

Constructs a new resource.

Declaration
public StudiesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Series

Gets the Series resource.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource Series { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource

Methods

Delete(String, String)

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.DeleteRequest Delete(string parent, string dicomWebPath)
Parameters
Type Name Description
System.String parent
System.String dicomWebPath

The path of the DeleteStudy request. For example, studies/{study_uid}.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.DeleteRequest

RetrieveMetadata(String, String)

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See RetrieveTransaction.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveMetadataRequest RetrieveMetadata(string parent, string dicomWebPath)
Parameters
Type Name Description
System.String parent

The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

System.String dicomWebPath

The path of the RetrieveStudyMetadata DICOMweb request. For example, studies/{study_uid}/metadata.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveMetadataRequest

RetrieveStudy(String, String)

RetrieveStudy returns all instances within the given study. See RetrieveTransaction.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveStudyRequest RetrieveStudy(string parent, string dicomWebPath)
Parameters
Type Name Description
System.String parent

The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

System.String dicomWebPath

The path of the RetrieveStudy DICOMweb request. For example, studies/{study_uid}.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveStudyRequest

SearchForInstances(String, String)

SearchForInstances returns a list of matching instances. See Search Transaction.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForInstancesRequest SearchForInstances(string parent, string dicomWebPath)
Parameters
Type Name Description
System.String parent

The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

System.String dicomWebPath

The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/{series_uid}/instances, or studies/{study_uid}/instances.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForInstancesRequest

SearchForSeries(String, String)

SearchForSeries returns a list of matching series. See Search Transaction.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForSeriesRequest SearchForSeries(string parent, string dicomWebPath)
Parameters
Type Name Description
System.String parent

The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

System.String dicomWebPath

The path of the SearchForSeries DICOMweb request. For example, series or studies/{study_uid}/series.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForSeriesRequest

StoreInstances(HttpBody, String, String)

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.StoreInstancesRequest StoreInstances(HttpBody body, string parent, string dicomWebPath)
Parameters
Type Name Description
HttpBody body

The body of the request.

System.String parent

The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

System.String dicomWebPath

The path of the StoreInstances DICOMweb request. For example, studies/[{study_uid}]. Note that the study_uid is optional.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.StoreInstancesRequest
Back to top