You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
525 lines
20 KiB
525 lines
20 KiB
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="healthcare_v1alpha2.html">Cloud Healthcare API</a> . <a href="healthcare_v1alpha2.projects.html">projects</a> . <a href="healthcare_v1alpha2.projects.locations.html">locations</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.html">dicomStores</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.html">dicomWeb</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.html">studies</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series.html">series()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the series Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(parent, dicomWebPath, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">DeleteStudy deletes all instances within the given study. Delete requests</p>
|
|
<p class="toc_element">
|
|
<code><a href="#metadata">metadata(parent, dicomWebPath, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">RetrieveStudyMetadata returns instance associated with the given study</p>
|
|
<p class="toc_element">
|
|
<code><a href="#retrieveStudy">retrieveStudy(parent, dicomWebPath, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">RetrieveStudy returns all instances within the given study. See</p>
|
|
<p class="toc_element">
|
|
<code><a href="#searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">SearchForInstances returns a list of matching instances. See</p>
|
|
<p class="toc_element">
|
|
<code><a href="#searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">SearchForSeries returns a list of matching series. See</p>
|
|
<p class="toc_element">
|
|
<code><a href="#storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">StoreInstances stores DICOM instances associated with study instance unique</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(parent, dicomWebPath, x__xgafv=None)</code>
|
|
<pre>DeleteStudy deletes all instances within the given study. Delete requests
|
|
are equivalent to the GET requests specified in the WADO-RS standard.
|
|
|
|
Args:
|
|
parent: string, The name of the DICOM store that is being accessed (e.g.,
|
|
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
|
|
dicomWebPath: string, The path of the DeleteStudy request (e.g., `studies/{study_id}`). (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 `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="metadata">metadata(parent, dicomWebPath, x__xgafv=None)</code>
|
|
<pre>RetrieveStudyMetadata returns instance associated with the given study
|
|
presented as metadata with the bulk data removed. See
|
|
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 (e.g.,
|
|
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
|
|
dicomWebPath: string, The path of the RetrieveStudyMetadata DICOMweb request (e.g.,
|
|
`studies/{study_id}/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.
|
|
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
|
|
"data": "A String", # The HTTP request/response body as raw binary.
|
|
"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.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="retrieveStudy">retrieveStudy(parent, dicomWebPath, x__xgafv=None)</code>
|
|
<pre>RetrieveStudy returns all instances within the given study. See
|
|
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 (e.g.,
|
|
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
|
|
dicomWebPath: string, The path of the RetrieveStudy DICOMweb request (e.g.,
|
|
`studies/{study_id}`). (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.
|
|
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
|
|
"data": "A String", # The HTTP request/response body as raw binary.
|
|
"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.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</code>
|
|
<pre>SearchForInstances returns a list of matching instances. See
|
|
http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
|
|
Args:
|
|
parent: string, The name of the DICOM store that is being accessed (e.g.,
|
|
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
|
|
dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request (e.g.,
|
|
`instances` or `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.
|
|
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
|
|
"data": "A String", # The HTTP request/response body as raw binary.
|
|
"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.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</code>
|
|
<pre>SearchForSeries returns a list of matching series. See
|
|
http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
|
|
Args:
|
|
parent: string, The name of the DICOM store that is being accessed (e.g.,
|
|
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
|
|
dicomWebPath: string, The path of the SearchForSeries DICOMweb request(e.g., `series` or
|
|
`studies/{study_uid}/series`). (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.
|
|
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
|
|
"data": "A String", # The HTTP request/response body as raw binary.
|
|
"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.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</code>
|
|
<pre>StoreInstances stores DICOM instances associated with study instance unique
|
|
identifiers (SUID). See
|
|
http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
|
|
|
|
Args:
|
|
parent: string, The name of the DICOM store that is being accessed (e.g.,
|
|
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
|
|
dicomWebPath: string, The path of the StoreInstances DICOMweb request (e.g.,
|
|
`studies/[{study_id}]`). Note that the `study_uid` is optional. (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # 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.
|
|
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
|
|
"data": "A String", # The HTTP request/response body as raw binary.
|
|
"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.
|
|
},
|
|
],
|
|
}
|
|
|
|
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.
|
|
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
|
|
"data": "A String", # The HTTP request/response body as raw binary.
|
|
"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.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |