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