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_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.html">dicomStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html">studies</a> . <a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html">series</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html">instances()</a></code> 79</p> 80<p class="firstline">Returns the instances Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#delete">delete(parent, dicomWebPath, x__xgafv=None)</a></code></p> 84<p class="firstline">DeleteSeries deletes all instances within the given study and series.</p> 85<p class="toc_element"> 86 <code><a href="#retrieveMetadata">retrieveMetadata(parent, dicomWebPath, x__xgafv=None)</a></code></p> 87<p class="firstline">RetrieveSeriesMetadata returns instance associated with the given study and</p> 88<p class="toc_element"> 89 <code><a href="#retrieveSeries">retrieveSeries(parent, dicomWebPath, x__xgafv=None)</a></code></p> 90<p class="firstline">RetrieveSeries returns all instances within the given study and series. See</p> 91<p class="toc_element"> 92 <code><a href="#searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</a></code></p> 93<p class="firstline">SearchForInstances returns a list of matching instances. See</p> 94<h3>Method Details</h3> 95<div class="method"> 96 <code class="details" id="delete">delete(parent, dicomWebPath, x__xgafv=None)</code> 97 <pre>DeleteSeries deletes all instances within the given study and series. 98Delete requests are equivalent to the GET requests specified in the WADO-RS 99standard. 100 101Args: 102 parent: string, The name of the DICOM store that is being accessed (e.g., 103`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 104 dicomWebPath: string, The path of the DeleteSeries request (e.g., 105`studies/{study_id}/series/{series_id}`). (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 { # A generic empty message that you can re-use to avoid defining duplicated 115 # empty messages in your APIs. A typical example is to use it as the request 116 # or the response type of an API method. For instance: 117 # 118 # service Foo { 119 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 120 # } 121 # 122 # The JSON representation for `Empty` is empty JSON object `{}`. 123 }</pre> 124</div> 125 126<div class="method"> 127 <code class="details" id="retrieveMetadata">retrieveMetadata(parent, dicomWebPath, x__xgafv=None)</code> 128 <pre>RetrieveSeriesMetadata returns instance associated with the given study and 129series, presented as metadata with the bulk data removed. See 130http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. 131 132Args: 133 parent: string, The name of the DICOM store that is being accessed (e.g., 134`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 135 dicomWebPath: string, The path of the RetrieveSeriesMetadata DICOMweb request (e.g., 136`studies/{study_id}/series/{series_id}/metadata`). (required) 137 x__xgafv: string, V1 error format. 138 Allowed values 139 1 - v1 error format 140 2 - v2 error format 141 142Returns: 143 An object of the form: 144 145 { # Message that represents an arbitrary HTTP body. It should only be used for 146 # payload formats that can't be represented as JSON, such as raw binary or 147 # an HTML page. 148 # 149 # 150 # This message can be used both in streaming and non-streaming API methods in 151 # the request as well as the response. 152 # 153 # It can be used as a top-level request field, which is convenient if one 154 # wants to extract parameters from either the URL or HTTP template into the 155 # request fields and also want access to the raw HTTP body. 156 # 157 # Example: 158 # 159 # message GetResourceRequest { 160 # // A unique request id. 161 # string request_id = 1; 162 # 163 # // The raw HTTP body is bound to this field. 164 # google.api.HttpBody http_body = 2; 165 # } 166 # 167 # service ResourceService { 168 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 169 # rpc UpdateResource(google.api.HttpBody) returns 170 # (google.protobuf.Empty); 171 # } 172 # 173 # Example with streaming methods: 174 # 175 # service CaldavService { 176 # rpc GetCalendar(stream google.api.HttpBody) 177 # returns (stream google.api.HttpBody); 178 # rpc UpdateCalendar(stream google.api.HttpBody) 179 # returns (stream google.api.HttpBody); 180 # } 181 # 182 # Use of this type only changes how the request and response bodies are 183 # handled, all other features will continue to work unchanged. 184 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 185 "data": "A String", # The HTTP request/response body as raw binary. 186 "extensions": [ # Application specific response metadata. Must be set in the first response 187 # for streaming APIs. 188 { 189 "a_key": "", # Properties of the object. Contains field @type with type URL. 190 }, 191 ], 192 }</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="retrieveSeries">retrieveSeries(parent, dicomWebPath, x__xgafv=None)</code> 197 <pre>RetrieveSeries returns all instances within the given study and series. See 198http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. 199 200Args: 201 parent: string, The name of the DICOM store that is being accessed (e.g., 202`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 203 dicomWebPath: string, The path of the RetrieveSeries DICOMweb request (e.g., 204`studies/{study_id}/series/{series_id}`). (required) 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # Message that represents an arbitrary HTTP body. It should only be used for 214 # payload formats that can't be represented as JSON, such as raw binary or 215 # an HTML page. 216 # 217 # 218 # This message can be used both in streaming and non-streaming API methods in 219 # the request as well as the response. 220 # 221 # It can be used as a top-level request field, which is convenient if one 222 # wants to extract parameters from either the URL or HTTP template into the 223 # request fields and also want access to the raw HTTP body. 224 # 225 # Example: 226 # 227 # message GetResourceRequest { 228 # // A unique request id. 229 # string request_id = 1; 230 # 231 # // The raw HTTP body is bound to this field. 232 # google.api.HttpBody http_body = 2; 233 # } 234 # 235 # service ResourceService { 236 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 237 # rpc UpdateResource(google.api.HttpBody) returns 238 # (google.protobuf.Empty); 239 # } 240 # 241 # Example with streaming methods: 242 # 243 # service CaldavService { 244 # rpc GetCalendar(stream google.api.HttpBody) 245 # returns (stream google.api.HttpBody); 246 # rpc UpdateCalendar(stream google.api.HttpBody) 247 # returns (stream google.api.HttpBody); 248 # } 249 # 250 # Use of this type only changes how the request and response bodies are 251 # handled, all other features will continue to work unchanged. 252 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 253 "data": "A String", # The HTTP request/response body as raw binary. 254 "extensions": [ # Application specific response metadata. Must be set in the first response 255 # for streaming APIs. 256 { 257 "a_key": "", # Properties of the object. Contains field @type with type URL. 258 }, 259 ], 260 }</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</code> 265 <pre>SearchForInstances returns a list of matching instances. See 266http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. 267 268Args: 269 parent: string, The name of the DICOM store that is being accessed (e.g., 270`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 271 dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request (e.g., 272`instances` or `series/{series_uid}/instances` or 273`studies/{study_uid}/instances`). (required) 274 x__xgafv: string, V1 error format. 275 Allowed values 276 1 - v1 error format 277 2 - v2 error format 278 279Returns: 280 An object of the form: 281 282 { # Message that represents an arbitrary HTTP body. It should only be used for 283 # payload formats that can't be represented as JSON, such as raw binary or 284 # an HTML page. 285 # 286 # 287 # This message can be used both in streaming and non-streaming API methods in 288 # the request as well as the response. 289 # 290 # It can be used as a top-level request field, which is convenient if one 291 # wants to extract parameters from either the URL or HTTP template into the 292 # request fields and also want access to the raw HTTP body. 293 # 294 # Example: 295 # 296 # message GetResourceRequest { 297 # // A unique request id. 298 # string request_id = 1; 299 # 300 # // The raw HTTP body is bound to this field. 301 # google.api.HttpBody http_body = 2; 302 # } 303 # 304 # service ResourceService { 305 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 306 # rpc UpdateResource(google.api.HttpBody) returns 307 # (google.protobuf.Empty); 308 # } 309 # 310 # Example with streaming methods: 311 # 312 # service CaldavService { 313 # rpc GetCalendar(stream google.api.HttpBody) 314 # returns (stream google.api.HttpBody); 315 # rpc UpdateCalendar(stream google.api.HttpBody) 316 # returns (stream google.api.HttpBody); 317 # } 318 # 319 # Use of this type only changes how the request and response bodies are 320 # handled, all other features will continue to work unchanged. 321 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 322 "data": "A String", # The HTTP request/response body as raw binary. 323 "extensions": [ # Application specific response metadata. Must be set in the first response 324 # for streaming APIs. 325 { 326 "a_key": "", # Properties of the object. Contains field @type with type URL. 327 }, 328 ], 329 }</pre> 330</div> 331 332</body></html>