File: healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (420 lines) | stat: -rw-r--r-- 15,646 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.html">studies()</a></code>
</p>
<p class="firstline">Returns the studies Resource.</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="#searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</a></code></p>
<p class="firstline">SearchForStudies returns a list of matching studies. 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="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="searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</code>
  <pre>SearchForStudies returns a list of matching studies. 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 SearchForStudies DICOMweb request (e.g., `studies`). (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>