# Cloud Healthcare API . projects . locations . datasets . dicomStores . studies . series

## Instance Methods

Returns the instances Resource.

DeleteSeries deletes all instances within the given study and series.

RetrieveSeriesMetadata returns instance associated with the given study and

RetrieveSeries returns all instances within the given study and series. See

SearchForInstances returns a list of matching instances. See

### Method Details

`delete(parent, dicomWebPath, x__xgafv=None)`

    DeleteSeries deletes all instances within the given study and series.
    Delete requests are equivalent to the GET requests specified in the
    Retrieve transaction.

    Args:
      parent: string, 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}`. (required)
      dicomWebPath: string, The path of the DeleteSeries request. For example,
    `studies/{study_uid}/series/{series_uid}`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated
          # empty messages in your APIs. A typical example is to use it as the request
          # or the response type of an API method. For instance:
          #
          #     service Foo {
          #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`retrieveMetadata(parent, dicomWebPath, x__xgafv=None)`

    RetrieveSeriesMetadata returns instance associated with the given study and
    series, presented as metadata with the bulk data removed. See
    [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).

    Args:
      parent: string, 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}`. (required)
      dicomWebPath: string, The path of the RetrieveSeriesMetadata DICOMweb request. For example,
    `studies/{study_uid}/series/{series_uid}/metadata`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message that represents an arbitrary HTTP body. It should only be used for
          # payload formats that can't be represented as JSON, such as raw binary or
          # an HTML page.
          #
          #
          # This message can be used both in streaming and non-streaming API methods in
          # the request as well as the response.
          #
          # It can be used as a top-level request field, which is convenient if one
          # wants to extract parameters from either the URL or HTTP template into the
          # request fields and also want access to the raw HTTP body.
          #
          # Example:
          #
          #     message GetResourceRequest {
          #       // A unique request id.
          #       string request_id = 1;
          #
          #       // The raw HTTP body is bound to this field.
          #       google.api.HttpBody http_body = 2;
          #     }
          #
          #     service ResourceService {
          #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
          #       rpc UpdateResource(google.api.HttpBody) returns
          #       (google.protobuf.Empty);
          #     }
          #
          # Example with streaming methods:
          #
          #     service CaldavService {
          #       rpc GetCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #       rpc UpdateCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #     }
          #
          # Use of this type only changes how the request and response bodies are
          # handled, all other features will continue to work unchanged.
        "data": "A String", # The HTTP request/response body as raw binary.
        "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
        "extensions": [ # Application specific response metadata. Must be set in the first response
            # for streaming APIs.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
      }

`retrieveSeries(parent, dicomWebPath, x__xgafv=None)`

    RetrieveSeries returns all instances within the given study and series. See
    [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).

    Args:
      parent: string, 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}`. (required)
      dicomWebPath: string, The path of the RetrieveSeries DICOMweb request. For example,
    `studies/{study_uid}/series/{series_uid}`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message that represents an arbitrary HTTP body. It should only be used for
          # payload formats that can't be represented as JSON, such as raw binary or
          # an HTML page.
          #
          #
          # This message can be used both in streaming and non-streaming API methods in
          # the request as well as the response.
          #
          # It can be used as a top-level request field, which is convenient if one
          # wants to extract parameters from either the URL or HTTP template into the
          # request fields and also want access to the raw HTTP body.
          #
          # Example:
          #
          #     message GetResourceRequest {
          #       // A unique request id.
          #       string request_id = 1;
          #
          #       // The raw HTTP body is bound to this field.
          #       google.api.HttpBody http_body = 2;
          #     }
          #
          #     service ResourceService {
          #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
          #       rpc UpdateResource(google.api.HttpBody) returns
          #       (google.protobuf.Empty);
          #     }
          #
          # Example with streaming methods:
          #
          #     service CaldavService {
          #       rpc GetCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #       rpc UpdateCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #     }
          #
          # Use of this type only changes how the request and response bodies are
          # handled, all other features will continue to work unchanged.
        "data": "A String", # The HTTP request/response body as raw binary.
        "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
        "extensions": [ # Application specific response metadata. Must be set in the first response
            # for streaming APIs.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
      }

`searchForInstances(parent, dicomWebPath, x__xgafv=None)`

    SearchForInstances returns a list of matching instances. See
    [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).

    Args:
      parent: string, 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}`. (required)
      dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request. For example,
    `instances`, `series/{series_uid}/instances`, or
    `studies/{study_uid}/instances`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message that represents an arbitrary HTTP body. It should only be used for
          # payload formats that can't be represented as JSON, such as raw binary or
          # an HTML page.
          #
          #
          # This message can be used both in streaming and non-streaming API methods in
          # the request as well as the response.
          #
          # It can be used as a top-level request field, which is convenient if one
          # wants to extract parameters from either the URL or HTTP template into the
          # request fields and also want access to the raw HTTP body.
          #
          # Example:
          #
          #     message GetResourceRequest {
          #       // A unique request id.
          #       string request_id = 1;
          #
          #       // The raw HTTP body is bound to this field.
          #       google.api.HttpBody http_body = 2;
          #     }
          #
          #     service ResourceService {
          #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
          #       rpc UpdateResource(google.api.HttpBody) returns
          #       (google.protobuf.Empty);
          #     }
          #
          # Example with streaming methods:
          #
          #     service CaldavService {
          #       rpc GetCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #       rpc UpdateCalendar(stream google.api.HttpBody)
          #         returns (stream google.api.HttpBody);
          #     }
          #
          # Use of this type only changes how the request and response bodies are
          # handled, all other features will continue to work unchanged.
        "data": "A String", # The HTTP request/response body as raw binary.
        "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
        "extensions": [ # Application specific response metadata. Must be set in the first response
            # for streaming APIs.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
      }