• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.html">studies()</a></code>
79</p>
80<p class="firstline">Returns the studies Resource.</p>
81
82<p class="toc_element">
83  <code><a href="#searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</a></code></p>
84<p class="firstline">SearchForInstances returns a list of matching instances. See</p>
85<p class="toc_element">
86  <code><a href="#searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</a></code></p>
87<p class="firstline">SearchForSeries returns a list of matching series. See</p>
88<p class="toc_element">
89  <code><a href="#searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</a></code></p>
90<p class="firstline">SearchForStudies returns a list of matching studies. See</p>
91<p class="toc_element">
92  <code><a href="#storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</a></code></p>
93<p class="firstline">StoreInstances stores DICOM instances associated with study instance unique</p>
94<h3>Method Details</h3>
95<div class="method">
96    <code class="details" id="searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</code>
97  <pre>SearchForInstances returns a list of matching instances. See
98http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
99
100Args:
101  parent: string, The name of the DICOM store that is being accessed (e.g.,
102`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
103  dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request (e.g.,
104`instances` or `series/{series_uid}/instances` or
105`studies/{study_uid}/instances`). (required)
106  x__xgafv: string, V1 error format.
107    Allowed values
108      1 - v1 error format
109      2 - v2 error format
110
111Returns:
112  An object of the form:
113
114    { # Message that represents an arbitrary HTTP body. It should only be used for
115      # payload formats that can't be represented as JSON, such as raw binary or
116      # an HTML page.
117      #
118      #
119      # This message can be used both in streaming and non-streaming API methods in
120      # the request as well as the response.
121      #
122      # It can be used as a top-level request field, which is convenient if one
123      # wants to extract parameters from either the URL or HTTP template into the
124      # request fields and also want access to the raw HTTP body.
125      #
126      # Example:
127      #
128      #     message GetResourceRequest {
129      #       // A unique request id.
130      #       string request_id = 1;
131      #
132      #       // The raw HTTP body is bound to this field.
133      #       google.api.HttpBody http_body = 2;
134      #     }
135      #
136      #     service ResourceService {
137      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
138      #       rpc UpdateResource(google.api.HttpBody) returns
139      #       (google.protobuf.Empty);
140      #     }
141      #
142      # Example with streaming methods:
143      #
144      #     service CaldavService {
145      #       rpc GetCalendar(stream google.api.HttpBody)
146      #         returns (stream google.api.HttpBody);
147      #       rpc UpdateCalendar(stream google.api.HttpBody)
148      #         returns (stream google.api.HttpBody);
149      #     }
150      #
151      # Use of this type only changes how the request and response bodies are
152      # handled, all other features will continue to work unchanged.
153    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
154    "data": "A String", # The HTTP request/response body as raw binary.
155    "extensions": [ # Application specific response metadata. Must be set in the first response
156        # for streaming APIs.
157      {
158        "a_key": "", # Properties of the object. Contains field @type with type URL.
159      },
160    ],
161  }</pre>
162</div>
163
164<div class="method">
165    <code class="details" id="searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</code>
166  <pre>SearchForSeries returns a list of matching series. See
167http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
168
169Args:
170  parent: string, The name of the DICOM store that is being accessed (e.g.,
171`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
172  dicomWebPath: string, The path of the SearchForSeries DICOMweb request(e.g., `series` or
173`studies/{study_uid}/series`). (required)
174  x__xgafv: string, V1 error format.
175    Allowed values
176      1 - v1 error format
177      2 - v2 error format
178
179Returns:
180  An object of the form:
181
182    { # Message that represents an arbitrary HTTP body. It should only be used for
183      # payload formats that can't be represented as JSON, such as raw binary or
184      # an HTML page.
185      #
186      #
187      # This message can be used both in streaming and non-streaming API methods in
188      # the request as well as the response.
189      #
190      # It can be used as a top-level request field, which is convenient if one
191      # wants to extract parameters from either the URL or HTTP template into the
192      # request fields and also want access to the raw HTTP body.
193      #
194      # Example:
195      #
196      #     message GetResourceRequest {
197      #       // A unique request id.
198      #       string request_id = 1;
199      #
200      #       // The raw HTTP body is bound to this field.
201      #       google.api.HttpBody http_body = 2;
202      #     }
203      #
204      #     service ResourceService {
205      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
206      #       rpc UpdateResource(google.api.HttpBody) returns
207      #       (google.protobuf.Empty);
208      #     }
209      #
210      # Example with streaming methods:
211      #
212      #     service CaldavService {
213      #       rpc GetCalendar(stream google.api.HttpBody)
214      #         returns (stream google.api.HttpBody);
215      #       rpc UpdateCalendar(stream google.api.HttpBody)
216      #         returns (stream google.api.HttpBody);
217      #     }
218      #
219      # Use of this type only changes how the request and response bodies are
220      # handled, all other features will continue to work unchanged.
221    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
222    "data": "A String", # The HTTP request/response body as raw binary.
223    "extensions": [ # Application specific response metadata. Must be set in the first response
224        # for streaming APIs.
225      {
226        "a_key": "", # Properties of the object. Contains field @type with type URL.
227      },
228    ],
229  }</pre>
230</div>
231
232<div class="method">
233    <code class="details" id="searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</code>
234  <pre>SearchForStudies returns a list of matching studies. See
235http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
236
237Args:
238  parent: string, The name of the DICOM store that is being accessed (e.g.,
239`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
240  dicomWebPath: string, The path of the SearchForStudies DICOMweb request (e.g., `studies`). (required)
241  x__xgafv: string, V1 error format.
242    Allowed values
243      1 - v1 error format
244      2 - v2 error format
245
246Returns:
247  An object of the form:
248
249    { # Message that represents an arbitrary HTTP body. It should only be used for
250      # payload formats that can't be represented as JSON, such as raw binary or
251      # an HTML page.
252      #
253      #
254      # This message can be used both in streaming and non-streaming API methods in
255      # the request as well as the response.
256      #
257      # It can be used as a top-level request field, which is convenient if one
258      # wants to extract parameters from either the URL or HTTP template into the
259      # request fields and also want access to the raw HTTP body.
260      #
261      # Example:
262      #
263      #     message GetResourceRequest {
264      #       // A unique request id.
265      #       string request_id = 1;
266      #
267      #       // The raw HTTP body is bound to this field.
268      #       google.api.HttpBody http_body = 2;
269      #     }
270      #
271      #     service ResourceService {
272      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
273      #       rpc UpdateResource(google.api.HttpBody) returns
274      #       (google.protobuf.Empty);
275      #     }
276      #
277      # Example with streaming methods:
278      #
279      #     service CaldavService {
280      #       rpc GetCalendar(stream google.api.HttpBody)
281      #         returns (stream google.api.HttpBody);
282      #       rpc UpdateCalendar(stream google.api.HttpBody)
283      #         returns (stream google.api.HttpBody);
284      #     }
285      #
286      # Use of this type only changes how the request and response bodies are
287      # handled, all other features will continue to work unchanged.
288    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
289    "data": "A String", # The HTTP request/response body as raw binary.
290    "extensions": [ # Application specific response metadata. Must be set in the first response
291        # for streaming APIs.
292      {
293        "a_key": "", # Properties of the object. Contains field @type with type URL.
294      },
295    ],
296  }</pre>
297</div>
298
299<div class="method">
300    <code class="details" id="storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</code>
301  <pre>StoreInstances stores DICOM instances associated with study instance unique
302identifiers (SUID). See
303http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
304
305Args:
306  parent: string, The name of the DICOM store that is being accessed (e.g.,
307`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
308  dicomWebPath: string, The path of the StoreInstances DICOMweb request (e.g.,
309`studies/[{study_id}]`). Note that the `study_uid` is optional. (required)
310  body: object, The request body. (required)
311    The object takes the form of:
312
313{ # Message that represents an arbitrary HTTP body. It should only be used for
314    # payload formats that can't be represented as JSON, such as raw binary or
315    # an HTML page.
316    #
317    #
318    # This message can be used both in streaming and non-streaming API methods in
319    # the request as well as the response.
320    #
321    # It can be used as a top-level request field, which is convenient if one
322    # wants to extract parameters from either the URL or HTTP template into the
323    # request fields and also want access to the raw HTTP body.
324    #
325    # Example:
326    #
327    #     message GetResourceRequest {
328    #       // A unique request id.
329    #       string request_id = 1;
330    #
331    #       // The raw HTTP body is bound to this field.
332    #       google.api.HttpBody http_body = 2;
333    #     }
334    #
335    #     service ResourceService {
336    #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
337    #       rpc UpdateResource(google.api.HttpBody) returns
338    #       (google.protobuf.Empty);
339    #     }
340    #
341    # Example with streaming methods:
342    #
343    #     service CaldavService {
344    #       rpc GetCalendar(stream google.api.HttpBody)
345    #         returns (stream google.api.HttpBody);
346    #       rpc UpdateCalendar(stream google.api.HttpBody)
347    #         returns (stream google.api.HttpBody);
348    #     }
349    #
350    # Use of this type only changes how the request and response bodies are
351    # handled, all other features will continue to work unchanged.
352  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
353  "data": "A String", # The HTTP request/response body as raw binary.
354  "extensions": [ # Application specific response metadata. Must be set in the first response
355      # for streaming APIs.
356    {
357      "a_key": "", # Properties of the object. Contains field @type with type URL.
358    },
359  ],
360}
361
362  x__xgafv: string, V1 error format.
363    Allowed values
364      1 - v1 error format
365      2 - v2 error format
366
367Returns:
368  An object of the form:
369
370    { # Message that represents an arbitrary HTTP body. It should only be used for
371      # payload formats that can't be represented as JSON, such as raw binary or
372      # an HTML page.
373      #
374      #
375      # This message can be used both in streaming and non-streaming API methods in
376      # the request as well as the response.
377      #
378      # It can be used as a top-level request field, which is convenient if one
379      # wants to extract parameters from either the URL or HTTP template into the
380      # request fields and also want access to the raw HTTP body.
381      #
382      # Example:
383      #
384      #     message GetResourceRequest {
385      #       // A unique request id.
386      #       string request_id = 1;
387      #
388      #       // The raw HTTP body is bound to this field.
389      #       google.api.HttpBody http_body = 2;
390      #     }
391      #
392      #     service ResourceService {
393      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
394      #       rpc UpdateResource(google.api.HttpBody) returns
395      #       (google.protobuf.Empty);
396      #     }
397      #
398      # Example with streaming methods:
399      #
400      #     service CaldavService {
401      #       rpc GetCalendar(stream google.api.HttpBody)
402      #         returns (stream google.api.HttpBody);
403      #       rpc UpdateCalendar(stream google.api.HttpBody)
404      #         returns (stream google.api.HttpBody);
405      #     }
406      #
407      # Use of this type only changes how the request and response bodies are
408      # handled, all other features will continue to work unchanged.
409    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
410    "data": "A String", # The HTTP request/response body as raw binary.
411    "extensions": [ # Application specific response metadata. Must be set in the first response
412        # for streaming APIs.
413      {
414        "a_key": "", # Properties of the object. Contains field @type with type URL.
415      },
416    ],
417  }</pre>
418</div>
419
420</body></html>