Mercurial > hg > orthanc-book

annotate OpenAPI/orthanc-openapi.json @ 577:7d27154e70f9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cheatsheet and full openapi
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 30 Dec 2020 07:55:12 +0100
parents
children 4ca0061637ac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
577
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 "info" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 "description" : "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ))",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 "title" : "Orthanc API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 "version" : "1.8.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 "openapi" : "3.0.0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 "paths" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 "/changes" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 "description" : "Clear the full history stored in the changes log",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 "summary" : "Clear changes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 "tags" : [ "Tracking changes" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 "description" : "Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called _Changes Log_. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 "description" : "Limit the number of results",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 "name" : "limit",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 "description" : "Show only the resources since the provided index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 "name" : "since",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 "description" : "The list of changes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 "Changes" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 "ChangeType" : "NewInstance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 "Date" : "20180414T091510",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 "ID" : "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 "Path" : "/instances/055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 "ResourceType" : "Instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 "Seq" : 1
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 "ChangeType" : "NewSeries",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 "Date" : "20180414T091510",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 "ID" : "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 "Path" : "/series/318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 "ResourceType" : "Series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 "Seq" : 2
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 "Done" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 "Last" : 2
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 "Changes" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 "description" : "The individual changes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 "Done" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 "description" : "Whether the last reported change is the last of the full history",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 "Last" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 "description" : "The index of the last reported change, can be used for the `since` argument in subsequent calls to this route",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 "summary" : "List changes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 "tags" : [ "Tracking changes" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 "/exports" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 "description" : "Clear the full history stored in the exports log",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 "summary" : "Clear exports",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 "tags" : [ "Tracking changes" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 "description" : "For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting the option `LogExportedResources` to `false` in the configuration file, or periodically clear this log by `DELETE`-ing this URI. This route might be removed in future versions of Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 "description" : "Limit the number of results",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 "name" : "limit",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 "description" : "Show only the resources since the provided index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 "name" : "since",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 "description" : "The list of exports"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149 "summary" : "List exports",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 "tags" : [ "Tracking changes" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153 "/instances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156 "description" : "List the Orthanc identifiers of all the available DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 "description" : "If present, retrieve detailed information about the individual instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
165 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
168 "description" : "Limit the number of results",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
169 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
170 "name" : "limit",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
171 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
172 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
173 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
174 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
175 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
176 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177 "description" : "Show only the resources since the provided index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
179 "name" : "since",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
181 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
182 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
183 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
184 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
188 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
189 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
190 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
191 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
196 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
197 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
198 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202 "summary" : "List the available instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
203 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
204 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
205 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
206 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
207 "description" : "Upload DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
208 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
209 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
210 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
211 "application/dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
212 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
213 "description" : "DICOM file to be uploaded"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
214 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
215 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
216 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
217 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
218 "description" : "ZIP archive containing DICOM files (new in Orthanc 1.8.2)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
219 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
220 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
221 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
222 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
223 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
224 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
225 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
226 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
227 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
228 "description" : "Information about the uploaded instance, or list of information for each uploaded instance in the case of ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
229 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
230 "ID" : "19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
231 "ParentPatient" : "ef9d77db-eb3b2bef-9b31fd3e-bf42ae46-dbdb0cc3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
232 "ParentSeries" : "3774320f-ccda46d8-69ee8641-9e791cbf-3ecbbcc6",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
233 "ParentStudy" : "66c8e41e-ac3a9029-0b85e42a-8195ee0a-92c2e62e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
234 "Path" : "/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
235 "Status" : "Success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
236 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
237 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
238 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
239 "description" : "Orthanc identifier of the new instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
240 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
241 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
242 "ParentPatient" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
243 "description" : "Orthanc identifier of the parent patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
244 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
245 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
246 "ParentSeries" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
247 "description" : "Orthanc identifier of the parent series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
248 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
249 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
250 "ParentStudy" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
251 "description" : "Orthanc identifier of the parent study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
252 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
253 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
254 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
255 "description" : "Path to the new instance in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
256 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
257 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
258 "Status" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
259 "description" : "Can be `Success`, `AlreadyStored`, `Failure`, or `FilteredOut` (removed by some `NewInstanceFilter`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
260 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
261 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
262 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
263 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
264 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
265 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
266 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
267 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
268 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
269 "summary" : "Upload DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
270 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
271 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
272 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
273 "/instances/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
274 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
275 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
276 "description" : "Delete the DICOM instance whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
277 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
278 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
279 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
280 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
281 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
282 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
283 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
284 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
285 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
286 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
287 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
288 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
289 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
290 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
291 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
292 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
293 "summary" : "Delete some instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
294 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
295 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
296 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
297 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
298 "description" : "Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
299 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
300 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
301 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
302 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
303 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
304 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
305 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
306 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
307 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
308 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
309 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
310 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
311 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
312 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
313 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
314 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
315 "description" : "Information about the DICOM instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
316 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
317 "FileSize" : 526744,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
318 "FileUuid" : "dc031d9e-ef02-4871-821f-ffe445deb7c2",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
319 "ID" : "d94d9a03-3003b047-a4affc69-322313b2-680530a2",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
320 "IndexInSeries" : 155,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
321 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
322 "AcquisitionNumber" : "4",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
323 "ImageOrientationPatient" : "1\\0\\0\\0\\1\\0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
324 "ImagePositionPatient" : "-249.51171875\\-458.51171875\\314",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
325 "InstanceCreationDate" : "20151217",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
326 "InstanceCreationTime" : "125204.215000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
327 "InstanceNumber" : "155",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
328 "SOPInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.168997935789297163075628247666"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
329 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
330 "ParentSeries" : "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
331 "Type" : "Instance"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
332 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
333 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
334 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
335 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
336 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
337 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
338 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
339 "summary" : "Get information about some instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
340 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
341 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
342 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
343 "/instances/{id}/anonymize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
344 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
345 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
346 "description" : "Download an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#anonymization-of-a-single-instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
347 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
348 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
349 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
350 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
351 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
352 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
353 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
354 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
355 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
356 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
357 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
358 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
359 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
360 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
361 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
362 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
363 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
364 "DicomVersion" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
365 "description" : "Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
366 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
367 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
368 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
369 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
370 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
371 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
372 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
373 "description" : "List of DICOM tags whose value must not be destroyed by the anonymization",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
374 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
375 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
376 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
377 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
378 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
379 "KeepPrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
380 "description" : "Keep the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
381 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
382 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
383 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
384 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
385 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
386 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
387 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
388 "description" : "List of additional tags to be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
389 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
390 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
391 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
392 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
393 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
394 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
395 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
396 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
397 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
398 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
399 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
400 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
401 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
402 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
403 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
404 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
405 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
406 "application/dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
407 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
408 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
409 "description" : "The anonymized DICOM instance"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
410 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
411 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
412 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
413 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
414 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
415 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
416 "summary" : "Anonymize instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
417 "tags" : [ "Instance" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
418 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
419 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
420 "/instances/{id}/attachments" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
421 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
422 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
423 "description" : "Get the list of attachments that are associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
424 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
425 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
426 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
427 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
428 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
429 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
430 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
431 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
432 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
433 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
434 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
435 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
436 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
437 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
438 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
439 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
440 "description" : "JSON array containing the names of the attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
441 "example" : [ "dicom", "dicom-as-json" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
442 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
443 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
444 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
445 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
446 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
447 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
448 "summary" : "List attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
449 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
450 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
451 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
452 "/instances/{id}/attachments/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
453 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
454 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
455 "description" : "Delete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
456 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
457 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
458 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
459 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
460 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
461 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
462 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
463 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
464 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
465 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
466 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
467 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
468 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
469 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
470 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
471 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
472 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
473 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
474 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
475 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
476 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
477 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
478 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
479 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
480 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
481 "summary" : "Delete attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
482 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
483 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
484 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
485 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
486 "description" : "Get the list of the operations that are available for attachments associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
487 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
488 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
489 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
490 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
491 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
492 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
493 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
494 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
495 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
496 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
497 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
498 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
499 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
500 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
501 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
502 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
503 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
504 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
505 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
506 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
507 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
508 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
509 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
510 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
511 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
512 "description" : "List of the available operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
513 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
514 "compress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
515 "compressed-data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
516 "compressed-md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
517 "compressed-size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
518 "data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
519 "is-compressed",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
520 "md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
521 "size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
522 "uncompress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
523 "verify-md5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
524 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
525 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
526 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
527 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
528 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
529 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
530 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
531 "summary" : "List operations on attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
532 "tags" : [ "Other" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
533 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
534 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
535 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
536 "description" : "Attach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
537 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
538 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
539 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
540 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
541 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
542 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
543 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
544 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
545 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
546 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
547 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
548 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
549 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
550 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
551 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
552 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
553 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
554 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
555 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
556 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
557 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
558 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
559 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
560 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
561 "description" : "Binary data containing the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
562 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
563 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
564 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
565 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
566 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
567 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
568 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
569 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
570 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
571 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
572 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
573 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
574 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
575 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
576 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
577 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
578 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
579 "summary" : "Set attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
580 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
581 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
582 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
583 "/instances/{id}/attachments/{name}/compress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
584 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
585 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
586 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
587 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
588 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
589 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
590 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
591 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
592 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
593 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
594 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
595 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
596 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
597 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
598 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
599 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
600 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
601 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
602 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
603 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
604 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
605 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
606 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
607 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
608 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
609 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
610 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
611 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
612 "summary" : "Compress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
613 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
614 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
615 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
616 "/instances/{id}/attachments/{name}/compressed-data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
617 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
618 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
619 "description" : "Get the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
620 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
621 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
622 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
623 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
624 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
625 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
626 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
627 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
628 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
629 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
630 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
631 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
632 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
633 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
634 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
635 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
636 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
637 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
638 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
639 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
640 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
641 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
642 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
643 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
644 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
645 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
646 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
647 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
648 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
649 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
650 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
651 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
652 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
653 "summary" : "Get attachment (no decompression)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
654 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
655 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
656 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
657 "/instances/{id}/attachments/{name}/compressed-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
658 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
659 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
660 "description" : "Get the MD5 hash of one attachment associated with the given instance, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
661 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
662 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
663 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
664 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
665 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
666 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
667 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
668 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
669 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
670 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
671 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
672 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
673 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
674 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
675 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
676 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
677 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
678 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
679 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
680 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
681 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
682 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
683 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
684 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
685 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
686 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
687 "description" : "The MD5 of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
688 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
689 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
690 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
691 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
692 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
693 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
694 "summary" : "Get MD5 of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
695 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
696 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
697 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
698 "/instances/{id}/attachments/{name}/compressed-size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
699 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
700 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
701 "description" : "Get the size of one attachment associated with the given instance, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
702 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
703 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
704 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
705 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
706 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
707 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
708 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
709 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
710 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
711 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
712 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
713 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
714 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
715 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
716 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
717 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
718 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
719 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
720 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
721 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
722 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
723 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
724 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
725 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
726 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
727 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
728 "description" : "The size of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
729 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
730 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
731 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
732 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
733 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
734 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
735 "summary" : "Get size of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
736 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
737 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
738 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
739 "/instances/{id}/attachments/{name}/data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
740 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
741 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
742 "description" : "Get the (binary) content of one attachment associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
743 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
744 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
745 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
746 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
747 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
748 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
749 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
750 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
751 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
752 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
753 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
754 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
755 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
756 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
757 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
758 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
759 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
760 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
761 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
762 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
763 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
764 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
765 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
766 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
767 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
768 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
769 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
770 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
771 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
772 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
773 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
774 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
775 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
776 "summary" : "Get attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
777 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
778 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
779 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
780 "/instances/{id}/attachments/{name}/is-compressed" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
781 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
782 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
783 "description" : "Test whether the attachment has been stored as a compressed file on the disk.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
784 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
785 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
786 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
787 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
788 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
789 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
790 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
791 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
792 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
793 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
794 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
795 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
796 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
797 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
798 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
799 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
800 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
801 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
802 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
803 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
804 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
805 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
806 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
807 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
808 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
809 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
810 "description" : "`0` if the attachment was stored uncompressed, `1` if it was compressed"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
811 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
812 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
813 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
814 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
815 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
816 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
817 "summary" : "Is attachment compressed?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
818 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
819 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
820 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
821 "/instances/{id}/attachments/{name}/md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
822 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
823 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
824 "description" : "Get the MD5 hash of one attachment associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
825 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
826 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
827 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
828 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
829 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
830 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
831 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
832 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
833 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
834 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
835 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
836 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
837 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
838 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
839 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
840 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
841 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
842 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
843 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
844 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
845 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
846 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
847 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
848 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
849 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
850 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
851 "description" : "The MD5 of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
852 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
853 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
854 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
855 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
856 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
857 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
858 "summary" : "Get MD5 of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
859 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
860 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
861 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
862 "/instances/{id}/attachments/{name}/size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
863 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
864 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
865 "description" : "Get the size of one attachment associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
866 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
867 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
868 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
869 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
870 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
871 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
872 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
873 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
874 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
875 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
876 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
877 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
878 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
879 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
880 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
881 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
882 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
883 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
884 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
885 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
886 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
887 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
888 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
889 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
890 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
891 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
892 "description" : "The size of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
893 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
894 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
895 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
896 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
897 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
898 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
899 "summary" : "Get size of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
900 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
901 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
902 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
903 "/instances/{id}/attachments/{name}/uncompress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
904 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
905 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
906 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
907 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
908 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
909 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
910 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
911 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
912 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
913 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
914 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
915 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
916 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
917 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
918 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
919 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
920 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
921 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
922 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
923 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
924 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
925 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
926 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
927 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
928 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
929 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
930 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
931 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
932 "summary" : "Uncompress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
933 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
934 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
935 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
936 "/instances/{id}/attachments/{name}/verify-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
937 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
938 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
939 "description" : "Verify that the attachment is not corrupted, by validating its MD5 hash",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
940 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
941 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
942 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
943 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
944 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
945 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
946 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
947 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
948 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
949 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
950 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
951 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
952 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
953 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
954 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
955 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
956 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
957 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
958 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
959 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
960 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
961 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
962 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
963 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
964 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
965 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
966 "description" : "On success, a valid JSON object is returned"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
967 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
968 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
969 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
970 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
971 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
972 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
973 "summary" : "Verify attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
974 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
975 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
976 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
977 "/instances/{id}/content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
978 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
979 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
980 "description" : "Get the raw content of one DICOM tag in the hierarchy of DICOM dataset",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
981 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
982 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
983 "description" : "Path to the DICOM tag. This is the interleaving of one DICOM tag, possibly followed by an index for sequences. Sequences are accessible as, for instance, `/0008-1140/1/0008-1150`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
984 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
985 "name" : "...",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
986 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
987 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
988 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
989 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
990 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
991 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
992 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
993 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
994 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
995 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
996 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
997 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
998 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
999 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1000 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1001 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1002 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1003 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1004 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1005 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1006 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1007 "description" : "The raw value of the tag of intereset (binary data, whose memory layout depends on the underlying transfer syntax), or JSON array containing the list of available tags if accessing a dataset"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1008 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1009 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1010 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1011 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1012 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1013 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1014 "summary" : "Get raw tag",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1015 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1016 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1017 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1018 "/instances/{id}/export" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1019 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1020 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1021 "description" : "Write the DICOM file onto the filesystem where Orthanc is running",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1022 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1023 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1024 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1025 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1026 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1027 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1028 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1029 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1030 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1031 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1032 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1033 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1034 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1035 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1036 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1037 "description" : "Target path on the filesystem"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1038 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1039 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1040 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1041 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1042 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1043 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1044 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1045 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1046 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1047 "summary" : "Write DICOM onto filesystem",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1048 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1049 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1050 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1051 "/instances/{id}/file" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1052 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1053 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1054 "description" : "Download one DICOM instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1055 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1056 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1057 "description" : "This HTTP header can be set to retrieve the DICOM instance in DICOMweb format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1058 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1059 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1060 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1061 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1062 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1063 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1064 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1065 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1066 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1067 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1068 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1069 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1070 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1071 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1072 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1073 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1074 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1075 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1076 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1077 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1078 "application/dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1079 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1080 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1081 "description" : "The DICOM instance"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1082 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1083 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1084 "application/dicom+json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1085 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1086 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1087 "description" : "The DICOM instance, in DICOMweb JSON format"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1088 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1089 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1090 "application/dicom+xml" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1091 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1092 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1093 "description" : "The DICOM instance, in DICOMweb XML format"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1094 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1095 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1096 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1097 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1098 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1099 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1100 "summary" : "Download DICOM",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1101 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1102 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1103 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1104 "/instances/{id}/frames" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1105 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1106 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1107 "description" : "List the frames that are available in the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1108 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1109 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1110 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1111 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1112 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1113 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1114 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1115 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1116 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1117 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1118 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1119 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1120 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1121 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1122 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1123 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1124 "description" : "The list of the indices of the available frames",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1125 "example" : [ 0 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1126 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1127 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1128 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1129 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1130 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1131 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1132 "summary" : "List available frames",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1133 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1134 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1135 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1136 "/instances/{id}/frames/{frame}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1137 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1138 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1139 "description" : "List the available operations under URI `/instances/{id}/frames/{frame}/`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1140 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1141 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1142 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1143 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1144 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1145 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1146 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1147 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1148 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1149 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1150 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1151 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1152 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1153 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1154 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1155 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1156 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1157 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1158 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1159 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1160 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1161 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1162 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1163 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1164 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1165 "description" : "List of the available operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1166 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1167 "image-int16",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1168 "image-uint16",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1169 "image-uint8",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1170 "matlab",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1171 "preview",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1172 "raw",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1173 "raw.gz",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1174 "rendered"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1175 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1176 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1177 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1178 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1179 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1180 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1181 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1182 "summary" : "List operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1183 "tags" : [ "Other" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1184 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1185 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1186 "/instances/{id}/frames/{frame}/image-int16" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1187 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1188 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1189 "description" : "Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1190 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1191 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1192 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1193 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1194 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1195 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1196 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1197 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1198 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1199 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1200 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1201 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1202 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1203 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1204 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1205 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1206 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1207 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1208 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1209 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1210 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1211 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1212 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1213 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1214 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1215 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1216 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1217 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1218 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1219 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1220 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1221 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1222 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1223 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1224 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1225 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1226 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1227 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1228 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1229 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1230 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1231 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1232 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1233 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1234 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1235 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1236 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1237 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1238 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1239 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1240 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1241 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1242 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1243 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1244 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1245 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1246 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1247 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1248 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1249 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1250 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1251 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1252 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1253 "summary" : "Decode a frame (int16)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1254 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1255 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1256 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1257 "/instances/{id}/frames/{frame}/image-uint16" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1258 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1259 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1260 "description" : "Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1261 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1262 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1263 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1264 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1265 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1266 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1267 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1268 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1269 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1270 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1271 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1272 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1273 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1274 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1275 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1276 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1277 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1278 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1279 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1280 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1281 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1282 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1283 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1284 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1285 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1286 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1287 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1288 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1289 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1290 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1291 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1292 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1293 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1294 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1295 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1296 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1297 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1298 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1299 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1300 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1301 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1302 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1303 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1304 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1305 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1306 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1307 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1308 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1309 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1310 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1311 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1312 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1313 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1314 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1315 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1316 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1317 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1318 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1319 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1320 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1321 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1322 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1323 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1324 "summary" : "Decode a frame (uint16)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1325 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1326 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1327 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1328 "/instances/{id}/frames/{frame}/image-uint8" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1329 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1330 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1331 "description" : "Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1332 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1333 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1334 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1335 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1336 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1337 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1338 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1339 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1340 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1341 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1342 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1343 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1344 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1345 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1346 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1347 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1348 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1349 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1350 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1351 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1352 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1353 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1354 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1355 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1356 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1357 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1358 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1359 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1360 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1361 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1362 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1363 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1364 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1365 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1366 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1367 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1368 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1369 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1370 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1371 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1372 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1373 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1374 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1375 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1376 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1377 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1378 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1379 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1380 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1381 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1382 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1383 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1384 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1385 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1386 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1387 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1388 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1389 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1390 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1391 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1392 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1393 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1394 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1395 "summary" : "Decode a frame (uint8)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1396 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1397 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1398 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1399 "/instances/{id}/frames/{frame}/matlab" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1400 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1401 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1402 "description" : "Decode one frame of interest from the given DICOM instance, and export this frame as a Octave/Matlab matrix to be imported with `eval()`: https://book.orthanc-server.com/faq/matlab.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1403 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1404 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1405 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1406 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1407 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1408 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1409 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1410 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1411 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1412 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1413 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1414 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1415 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1416 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1417 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1418 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1419 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1420 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1421 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1422 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1423 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1424 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1425 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1426 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1427 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1428 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1429 "description" : "Octave/Matlab matrix"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1430 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1431 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1432 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1433 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1434 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1435 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1436 "summary" : "Decode frame for Matlab",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1437 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1438 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1439 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1440 "/instances/{id}/frames/{frame}/preview" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1441 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1442 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1443 "description" : "Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1444 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1445 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1446 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1447 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1448 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1449 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1450 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1451 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1452 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1453 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1454 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1455 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1456 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1457 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1458 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1459 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1460 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1461 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1462 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1463 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1464 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1465 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1466 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1467 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1468 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1469 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1470 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1471 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1472 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1473 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1474 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1475 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1476 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1477 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1478 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1479 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1480 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1481 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1482 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1483 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1484 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1485 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1486 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1487 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1488 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1489 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1490 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1491 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1492 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1493 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1494 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1495 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1496 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1497 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1498 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1499 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1500 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1501 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1502 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1503 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1504 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1505 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1506 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1507 "summary" : "Decode a frame (preview)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1508 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1509 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1510 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1511 "/instances/{id}/frames/{frame}/raw" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1512 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1513 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1514 "description" : "Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1515 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1516 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1517 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1518 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1519 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1520 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1521 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1522 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1523 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1524 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1525 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1526 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1527 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1528 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1529 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1530 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1531 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1532 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1533 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1534 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1535 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1536 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1537 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1538 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1539 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1540 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1541 "description" : "The raw frame"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1542 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1543 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1544 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1545 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1546 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1547 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1548 "summary" : "Access raw frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1549 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1550 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1551 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1552 "/instances/{id}/frames/{frame}/raw.gz" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1553 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1554 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1555 "description" : "Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. The image is compressed using gzip",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1556 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1557 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1558 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1559 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1560 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1561 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1562 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1563 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1564 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1565 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1566 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1567 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1568 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1569 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1570 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1571 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1572 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1573 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1574 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1575 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1576 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1577 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1578 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1579 "application/gzip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1580 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1581 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1582 "description" : "The raw frame, compressed using gzip"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1583 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1584 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1585 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1586 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1587 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1588 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1589 "summary" : "Access raw frame (compressed)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1590 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1591 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1592 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1593 "/instances/{id}/frames/{frame}/rendered" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1594 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1595 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1596 "description" : "Render one frame of interest from the given DICOM instance. This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), and can be used to resize the resulting image. Color images are not affected by windowing.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1597 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1598 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1599 "description" : "Height of the resized image",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1600 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1601 "name" : "height",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1602 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1603 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1604 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1605 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1606 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1607 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1608 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1609 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1610 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1611 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1612 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1613 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1614 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1615 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1616 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1617 "description" : "Whether to smooth image on resize",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1618 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1619 "name" : "smooth",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1620 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1621 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1622 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1623 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1624 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1625 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1626 "description" : "Width of the resized image",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1627 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1628 "name" : "width",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1629 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1630 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1631 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1632 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1633 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1634 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1635 "description" : "Windowing center",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1636 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1637 "name" : "window-center",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1638 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1639 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1640 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1641 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1642 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1643 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1644 "description" : "Windowing width",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1645 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1646 "name" : "window-width",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1647 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1648 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1649 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1650 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1651 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1652 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1653 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1654 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1655 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1656 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1657 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1658 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1659 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1660 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1661 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1662 "description" : "Index of the frame (starts at `0`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1663 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1664 "name" : "frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1665 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1666 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1667 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1668 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1669 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1670 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1671 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1672 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1673 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1674 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1675 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1676 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1677 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1678 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1679 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1680 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1681 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1682 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1683 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1684 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1685 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1686 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1687 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1688 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1689 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1690 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1691 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1692 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1693 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1694 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1695 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1696 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1697 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1698 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1699 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1700 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1701 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1702 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1703 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1704 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1705 "summary" : "Render a frame",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1706 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1707 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1708 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1709 "/instances/{id}/header" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1710 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1711 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1712 "description" : "Get the DICOM tags in the meta-header of the DICOM instance. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1713 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1714 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1715 "description" : "If present, report the DICOM tags indexed in hexadecimal format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1716 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1717 "name" : "short",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1718 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1719 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1720 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1721 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1722 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1723 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1724 "description" : "If present, report the DICOM tags in human-readable format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1725 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1726 "name" : "simplify",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1727 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1728 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1729 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1730 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1731 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1732 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1733 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1734 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1735 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1736 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1737 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1738 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1739 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1740 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1741 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1742 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1743 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1744 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1745 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1746 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1747 "description" : "JSON object containing the DICOM tags and their associated value",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1748 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1749 "0002,0000" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1750 "Name" : "FileMetaInformationGroupLength",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1751 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1752 "Value" : "202"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1753 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1754 "0002,0002" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1755 "Name" : "MediaStorageSOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1756 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1757 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1758 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1759 "0002,0003" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1760 "Name" : "MediaStorageSOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1761 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1762 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006100507010800000005269"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1763 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1764 "0002,0010" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1765 "Name" : "TransferSyntaxUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1766 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1767 "Value" : "1.2.840.10008.1.2.1"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1768 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1769 "0002,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1770 "Name" : "ImplementationClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1771 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1772 "Value" : "1.3.6.1.4.1.19291.2.1"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1773 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1774 "0002,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1775 "Name" : "ImplementationVersionName",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1776 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1777 "Value" : "OSIRIX001"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1778 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1779 "0002,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1780 "Name" : "SourceApplicationEntityTitle",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1781 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1782 "Value" : "OSIRIX"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1783 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1784 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1785 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1786 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1787 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1788 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1789 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1790 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1791 "summary" : "Get DICOM meta-header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1792 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1793 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1794 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1795 "/instances/{id}/image-int16" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1796 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1797 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1798 "description" : "Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1799 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1800 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1801 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1802 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1803 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1804 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1805 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1806 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1807 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1808 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1809 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1810 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1811 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1812 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1813 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1814 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1815 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1816 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1817 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1818 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1819 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1820 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1821 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1822 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1823 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1824 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1825 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1826 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1827 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1828 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1829 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1830 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1831 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1832 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1833 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1834 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1835 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1836 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1837 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1838 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1839 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1840 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1841 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1842 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1843 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1844 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1845 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1846 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1847 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1848 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1849 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1850 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1851 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1852 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1853 "summary" : "Decode an image (int16)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1854 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1855 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1856 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1857 "/instances/{id}/image-uint16" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1858 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1859 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1860 "description" : "Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1861 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1862 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1863 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1864 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1865 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1866 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1867 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1868 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1869 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1870 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1871 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1872 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1873 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1874 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1875 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1876 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1877 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1878 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1879 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1880 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1881 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1882 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1883 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1884 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1885 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1886 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1887 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1888 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1889 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1890 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1891 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1892 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1893 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1894 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1895 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1896 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1897 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1898 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1899 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1900 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1901 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1902 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1903 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1904 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1905 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1906 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1907 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1908 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1909 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1910 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1911 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1912 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1913 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1914 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1915 "summary" : "Decode an image (uint16)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1916 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1917 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1918 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1919 "/instances/{id}/image-uint8" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1920 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1921 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1922 "description" : "Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1923 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1924 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1925 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1926 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1927 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1928 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1929 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1930 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1931 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1932 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1933 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1934 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1935 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1936 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1937 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1938 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1939 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1940 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1941 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1942 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1943 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1944 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1945 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1946 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1947 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1948 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1949 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1950 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1951 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1952 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1953 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1954 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1955 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1956 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1957 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1958 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1959 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1960 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1961 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1962 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1963 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1964 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1965 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1966 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1967 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1968 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1969 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1970 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1971 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1972 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1973 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1974 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1975 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1976 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1977 "summary" : "Decode an image (uint8)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1978 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1979 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1980 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1981 "/instances/{id}/matlab" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1982 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1983 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1984 "description" : "Decode the first frame of the given DICOM instance., and export this frame as a Octave/Matlab matrix to be imported with `eval()`: https://book.orthanc-server.com/faq/matlab.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1985 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1986 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1987 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1988 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1989 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1990 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1991 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1992 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1993 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1994 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1995 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1996 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1997 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1998 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1999 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2000 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2001 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2002 "description" : "Octave/Matlab matrix"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2003 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2004 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2005 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2006 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2007 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2008 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2009 "summary" : "Decode frame for Matlab",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2010 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2011 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2012 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2013 "/instances/{id}/metadata" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2014 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2015 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2016 "description" : "Get the list of metadata that are associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2017 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2018 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2019 "description" : "If present, also retrieve the value of the individual metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2020 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2021 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2022 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2023 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2024 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2025 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2026 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2027 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2028 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2029 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2030 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2031 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2032 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2033 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2034 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2035 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2036 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2037 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2038 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2039 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2040 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2041 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2042 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2043 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2044 "IndexInSeries",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2045 "ReceptionDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2046 "RemoteAET",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2047 "Origin",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2048 "TransferSyntax",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2049 "SopClassUid",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2050 "RemoteIP",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2051 "HttpUsername"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2052 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2053 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2054 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2055 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2056 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2057 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2058 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2059 "summary" : "List metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2060 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2061 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2062 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2063 "/instances/{id}/metadata/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2064 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2065 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2066 "description" : "Delete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2067 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2068 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2069 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2070 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2071 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2072 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2073 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2074 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2075 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2076 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2077 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2078 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2079 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2080 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2081 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2082 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2083 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2084 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2085 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2086 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2087 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2088 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2089 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2090 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2091 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2092 "summary" : "Delete metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2093 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2094 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2095 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2096 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2097 "description" : "Get the value of a metadata that is associated with the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2098 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2099 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2100 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2101 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2102 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2103 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2104 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2105 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2106 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2107 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2108 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2109 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2110 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2111 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2112 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2113 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2114 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2115 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2116 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2117 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2118 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2119 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2120 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2121 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2122 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2123 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2124 "description" : "Value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2125 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2126 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2127 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2128 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2129 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2130 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2131 "summary" : "Get metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2132 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2133 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2134 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2135 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2136 "description" : "Set the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2137 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2138 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2139 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2140 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2141 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2142 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2143 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2144 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2145 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2146 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2147 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2148 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2149 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2150 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2151 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2152 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2153 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2154 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2155 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2156 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2157 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2158 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2159 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2160 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2161 "description" : "String value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2162 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2163 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2164 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2165 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2166 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2167 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2168 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2169 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2170 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2171 "summary" : "Set metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2172 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2173 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2174 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2175 "/instances/{id}/modify" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2176 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2177 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2178 "description" : "Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#modification-of-a-single-instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2179 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2180 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2181 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2182 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2183 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2184 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2185 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2186 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2187 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2188 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2189 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2190 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2191 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2192 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2193 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2194 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2195 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2196 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2197 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2198 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2199 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2200 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2201 "description" : "Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2202 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2203 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2204 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2205 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2206 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2207 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2208 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2209 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2210 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2211 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2212 "description" : "List of tags that must be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2213 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2214 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2215 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2216 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2217 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2218 "RemovePrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2219 "description" : "Remove the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2220 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2221 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2222 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2223 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2224 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2225 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2226 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2227 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2228 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2229 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2230 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2231 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2232 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2233 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2234 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2235 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2236 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2237 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2238 "application/dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2239 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2240 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2241 "description" : "The modified DICOM instance"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2242 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2243 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2244 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2245 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2246 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2247 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2248 "summary" : "Modify instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2249 "tags" : [ "Instance" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2250 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2251 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2252 "/instances/{id}/module" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2253 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2254 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2255 "description" : "Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2256 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2257 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2258 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2259 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2260 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2261 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2262 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2263 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2264 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2265 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2266 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2267 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2268 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2269 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2270 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2271 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2272 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2273 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2274 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2275 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2276 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2277 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2278 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2279 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2280 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2281 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2282 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2283 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2284 "description" : "Information about the DICOM instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2285 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2286 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2287 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2288 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2289 "Value" : "ISO_IR 192"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2290 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2291 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2292 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2293 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2294 "Value" : "20151217"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2295 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2296 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2297 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2298 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2299 "Value" : "125204.215000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2300 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2301 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2302 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2303 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2304 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2305 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2306 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2307 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2308 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2309 "Value" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.168997935789297163075628247666"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2310 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2311 "0020,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2312 "Name" : "InstanceNumber",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2313 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2314 "Value" : "155"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2315 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2316 "0028,0303" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2317 "Name" : "LongitudinalTemporalInformationModified",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2318 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2319 "Value" : "MODIFIED"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2320 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2321 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2322 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2323 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2324 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2325 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2326 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2327 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2328 "summary" : "Get instance module",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2329 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2330 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2331 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2332 "/instances/{id}/patient" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2333 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2334 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2335 "description" : "Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2336 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2337 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2338 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2339 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2340 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2341 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2342 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2343 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2344 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2345 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2346 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2347 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2348 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2349 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2350 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2351 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2352 "description" : "Information about the parent DICOM patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2353 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2354 "ID" : "65ce8003-696b2eb6-03adeee7-6561ce8e-3e03f13a",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2355 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2356 "LastUpdate" : "20200803T131236",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2357 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2358 "PatientBirthDate" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2359 "PatientID" : "HN_P001",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2360 "PatientName" : "HN_P001",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2361 "PatientSex" : "M"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2362 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2363 "Studies" : [ "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b" ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2364 "Type" : "Patient"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2365 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2366 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2367 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2368 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2369 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2370 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2371 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2372 "summary" : "Get parent patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2373 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2374 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2375 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2376 "/instances/{id}/pdf" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2377 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2378 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2379 "description" : "Get the PDF file that is embedded in one DICOM instance. If the DICOM instance doesn't contain the `EncapsulatedDocument` tag or if the `MIMETypeOfEncapsulatedDocument` tag doesn't correspond to the PDF type, a `404` HTTP error is raised.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2380 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2381 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2382 "description" : "Orthanc identifier of the instance interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2383 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2384 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2385 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2386 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2387 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2388 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2389 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2390 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2391 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2392 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2393 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2394 "application/pdf" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2395 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2396 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2397 "description" : "PDF file"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2398 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2399 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2400 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2401 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2402 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2403 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2404 "summary" : "Get embedded PDF",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2405 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2406 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2407 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2408 "/instances/{id}/preview" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2409 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2410 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2411 "description" : "Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2412 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2413 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2414 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2415 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2416 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2417 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2418 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2419 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2420 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2421 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2422 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2423 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2424 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2425 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2426 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2427 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2428 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2429 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2430 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2431 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2432 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2433 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2434 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2435 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2436 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2437 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2438 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2439 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2440 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2441 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2442 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2443 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2444 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2445 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2446 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2447 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2448 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2449 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2450 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2451 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2452 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2453 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2454 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2455 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2456 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2457 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2458 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2459 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2460 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2461 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2462 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2463 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2464 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2465 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2466 "summary" : "Decode an image (preview)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2467 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2468 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2469 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2470 "/instances/{id}/reconstruct" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2471 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2472 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2473 "description" : "Reconstruct the main DICOM tags of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2474 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2475 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2476 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2477 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2478 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2479 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2480 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2481 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2482 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2483 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2484 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2485 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2486 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2487 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2488 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2489 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2490 "summary" : "Reconstruct tags of instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2491 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2492 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2493 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2494 "/instances/{id}/rendered" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2495 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2496 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2497 "description" : "Render the first frame of the given DICOM instance. This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), and can be used to resize the resulting image. Color images are not affected by windowing.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2498 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2499 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2500 "description" : "Height of the resized image",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2501 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2502 "name" : "height",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2503 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2504 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2505 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2506 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2507 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2508 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2509 "description" : "Quality for JPEG images (between 1 and 100, defaults to 90)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2510 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2511 "name" : "quality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2512 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2513 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2514 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2515 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2516 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2517 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2518 "description" : "Whether to smooth image on resize",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2519 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2520 "name" : "smooth",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2521 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2522 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2523 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2524 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2525 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2526 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2527 "description" : "Width of the resized image",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2528 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2529 "name" : "width",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2530 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2531 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2532 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2533 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2534 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2535 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2536 "description" : "Windowing center",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2537 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2538 "name" : "window-center",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2539 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2540 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2541 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2542 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2543 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2544 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2545 "description" : "Windowing width",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2546 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2547 "name" : "window-width",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2548 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2549 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2550 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2551 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2552 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2553 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2554 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2555 "in" : "header",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2556 "name" : "Accept",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2557 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2558 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2559 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2560 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2561 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2562 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2563 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2564 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2565 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2566 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2567 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2568 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2569 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2570 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2571 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2572 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2573 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2574 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2575 "image/jpeg" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2576 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2577 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2578 "description" : "JPEG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2579 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2580 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2581 "image/png" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2582 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2583 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2584 "description" : "PNG image"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2585 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2586 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2587 "image/x-portable-arbitrarymap" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2588 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2589 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2590 "description" : "PAM image (Portable Arbitrary Map)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2591 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2592 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2593 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2594 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2595 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2596 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2597 "summary" : "Render an image",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2598 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2599 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2600 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2601 "/instances/{id}/series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2602 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2603 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2604 "description" : "Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2605 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2606 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2607 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2608 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2609 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2610 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2611 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2612 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2613 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2614 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2615 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2616 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2617 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2618 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2619 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2620 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2621 "description" : "Information about the parent DICOM series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2622 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2623 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2624 "ID" : "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2625 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2626 "ccc7cee2-81566098-5531d590-57b3c148-1787d177",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2627 "af464afa-bf0c7970-02a3c666-337a8df8-1d955e27",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2628 "42616941-88cbd2a7-f30ceecb-3f53b658-c641372c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2629 "1470f579-11b80cb9-ecf22279-041175d9-d8f3c3ef",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2630 "373622cf-43a0259b-ebf55c2a-02e5ef32-1a3115f0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2631 "72b68848-9729ad79-e8762db4-50d97dd3-f3591322",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2632 "73e2f25f-aa47b7ba-5d1c6e7b-91b98261-a195316e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2633 "c22831de-6ddaa06c-1f877da5-400a8f03-83668321",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2634 "0c322d30-98af6f31-0bd59c19-99e07f68-317aeb3b",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2635 "dd69d888-f3065dac-a47c947c-1aed47c8-fc181d11",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2636 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2637 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2638 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2639 "LastUpdate" : "20200803T131236",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2640 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2641 "BodyPartExamined" : "CHEST",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2642 "ImageOrientationPatient" : "1\\0\\0\\0\\1\\0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2643 "Manufacturer" : "SIEMENS",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2644 "Modality" : "CT",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2645 "SeriesDate" : "20091022",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2646 "SeriesDescription" : "HEAD/NECK 2.0 B30s",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2647 "SeriesInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.215111709746721743805035350686",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2648 "SeriesNumber" : "4",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2649 "SeriesTime" : "173151.203000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2650 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2651 "ParentStudy" : "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2652 "Status" : "Unknown",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2653 "Type" : "Series"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2654 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2655 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2656 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2657 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2658 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2659 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2660 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2661 "summary" : "Get parent series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2662 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2663 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2664 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2665 "/instances/{id}/simplified-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2666 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2667 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2668 "description" : "Get the DICOM tags in human-readable format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2669 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2670 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2671 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2672 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2673 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2674 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2675 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2676 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2677 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2678 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2679 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2680 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2681 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2682 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2683 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2684 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2685 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2686 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2687 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2688 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2689 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2690 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2691 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2692 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2693 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2694 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2695 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2696 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2697 "description" : "JSON object containing the DICOM tags and their associated value",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2698 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2699 "AccessionNumber" : "0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2700 "AcquisitionDate" : "20061005",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2701 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2702 "AcquisitionTime" : "101812.967223",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2703 "BitsAllocated" : "16",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2704 "BitsStored" : "12",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2705 "BodyPartExamined" : "EXTREMITY",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2706 "Columns" : "512",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2707 "ContentDate" : "20061005",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2708 "ContentTime" : "101812.967223",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2709 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2710 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2711 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2712 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2713 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2714 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2715 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2716 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2717 "summary" : "Get human-readable tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2718 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2719 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2720 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2721 "/instances/{id}/statistics" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2722 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2723 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2724 "description" : "Get statistics about the given instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2725 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2726 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2727 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2728 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2729 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2730 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2731 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2732 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2733 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2734 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2735 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2736 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2737 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2738 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2739 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2740 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2741 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2742 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2743 "DicomDiskSize" : "526744",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2744 "DicomDiskSizeMB" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2745 "DicomUncompressedSize" : "526744",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2746 "DicomUncompressedSizeMB" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2747 "DiskSize" : "539420",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2748 "DiskSizeMB" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2749 "UncompressedSize" : "539420",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2750 "UncompressedSizeMB" : 0
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2751 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2752 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2753 "DicomDiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2754 "description" : "Size on the disk of the DICOM instances associated with the instance, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2755 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2756 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2757 "DicomDiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2758 "description" : "Size on the disk of the DICOM instances associated with the instance, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2759 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2760 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2761 "DicomUncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2762 "description" : "Size on the disk of the uncompressed DICOM instances associated with the instance, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2763 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2764 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2765 "DicomUncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2766 "description" : "Size on the disk of the uncompressed DICOM instances associated with the instance, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2767 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2768 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2769 "DiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2770 "description" : "Size of the instance on the disk in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2771 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2772 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2773 "DiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2774 "description" : "Size of the instance on the disk, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2775 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2776 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2777 "UncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2778 "description" : "Size of the instance after decompression in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2779 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2780 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2781 "UncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2782 "description" : "Size of the instance after decompression, expressed in megabytes (MB). This is different from `DiskSizeMB` iff `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2783 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2784 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2785 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2786 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2787 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2788 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2789 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2790 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2791 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2792 "summary" : "Get instance statistics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2793 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2794 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2795 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2796 "/instances/{id}/study" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2797 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2798 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2799 "description" : "Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2800 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2801 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2802 "description" : "Orthanc identifier of the instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2803 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2804 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2805 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2806 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2807 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2808 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2809 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2810 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2811 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2812 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2813 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2814 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2815 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2816 "description" : "Information about the parent DICOM study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2817 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2818 "ID" : "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2819 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2820 "LastUpdate" : "20200803T131236",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2821 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2822 "AccessionNumber" : "2819497684894126",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2823 "ReferringPhysicianName" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2824 "StudyDate" : "20091022",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2825 "StudyDescription" : "RT^HEAD_NECK (Adult)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2826 "StudyID" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2827 "StudyInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.847236098565581057121195872945",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2828 "StudyTime" : "172721.327000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2829 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2830 "ParentPatient" : "65ce8003-696b2eb6-03adeee7-6561ce8e-3e03f13a",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2831 "PatientMainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2832 "PatientBirthDate" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2833 "PatientID" : "HN_P001",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2834 "PatientName" : "HN_P001",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2835 "PatientSex" : "M"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2836 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2837 "Series" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2838 "9c7031b2-97909802-c35563e6-168bf0af-5cfbdce4",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2839 "1d9c4560-6480f3d9-0a4d3654-65715f38-755ad2e0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2840 "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2841 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2842 "Type" : "Study"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2843 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2844 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2845 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2846 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2847 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2848 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2849 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2850 "summary" : "Get parent study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2851 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2852 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2853 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2854 "/instances/{id}/tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2855 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2856 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2857 "description" : "Get the DICOM tags in the specified format. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2858 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2859 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2860 "description" : "If present, report the DICOM tags indexed in hexadecimal format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2861 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2862 "name" : "short",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2863 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2864 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2865 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2866 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2867 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2868 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2869 "description" : "If present, report the DICOM tags in human-readable format (same as the `/instances/{id}/simplified-tags` route)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2870 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2871 "name" : "simplify",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2872 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2873 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2874 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2875 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2876 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2877 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2878 "description" : "Orthanc identifier of the DICOM instance of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2879 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2880 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2881 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2882 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2883 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2884 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2885 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2886 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2887 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2888 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2889 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2890 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2891 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2892 "description" : "JSON object containing the DICOM tags and their associated value",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2893 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2894 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2895 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2896 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2897 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2898 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2899 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2900 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2901 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2902 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2903 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2904 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2905 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2906 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2907 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2908 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2909 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2910 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2911 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2912 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006100507010800000005269"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2913 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2914 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2915 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2916 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2917 "Value" : "20061005"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2918 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2919 "0008,0021" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2920 "Name" : "SeriesDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2921 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2922 "Value" : "20061005"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2923 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2924 "0008,0022" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2925 "Name" : "AcquisitionDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2926 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2927 "Value" : "20061005"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2928 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2929 "0008,0023" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2930 "Name" : "ContentDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2931 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2932 "Value" : "20061005"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2933 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2934 "0008,0030" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2935 "Name" : "StudyTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2936 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2937 "Value" : "101556.921000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2938 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2939 "0008,0031" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2940 "Name" : "SeriesTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2941 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2942 "Value" : "102051.046000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2943 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2944 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2945 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2946 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2947 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2948 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2949 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2950 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2951 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2952 "summary" : "Get DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2953 "tags" : [ "Instances" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2954 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2955 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2956 "/jobs" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2957 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2958 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2959 "description" : "List all the available jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2960 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2961 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2962 "description" : "If present, retrieve detailed information about the individual jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2963 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2964 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2965 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2966 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2967 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2968 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2969 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2970 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2971 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2972 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2973 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2974 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2975 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2976 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2977 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2978 "54a098c3-b13d-4650-946d-efbe66430a53",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2979 "645ecb02-7c0e-4465-b767-df873222dcfb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2980 "7dcebce7-6583-43be-bef3-01b7cb242768",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2981 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2982 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2983 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2984 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2985 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2986 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2987 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2988 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2989 "summary" : "List jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2990 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2991 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2992 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2993 "/jobs/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2994 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2995 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2996 "description" : "Retrieve detailed information about the job whose identifier is provided in the URL: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2997 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2998 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2999 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3000 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3001 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3002 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3003 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3004 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3005 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3006 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3007 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3008 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3009 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3010 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3011 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3012 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3013 "description" : "JSON object detailing the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3014 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3015 "CompletionTime" : "20201227T161842.520129",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3016 "Content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3017 "ArchiveSizeMB" : 22,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3018 "Description" : "REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3019 "InstancesCount" : 232,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3020 "UncompressedSizeMB" : 64
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3021 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3022 "CreationTime" : "20201227T161836.428311",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3023 "EffectiveRuntime" : 6.0810000000000004,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3024 "ErrorCode" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3025 "ErrorDescription" : "Success",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3026 "ID" : "645ecb02-7c0e-4465-b767-df873222dcfb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3027 "Priority" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3028 "Progress" : 100,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3029 "State" : "Success",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3030 "Timestamp" : "20201228T160340.253201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3031 "Type" : "Media"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3032 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3033 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3034 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3035 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3036 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3037 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3038 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3039 "summary" : "Get job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3040 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3041 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3042 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3043 "/jobs/{id}/cancel" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3044 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3045 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3046 "description" : "Cancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3047 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3048 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3049 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3050 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3051 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3052 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3053 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3054 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3055 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3056 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3057 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3058 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3059 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3060 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3061 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3062 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3063 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3064 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3065 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3066 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3067 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3068 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3069 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3070 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3071 "summary" : "Cancel job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3072 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3073 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3074 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3075 "/jobs/{id}/pause" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3076 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3077 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3078 "description" : "Pause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3079 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3080 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3081 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3082 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3083 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3084 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3085 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3086 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3087 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3088 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3089 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3090 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3091 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3092 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3093 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3094 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3095 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3096 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3097 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3098 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3099 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3100 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3101 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3102 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3103 "summary" : "Pause job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3104 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3105 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3106 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3107 "/jobs/{id}/resubmit" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3108 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3109 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3110 "description" : "Resubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3111 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3112 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3113 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3114 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3115 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3116 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3117 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3118 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3119 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3120 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3121 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3122 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3123 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3124 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3125 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3126 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3127 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3128 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3129 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3130 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3131 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3132 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3133 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3134 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3135 "summary" : "Resubmit job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3136 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3137 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3138 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3139 "/jobs/{id}/resume" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3140 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3141 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3142 "description" : "Resume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3143 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3144 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3145 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3146 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3147 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3148 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3149 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3150 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3151 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3152 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3153 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3154 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3155 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3156 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3157 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3158 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3159 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3160 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3161 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3162 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3163 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3164 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3165 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3166 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3167 "summary" : "Resume job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3168 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3169 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3170 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3171 "/jobs/{id}/{key}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3172 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3173 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3174 "description" : "Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3175 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3176 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3177 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3178 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3179 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3180 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3181 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3182 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3183 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3184 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3185 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3186 "description" : "Name of the output of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3187 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3188 "name" : "key",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3189 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3190 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3191 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3192 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3193 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3194 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3195 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3196 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3197 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3198 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3199 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3200 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3201 "description" : "Content of the output of the job"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3202 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3203 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3204 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3205 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3206 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3207 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3208 "summary" : "Get job output",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3209 "tags" : [ "Jobs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3210 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3211 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3212 "/modalities" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3213 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3214 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3215 "description" : "List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the `DicomModalities` configuration option, or to the information stored in the database if `DicomModalitiesInDatabase` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3216 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3217 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3218 "description" : "If present, retrieve detailed information about the individual DICOM modalities",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3219 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3220 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3221 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3222 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3223 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3224 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3225 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3226 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3227 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3228 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3229 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3230 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3231 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3232 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3233 "description" : "JSON array containing either the identifiers of the modalities, or detailed information about the modalities (if `expand` argument is provided)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3234 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3235 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3236 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3237 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3238 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3239 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3240 "summary" : "List DICOM modalities",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3241 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3242 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3243 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3244 "/modalities/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3245 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3246 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3247 "description" : "Delete one DICOM modality. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3248 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3249 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3250 "description" : "Identifier of the DICOM modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3251 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3252 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3253 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3254 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3255 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3256 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3257 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3258 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3259 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3260 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3261 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3262 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3263 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3264 "summary" : "Delete DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3265 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3266 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3267 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3268 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3269 "description" : "List the operations that are available for a DICOM modality.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3270 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3271 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3272 "description" : "Identifier of the DICOM modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3273 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3274 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3275 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3276 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3277 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3278 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3279 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3280 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3281 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3282 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3283 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3284 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3285 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3286 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3287 "description" : "List of the available operations"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3288 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3289 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3290 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3291 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3292 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3293 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3294 "summary" : "List operations on modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3295 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3296 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3297 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3298 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3299 "description" : "Define a new DICOM modality, or update an existing one. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3300 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3301 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3302 "description" : "Identifier of the new/updated DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3303 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3304 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3305 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3306 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3307 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3308 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3309 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3310 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3311 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3312 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3313 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3314 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3315 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3316 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3317 "AET" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3318 "description" : "AET of the remote DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3319 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3320 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3321 "AllowEcho" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3322 "description" : "Whether to accept C-ECHO SCU commands issued by the remote modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3323 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3324 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3325 "AllowFind" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3326 "description" : "Whether to accept C-FIND SCU commands issued by the remote modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3327 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3328 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3329 "AllowGet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3330 "description" : "Whether to accept C-GET SCU commands issued by the remote modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3331 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3332 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3333 "AllowMove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3334 "description" : "Whether to accept C-MOVE SCU commands issued by the remote modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3335 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3336 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3337 "AllowStorageCommitment" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3338 "description" : "Whether to accept storage commitment requests issued by the remote modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3339 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3340 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3341 "AllowStore" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3342 "description" : "Whether to accept C-STORE SCU commands issued by the remote modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3343 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3344 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3345 "AllowTranscoding" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3346 "description" : "Whether to allow transcoding for operations initiated by this modality (typically, C-GET)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3347 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3348 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3349 "Host" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3350 "description" : "Host address of the remote DICOM modality (typically, an IP address)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3351 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3352 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3353 "Manufacturer" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3354 "description" : "Manufacturer of the remote DICOM modality (check configuration option `DicomModalities` for possible values",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3355 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3356 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3357 "Port" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3358 "description" : "TCP port of the remote DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3359 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3360 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3361 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3362 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3363 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3364 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3365 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3366 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3367 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3368 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3369 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3370 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3371 "summary" : "Update DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3372 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3373 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3374 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3375 "/modalities/{id}/configuration" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3376 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3377 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3378 "description" : "Get detailed information about the configuration of some DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3379 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3380 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3381 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3382 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3383 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3384 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3385 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3386 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3387 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3388 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3389 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3390 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3391 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3392 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3393 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3394 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3395 "description" : "Configuration of the modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3396 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3397 "AET" : "ORTHANCTEST",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3398 "AllowEcho" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3399 "AllowEventReport" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3400 "AllowFind" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3401 "AllowGet" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3402 "AllowMove" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3403 "AllowNAction" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3404 "AllowStore" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3405 "AllowTranscoding" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3406 "Host" : "127.0.1.1",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3407 "Manufacturer" : "Generic",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3408 "Port" : 5001
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3409 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3410 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3411 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3412 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3413 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3414 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3415 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3416 "summary" : "Get modality configuration",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3417 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3418 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3419 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3420 "/modalities/{id}/echo" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3421 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3422 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3423 "description" : "Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-c-echo",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3424 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3425 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3426 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3427 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3428 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3429 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3430 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3431 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3432 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3433 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3434 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3435 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3436 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3437 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3438 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3439 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3440 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3441 "CheckFind" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3442 "description" : "Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` configuration option. New in Orthanc 1.8.1.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3443 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3444 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3445 "Timeout" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3446 "description" : "Timeout for the C-ECHO command, in seconds",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3447 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3448 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3449 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3450 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3451 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3452 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3453 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3454 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3455 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3456 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3457 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3458 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3459 "summary" : "Trigger C-ECHO SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3460 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3461 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3462 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3463 "/modalities/{id}/find" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3464 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3465 "deprecated" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3466 "description" : "Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of matching patients/studies/series. Deprecated in favor of `/modalities/{id}/query`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3467 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3468 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3469 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3470 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3471 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3472 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3473 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3474 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3475 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3476 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3477 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3478 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3479 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3480 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3481 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3482 "description" : "Associative array containing the query on the values of the DICOM tags"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3483 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3484 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3485 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3486 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3487 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3488 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3489 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3490 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3491 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3492 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3493 "description" : "JSON array describing the DICOM tags of the matching patients, embedding the matching studies, then the matching series."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3494 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3495 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3496 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3497 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3498 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3499 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3500 "summary" : "Hierarchical C-FIND SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3501 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3502 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3503 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3504 "/modalities/{id}/find-instance" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3505 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3506 "deprecated" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3507 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of `/modalities/{id}/query`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3508 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3509 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3510 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3511 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3512 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3513 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3514 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3515 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3516 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3517 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3518 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3519 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3520 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3521 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3522 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3523 "description" : "Associative array containing the query on the values of the DICOM tags"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3524 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3525 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3526 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3527 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3528 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3529 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3530 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3531 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3532 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3533 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3534 "description" : "JSON array describing the DICOM tags of the matching instances"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3535 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3536 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3537 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3538 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3539 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3540 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3541 "summary" : "C-FIND SCU for instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3542 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3543 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3544 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3545 "/modalities/{id}/find-patient" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3546 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3547 "deprecated" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3548 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of `/modalities/{id}/query`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3549 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3550 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3551 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3552 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3553 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3554 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3555 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3556 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3557 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3558 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3559 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3560 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3561 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3562 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3563 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3564 "description" : "Associative array containing the query on the values of the DICOM tags"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3565 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3566 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3567 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3568 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3569 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3570 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3571 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3572 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3573 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3574 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3575 "description" : "JSON array describing the DICOM tags of the matching patients"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3576 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3577 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3578 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3579 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3580 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3581 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3582 "summary" : "C-FIND SCU for patients",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3583 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3584 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3585 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3586 "/modalities/{id}/find-series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3587 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3588 "deprecated" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3589 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of `/modalities/{id}/query`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3590 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3591 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3592 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3593 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3594 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3595 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3596 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3597 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3598 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3599 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3600 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3601 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3602 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3603 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3604 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3605 "description" : "Associative array containing the query on the values of the DICOM tags"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3606 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3607 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3608 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3609 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3610 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3611 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3612 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3613 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3614 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3615 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3616 "description" : "JSON array describing the DICOM tags of the matching series"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3617 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3618 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3619 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3620 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3621 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3622 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3623 "summary" : "C-FIND SCU for series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3624 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3625 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3626 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3627 "/modalities/{id}/find-study" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3628 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3629 "deprecated" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3630 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of `/modalities/{id}/query`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3631 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3632 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3633 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3634 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3635 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3636 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3637 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3638 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3639 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3640 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3641 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3642 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3643 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3644 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3645 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3646 "description" : "Associative array containing the query on the values of the DICOM tags"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3647 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3648 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3649 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3650 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3651 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3652 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3653 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3654 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3655 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3656 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3657 "description" : "JSON array describing the DICOM tags of the matching studies"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3658 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3659 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3660 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3661 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3662 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3663 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3664 "summary" : "C-FIND SCU for studies",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3665 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3666 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3667 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3668 "/modalities/{id}/find-worklist" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3669 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3670 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3671 "description" : "Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3672 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3673 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3674 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3675 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3676 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3677 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3678 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3679 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3680 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3681 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3682 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3683 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3684 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3685 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3686 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3687 "description" : "Associative array containing the query on the values of the DICOM tags"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3688 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3689 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3690 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3691 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3692 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3693 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3694 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3695 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3696 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3697 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3698 "description" : "JSON array describing the DICOM tags of the matching worklists"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3699 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3700 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3701 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3702 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3703 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3704 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3705 "summary" : "C-FIND SCU for worklist",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3706 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3707 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3708 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3709 "/modalities/{id}/move" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3710 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3711 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3712 "description" : "Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-c-move",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3713 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3714 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3715 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3716 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3717 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3718 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3719 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3720 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3721 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3722 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3723 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3724 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3725 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3726 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3727 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3728 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3729 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3730 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3731 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3732 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3733 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3734 "Level" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3735 "description" : "Level of the query (`Patient`, `Study`, `Series` or `Instance`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3736 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3737 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3738 "LocalAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3739 "description" : "Local AET that is used for this commands, defaults to `DicomAet` configuration option",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3740 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3741 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3742 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3743 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3744 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3745 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3746 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3747 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3748 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3749 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3750 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3751 "description" : "List of the Orthanc identifiers of all the DICOM resources to be sent",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3752 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3753 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3754 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3755 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3756 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3757 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3758 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3759 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3760 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3761 "TargetAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3762 "description" : "Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU commands, defaults to `DicomAet` configuration option in order to do a simple query/retrieve",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3763 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3764 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3765 "Timeout" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3766 "description" : "Timeout for the C-STORE command, in seconds",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3767 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3768 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3769 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3770 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3771 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3772 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3773 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3774 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3775 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3776 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3777 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3778 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3779 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3780 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3781 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3782 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3783 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3784 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3785 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3786 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3787 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3788 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3789 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3790 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3791 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3792 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3793 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3794 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3795 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3796 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3797 "summary" : "Trigger C-MOVE SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3798 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3799 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3800 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3801 "/modalities/{id}/query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3802 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3803 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3804 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3805 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3806 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3807 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3808 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3809 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3810 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3811 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3812 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3813 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3814 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3815 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3816 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3817 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3818 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3819 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3820 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3821 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3822 "Level" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3823 "description" : "Level of the query (`Patient`, `Study`, `Series` or `Instance`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3824 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3825 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3826 "Normalize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3827 "description" : "Whether to normalize the query, i.e. whether to wipe out from the query, the DICOM tags that are not applicable for the query-retrieve level of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3828 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3829 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3830 "Query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3831 "description" : "Associative array containing the filter on the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3832 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3833 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3834 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3835 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3836 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3837 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3838 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3839 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3840 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3841 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3842 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3843 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3844 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3845 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3846 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3847 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3848 "description" : "Identifier of the query, to be used with `/queries/{id}`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3849 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3850 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3851 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3852 "description" : "Root path to the query in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3853 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3854 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3855 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3856 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3857 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3858 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3859 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3860 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3861 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3862 "summary" : "Trigger C-FIND SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3863 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3864 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3865 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3866 "/modalities/{id}/storage-commitment" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3867 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3868 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3869 "description" : "Trigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3870 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3871 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3872 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3873 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3874 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3875 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3876 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3877 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3878 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3879 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3880 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3881 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3882 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3883 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3884 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3885 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3886 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3887 "DicomInstances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3888 "description" : "List of DICOM resources that are not necessarily stored within Orthanc, but that must be checked by storage commitment. This is a list of JSON objects that must contain the `SOPClassUID` and `SOPInstanceUID` fields.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3889 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3890 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3891 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3892 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3893 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3894 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3895 "description" : "List of the Orthanc identifiers of the DICOM resources to be checked by storage commitment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3896 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3897 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3898 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3899 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3900 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3901 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3902 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3903 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3904 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3905 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3906 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3907 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3908 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3909 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3910 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3911 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3912 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3913 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3914 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3915 "description" : "Identifier of the storage commitment report, to be used with `/storage-commitment/{id}`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3916 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3917 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3918 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3919 "description" : "Root path to the storage commitment report in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3920 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3921 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3922 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3923 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3924 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3925 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3926 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3927 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3928 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3929 "summary" : "Trigger storage commitment request",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3930 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3931 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3932 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3933 "/modalities/{id}/store" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3934 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3935 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3936 "description" : "Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#rest-store-scu",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3937 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3938 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3939 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3940 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3941 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3942 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3943 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3944 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3945 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3946 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3947 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3948 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3949 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3950 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3951 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3952 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3953 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3954 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3955 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3956 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3957 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3958 "LocalAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3959 "description" : "Local AET that is used for this commands, defaults to `DicomAet` configuration option",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3960 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3961 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3962 "MoveOriginatorAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3963 "description" : "Move originator AET that is used for this commands, in order to fake a C-MOVE SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3964 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3965 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3966 "MoveOriginatorID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3967 "description" : "Move originator ID that is used for this commands, in order to fake a C-MOVE SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3968 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3969 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3970 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3971 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3972 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3973 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3974 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3975 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3976 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3977 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3978 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3979 "description" : "List of the Orthanc identifiers of all the DICOM resources to be sent",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3980 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3981 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3982 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3983 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3984 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3985 "StorageCommitment" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3986 "description" : "Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: https://book.orthanc-server.com/users/storage-commitment.html#chaining-c-store-with-storage-commitment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3987 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3988 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3989 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3990 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3991 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3992 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3993 "Timeout" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3994 "description" : "Timeout for the C-STORE command, in seconds",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3995 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3996 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3997 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3998 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3999 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4000 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4001 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4002 "description" : "The Orthanc identifier of one resource to be sent"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4003 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4004 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4005 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4006 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4007 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4008 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4009 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4010 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4011 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4012 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4013 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4014 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4015 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4016 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4017 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4018 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4019 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4020 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4021 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4022 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4023 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4024 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4025 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4026 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4027 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4028 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4029 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4030 "summary" : "Trigger C-STORE SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4031 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4032 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4033 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4034 "/modalities/{id}/store-straight" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4035 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4036 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4037 "description" : "Synchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `storescu` from DCMTK or dcm4che.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4038 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4039 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4040 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4041 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4042 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4043 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4044 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4045 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4046 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4047 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4048 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4049 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4050 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4051 "application/dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4052 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4053 "description" : "DICOM instance to be sent"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4054 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4055 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4056 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4057 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4058 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4059 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4060 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4061 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4062 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4063 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4064 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4065 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4066 "SOPClassUID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4067 "description" : "SOP class UID of the DICOM instance, if the C-STORE SCU has succeeded",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4068 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4069 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4070 "SOPInstanceUID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4071 "description" : "SOP instance UID of the DICOM instance, if the C-STORE SCU has succeeded",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4072 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4073 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4074 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4075 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4076 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4077 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4078 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4079 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4080 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4081 "summary" : "Straight C-STORE SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4082 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4083 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4084 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4085 "/patients" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4086 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4087 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4088 "description" : "List the Orthanc identifiers of all the available DICOM patients",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4089 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4090 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4091 "description" : "If present, retrieve detailed information about the individual patients",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4092 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4093 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4094 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4095 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4096 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4097 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4098 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4099 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4100 "description" : "Limit the number of results",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4101 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4102 "name" : "limit",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4103 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4104 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4105 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4106 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4107 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4108 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4109 "description" : "Show only the resources since the provided index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4110 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4111 "name" : "since",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4112 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4113 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4114 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4115 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4116 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4117 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4118 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4119 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4120 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4121 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4122 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4123 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported patients (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4124 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4125 "0946fcb6-cf12ab43-bad958c1-bf057ad5-0fc6f54c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4126 "da39a3ee-5e6b4b0d-3255bfef-95601890-afd80709"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4127 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4128 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4129 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4130 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4131 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4132 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4133 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4134 "summary" : "List the available patients",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4135 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4136 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4137 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4138 "/patients/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4139 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4140 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4141 "description" : "Delete the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4142 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4143 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4144 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4145 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4146 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4147 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4148 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4149 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4150 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4151 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4152 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4153 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4154 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4155 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4156 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4157 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4158 "summary" : "Delete some patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4159 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4160 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4161 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4162 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4163 "description" : "Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4164 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4165 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4166 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4167 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4168 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4169 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4170 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4171 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4172 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4173 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4174 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4175 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4176 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4177 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4178 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4179 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4180 "description" : "Information about the DICOM patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4181 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4182 "ID" : "46e6332c-677825b6-202fcf7c-f787bc5f-7b07c382",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4183 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4184 "LastUpdate" : "20180414T091542",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4185 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4186 "PatientID" : "SOtNwu",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4187 "PatientName" : "INCISIX"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4188 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4189 "Studies" : [ "e98b9ac7-dd31ac40-ff046cb2-f0400d30-12f81d85" ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4190 "Type" : "Patient"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4191 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4192 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4193 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4194 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4195 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4196 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4197 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4198 "summary" : "Get information about some patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4199 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4200 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4201 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4202 "/patients/{id}/anonymize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4203 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4204 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4205 "description" : "Start a job that will anonymize all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4206 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4207 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4208 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4209 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4210 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4211 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4212 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4213 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4214 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4215 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4216 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4217 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4218 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4219 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4220 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4221 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4222 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4223 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4224 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4225 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4226 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4227 "DicomVersion" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4228 "description" : "Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4229 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4230 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4231 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4232 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4233 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4234 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4235 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4236 "description" : "List of DICOM tags whose value must not be destroyed by the anonymization",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4237 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4238 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4239 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4240 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4241 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4242 "KeepPrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4243 "description" : "Keep the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4244 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4245 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4246 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4247 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4248 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4249 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4250 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4251 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4252 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4253 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4254 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4255 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4256 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4257 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4258 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4259 "description" : "List of additional tags to be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4260 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4261 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4262 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4263 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4264 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4265 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4266 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4267 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4268 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4269 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4270 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4271 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4272 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4273 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4274 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4275 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4276 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4277 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4278 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4279 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4280 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4281 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4282 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4283 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4284 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4285 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4286 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4287 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4288 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4289 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4290 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4291 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4292 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4293 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4294 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4295 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4296 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4297 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4298 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4299 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4300 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4301 "summary" : "Anonymize patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4302 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4303 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4304 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4305 "/patients/{id}/archive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4306 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4307 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4308 "description" : "Synchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4309 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4310 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4311 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4312 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4313 "name" : "transcode",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4314 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4315 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4316 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4317 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4318 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4319 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4320 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4321 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4322 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4323 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4324 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4325 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4326 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4327 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4328 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4329 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4330 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4331 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4332 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4333 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4334 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4335 "description" : "ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4336 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4337 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4338 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4339 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4340 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4341 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4342 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4343 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4344 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4345 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4346 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4347 "description" : "Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4348 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4349 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4350 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4351 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4352 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4353 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4354 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4355 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4356 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4357 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4358 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4359 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4360 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4361 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4362 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4363 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4364 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4365 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4366 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4367 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4368 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4369 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4370 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4371 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4372 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4373 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4374 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4375 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4376 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4377 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4378 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4379 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4380 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4381 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4382 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4383 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4384 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4385 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4386 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4387 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4388 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4389 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4390 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4391 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4392 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4393 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4394 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4395 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4396 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4397 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4398 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4399 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4400 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4401 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4402 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4403 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4404 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4405 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4406 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4407 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4408 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4409 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4410 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4411 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4412 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4413 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4414 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4415 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4416 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4417 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4418 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4419 "/patients/{id}/attachments" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4420 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4421 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4422 "description" : "Get the list of attachments that are associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4423 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4424 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4425 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4426 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4427 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4428 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4429 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4430 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4431 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4432 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4433 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4434 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4435 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4436 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4437 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4438 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4439 "description" : "JSON array containing the names of the attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4440 "example" : []
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4441 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4442 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4443 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4444 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4445 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4446 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4447 "summary" : "List attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4448 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4449 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4450 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4451 "/patients/{id}/attachments/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4452 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4453 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4454 "description" : "Delete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4455 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4456 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4457 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4458 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4459 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4460 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4461 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4462 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4463 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4464 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4465 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4466 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4467 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4468 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4469 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4470 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4471 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4472 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4473 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4474 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4475 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4476 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4477 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4478 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4479 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4480 "summary" : "Delete attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4481 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4482 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4483 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4484 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4485 "description" : "Get the list of the operations that are available for attachments associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4486 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4487 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4488 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4489 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4490 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4491 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4492 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4493 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4494 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4495 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4496 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4497 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4498 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4499 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4500 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4501 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4502 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4503 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4504 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4505 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4506 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4507 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4508 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4509 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4510 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4511 "description" : "List of the available operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4512 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4513 "compress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4514 "compressed-data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4515 "compressed-md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4516 "compressed-size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4517 "data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4518 "is-compressed",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4519 "md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4520 "size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4521 "uncompress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4522 "verify-md5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4523 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4524 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4525 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4526 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4527 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4528 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4529 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4530 "summary" : "List operations on attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4531 "tags" : [ "Other" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4532 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4533 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4534 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4535 "description" : "Attach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4536 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4537 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4538 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4539 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4540 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4541 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4542 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4543 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4544 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4545 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4546 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4547 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4548 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4549 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4550 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4551 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4552 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4553 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4554 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4555 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4556 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4557 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4558 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4559 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4560 "description" : "Binary data containing the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4561 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4562 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4563 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4564 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4565 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4566 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4567 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4568 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4569 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4570 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4571 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4572 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4573 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4574 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4575 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4576 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4577 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4578 "summary" : "Set attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4579 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4580 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4581 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4582 "/patients/{id}/attachments/{name}/compress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4583 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4584 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4585 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4586 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4587 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4588 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4589 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4590 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4591 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4592 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4593 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4594 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4595 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4596 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4597 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4598 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4599 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4600 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4601 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4602 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4603 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4604 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4605 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4606 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4607 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4608 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4609 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4610 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4611 "summary" : "Compress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4612 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4613 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4614 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4615 "/patients/{id}/attachments/{name}/compressed-data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4616 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4617 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4618 "description" : "Get the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4619 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4620 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4621 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4622 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4623 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4624 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4625 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4626 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4627 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4628 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4629 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4630 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4631 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4632 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4633 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4634 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4635 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4636 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4637 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4638 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4639 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4640 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4641 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4642 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4643 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4644 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4645 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4646 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4647 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4648 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4649 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4650 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4651 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4652 "summary" : "Get attachment (no decompression)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4653 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4654 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4655 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4656 "/patients/{id}/attachments/{name}/compressed-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4657 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4658 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4659 "description" : "Get the MD5 hash of one attachment associated with the given patient, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4660 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4661 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4662 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4663 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4664 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4665 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4666 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4667 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4668 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4669 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4670 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4671 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4672 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4673 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4674 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4675 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4676 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4677 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4678 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4679 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4680 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4681 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4682 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4683 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4684 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4685 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4686 "description" : "The MD5 of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4687 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4688 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4689 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4690 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4691 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4692 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4693 "summary" : "Get MD5 of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4694 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4695 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4696 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4697 "/patients/{id}/attachments/{name}/compressed-size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4698 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4699 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4700 "description" : "Get the size of one attachment associated with the given patient, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4701 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4702 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4703 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4704 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4705 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4706 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4707 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4708 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4709 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4710 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4711 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4712 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4713 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4714 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4715 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4716 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4717 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4718 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4719 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4720 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4721 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4722 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4723 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4724 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4725 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4726 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4727 "description" : "The size of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4728 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4729 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4730 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4731 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4732 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4733 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4734 "summary" : "Get size of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4735 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4736 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4737 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4738 "/patients/{id}/attachments/{name}/data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4739 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4740 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4741 "description" : "Get the (binary) content of one attachment associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4742 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4743 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4744 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4745 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4746 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4747 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4748 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4749 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4750 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4751 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4752 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4753 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4754 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4755 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4756 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4757 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4758 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4759 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4760 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4761 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4762 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4763 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4764 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4765 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4766 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4767 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4768 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4769 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4770 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4771 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4772 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4773 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4774 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4775 "summary" : "Get attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4776 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4777 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4778 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4779 "/patients/{id}/attachments/{name}/is-compressed" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4780 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4781 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4782 "description" : "Test whether the attachment has been stored as a compressed file on the disk.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4783 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4784 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4785 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4786 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4787 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4788 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4789 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4790 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4791 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4792 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4793 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4794 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4795 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4796 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4797 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4798 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4799 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4800 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4801 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4802 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4803 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4804 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4805 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4806 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4807 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4808 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4809 "description" : "`0` if the attachment was stored uncompressed, `1` if it was compressed"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4810 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4811 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4812 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4813 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4814 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4815 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4816 "summary" : "Is attachment compressed?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4817 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4818 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4819 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4820 "/patients/{id}/attachments/{name}/md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4821 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4822 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4823 "description" : "Get the MD5 hash of one attachment associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4824 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4825 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4826 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4827 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4828 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4829 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4830 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4831 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4832 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4833 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4834 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4835 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4836 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4837 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4838 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4839 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4840 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4841 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4842 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4843 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4844 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4845 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4846 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4847 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4848 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4849 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4850 "description" : "The MD5 of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4851 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4852 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4853 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4854 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4855 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4856 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4857 "summary" : "Get MD5 of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4858 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4859 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4860 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4861 "/patients/{id}/attachments/{name}/size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4862 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4863 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4864 "description" : "Get the size of one attachment associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4865 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4866 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4867 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4868 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4869 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4870 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4871 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4872 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4873 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4874 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4875 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4876 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4877 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4878 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4879 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4880 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4881 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4882 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4883 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4884 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4885 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4886 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4887 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4888 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4889 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4890 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4891 "description" : "The size of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4892 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4893 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4894 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4895 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4896 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4897 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4898 "summary" : "Get size of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4899 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4900 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4901 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4902 "/patients/{id}/attachments/{name}/uncompress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4903 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4904 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4905 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4906 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4907 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4908 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4909 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4910 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4911 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4912 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4913 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4914 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4915 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4916 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4917 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4918 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4919 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4920 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4921 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4922 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4923 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4924 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4925 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4926 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4927 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4928 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4929 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4930 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4931 "summary" : "Uncompress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4932 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4933 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4934 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4935 "/patients/{id}/attachments/{name}/verify-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4936 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4937 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4938 "description" : "Verify that the attachment is not corrupted, by validating its MD5 hash",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4939 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4940 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4941 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4942 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4943 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4944 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4945 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4946 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4947 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4948 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4949 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4950 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4951 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4952 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4953 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4954 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4955 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4956 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4957 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4958 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4959 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4960 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4961 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4962 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4963 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4964 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4965 "description" : "On success, a valid JSON object is returned"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4966 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4967 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4968 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4969 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4970 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4971 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4972 "summary" : "Verify attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4973 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4974 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4975 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4976 "/patients/{id}/instances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4977 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4978 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4979 "description" : "Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4980 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4981 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4982 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4983 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4984 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4985 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4986 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4987 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4988 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4989 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4990 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4991 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4992 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4993 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4994 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4995 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4996 "description" : "JSON array containing information about the child DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4997 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4998 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4999 "FileSize" : 526866,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5000 "FileUuid" : "c14b2b87-53e2-420b-baf9-020cae34fedf",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5001 "ID" : "e3dfd688-80e4743a-29c45f90-371ec4a4-04d18ae5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5002 "IndexInSeries" : 137,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5003 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5004 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5005 "ImagePositionPatient" : "-96.3193359375\\-249.3193359375\\62",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5006 "InstanceNumber" : "137",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5007 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014881"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5008 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5009 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5010 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5011 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5012 "FileSize" : 526870,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5013 "FileUuid" : "27cdb02f-500f-4b37-9ca1-058d8d4f649a",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5014 "ID" : "4fecddf1-518346e4-4f30176b-c453b3d8-65899230",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5015 "IndexInSeries" : 114,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5016 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5017 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5018 "ImagePositionPatient" : "-96.3193359375\\-249.3193359375\\73.5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5019 "InstanceNumber" : "114",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5020 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014858"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5021 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5022 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5023 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5024 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5025 "FileSize" : 526868,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5026 "FileUuid" : "5a6334a8-e050-47e5-8832-531ee62aa9a7",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5027 "ID" : "c9a55bc1-9e98ba4b-bc455dc3-24c4c525-1b171b6c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5028 "IndexInSeries" : 66,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5029 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5030 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5031 "ImagePositionPatient" : "-96.3193359375\\-249.3193359375\\97.5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5032 "InstanceNumber" : "66",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5033 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014810"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5034 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5035 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5036 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5037 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5038 "FileSize" : 526866,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5039 "FileUuid" : "e6c09e08-8284-4416-a90f-67a7dc9f68f0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5040 "ID" : "135cca6f-4c099fdd-afc99251-f58a819b-5a0222eb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5041 "IndexInSeries" : 161,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5042 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5043 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5044 "ImagePositionPatient" : "-96.3193359375\\-249.3193359375\\50",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5045 "InstanceNumber" : "161",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5046 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014905"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5047 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5048 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5049 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5050 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5051 "FileSize" : 526866,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5052 "FileUuid" : "9eb33412-d1e9-4bb0-879b-5501db81d574",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5053 "ID" : "719d58b1-2a259486-7cc5919d-68a2bd30-da2cd290",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5054 "IndexInSeries" : 61,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5055 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5056 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5057 "ImagePositionPatient" : "-96.3193359375\\-249.3193359375\\100",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5058 "InstanceNumber" : "61",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5059 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014805"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5060 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5061 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5062 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5063 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5064 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5065 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5066 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5067 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5068 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5069 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5070 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5071 "summary" : "Get child instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5072 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5073 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5074 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5075 "/patients/{id}/instances-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5076 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5077 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5078 "description" : "Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5079 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5080 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5081 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5082 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5083 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5084 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5085 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5086 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5087 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5088 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5089 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5090 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5091 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5092 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5093 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5094 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5095 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5096 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5097 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5098 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5099 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5100 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5101 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5102 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5103 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5104 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5105 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5106 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5107 "description" : "JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5108 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5109 "011ead8d-f2508edd-da315604-80b002df-e678b796" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5110 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5111 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5112 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5113 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5114 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5115 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5116 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5117 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5118 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5119 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5120 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5121 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5122 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5123 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5124 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5125 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5126 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5127 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5128 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014840"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5129 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5130 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5131 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5132 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5133 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5134 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5135 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5136 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5137 "01252811-30d1c47b-a8c03da5-73177742-48495192" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5138 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5139 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5140 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5141 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5142 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5143 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5144 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5145 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5146 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5147 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5148 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5149 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5150 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5151 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5152 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5153 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5154 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5155 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5156 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014790"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5157 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5158 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5159 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5160 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5161 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5162 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5163 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5164 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5165 "04a30982-835a4b0a-3082b997-060f01f5-071a0f8d" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5166 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5167 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5168 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5169 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5170 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5171 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5172 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5173 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5174 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5175 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5176 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5177 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5178 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5179 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5180 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5181 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5182 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5183 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5184 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014760"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5185 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5186 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5187 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5188 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5189 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5190 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5191 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5192 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5193 "04efd8b9-2ae1f3db-deb0f226-e3267002-6cd8fa3c" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5194 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5195 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5196 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5197 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5198 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5199 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5200 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5201 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5202 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5203 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5204 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5205 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5206 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5207 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5208 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5209 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5210 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5211 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5212 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014832"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5213 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5214 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5215 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5216 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5217 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5218 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5219 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5220 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5221 "0df992f4-0a841d5c-aeb8cdda-9c1a0573-dbd49c3f" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5222 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5223 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5224 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5225 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5226 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5227 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5228 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5229 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5230 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5231 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5232 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5233 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5234 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5235 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5236 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5237 "0008,0018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5238 "Name" : "SOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5239 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5240 "Value" : "1.3.12.2.1107.5.1.4.54693.30000006053107175587500014882"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5241 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5242 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5243 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5244 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5245 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5246 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5247 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5248 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5249 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5250 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5251 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5252 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5253 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5254 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5255 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5256 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5257 "summary" : "Get tags of instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5258 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5259 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5260 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5261 "/patients/{id}/media" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5262 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5263 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5264 "description" : "Synchronously create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5265 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5266 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5267 "description" : "If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5268 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5269 "name" : "extended",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5270 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5271 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5272 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5273 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5274 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5275 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5276 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5277 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5278 "name" : "transcode",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5279 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5280 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5281 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5282 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5283 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5284 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5285 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5286 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5287 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5288 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5289 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5290 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5291 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5292 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5293 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5294 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5295 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5296 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5297 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5298 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5299 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5300 "description" : "ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5301 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5302 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5303 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5304 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5305 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5306 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5307 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5308 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5309 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5310 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5311 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5312 "description" : "Create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5313 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5314 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5315 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5316 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5317 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5318 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5319 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5320 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5321 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5322 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5323 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5324 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5325 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5326 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5327 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5328 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5329 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5330 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5331 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5332 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5333 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5334 "Extended" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5335 "description" : "If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5336 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5337 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5338 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5339 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5340 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5341 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5342 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5343 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5344 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5345 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5346 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5347 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5348 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5349 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5350 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5351 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5352 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5353 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5354 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5355 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5356 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5357 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5358 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5359 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5360 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5361 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5362 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5363 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5364 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5365 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5366 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5367 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5368 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5369 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5370 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5371 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5372 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5373 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5374 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5375 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5376 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5377 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5378 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5379 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5380 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5381 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5382 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5383 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5384 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5385 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5386 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5387 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5388 "/patients/{id}/metadata" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5389 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5390 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5391 "description" : "Get the list of metadata that are associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5392 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5393 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5394 "description" : "If present, also retrieve the value of the individual metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5395 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5396 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5397 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5398 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5399 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5400 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5401 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5402 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5403 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5404 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5405 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5406 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5407 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5408 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5409 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5410 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5411 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5412 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5413 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5414 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5415 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5416 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5417 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5418 "example" : [ "LastUpdate" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5419 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5420 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5421 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5422 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5423 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5424 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5425 "summary" : "List metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5426 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5427 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5428 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5429 "/patients/{id}/metadata/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5430 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5431 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5432 "description" : "Delete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5433 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5434 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5435 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5436 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5437 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5438 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5439 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5440 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5441 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5442 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5443 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5444 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5445 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5446 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5447 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5448 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5449 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5450 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5451 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5452 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5453 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5454 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5455 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5456 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5457 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5458 "summary" : "Delete metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5459 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5460 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5461 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5462 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5463 "description" : "Get the value of a metadata that is associated with the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5464 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5465 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5466 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5467 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5468 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5469 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5470 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5471 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5472 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5473 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5474 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5475 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5476 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5477 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5478 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5479 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5480 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5481 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5482 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5483 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5484 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5485 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5486 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5487 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5488 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5489 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5490 "description" : "Value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5491 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5492 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5493 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5494 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5495 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5496 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5497 "summary" : "Get metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5498 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5499 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5500 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5501 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5502 "description" : "Set the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5503 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5504 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5505 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5506 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5507 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5508 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5509 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5510 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5511 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5512 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5513 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5514 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5515 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5516 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5517 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5518 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5519 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5520 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5521 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5522 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5523 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5524 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5525 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5526 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5527 "description" : "String value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5528 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5529 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5530 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5531 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5532 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5533 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5534 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5535 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5536 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5537 "summary" : "Set metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5538 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5539 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5540 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5541 "/patients/{id}/modify" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5542 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5543 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5544 "description" : "Start a job that will modify all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5545 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5546 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5547 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5548 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5549 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5550 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5551 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5552 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5553 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5554 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5555 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5556 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5557 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5558 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5559 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5560 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5561 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5562 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5563 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5564 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5565 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5566 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5567 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5568 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5569 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5570 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5571 "description" : "Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5572 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5573 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5574 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5575 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5576 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5577 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5578 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5579 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5580 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5581 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5582 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5583 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5584 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5585 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5586 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5587 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5588 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5589 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5590 "description" : "List of tags that must be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5591 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5592 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5593 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5594 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5595 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5596 "RemovePrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5597 "description" : "Remove the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5598 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5599 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5600 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5601 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5602 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5603 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5604 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5605 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5606 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5607 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5608 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5609 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5610 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5611 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5612 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5613 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5614 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5615 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5616 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5617 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5618 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5619 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5620 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5621 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5622 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5623 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5624 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5625 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5626 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5627 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5628 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5629 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5630 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5631 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5632 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5633 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5634 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5635 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5636 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5637 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5638 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5639 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5640 "summary" : "Modify patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5641 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5642 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5643 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5644 "/patients/{id}/module" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5645 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5646 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5647 "description" : "Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5648 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5649 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5650 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5651 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5652 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5653 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5654 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5655 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5656 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5657 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5658 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5659 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5660 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5661 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5662 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5663 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5664 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5665 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5666 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5667 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5668 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5669 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5670 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5671 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5672 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5673 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5674 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5675 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5676 "description" : "Information about the DICOM patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5677 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5678 "0010,0010" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5679 "Name" : "PatientName",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5680 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5681 "Value" : "INCISIX"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5682 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5683 "0010,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5684 "Name" : "PatientID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5685 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5686 "Value" : "SOtNwu"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5687 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5688 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5689 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5690 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5691 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5692 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5693 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5694 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5695 "summary" : "Get patient module",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5696 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5697 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5698 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5699 "/patients/{id}/protected" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5700 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5701 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5702 "description" : "Is the patient protected against recycling?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5703 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5704 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5705 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5706 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5707 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5708 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5709 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5710 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5711 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5712 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5713 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5714 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5715 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5716 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5717 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5718 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5719 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5720 "description" : "`1` if protected, `0` if not protected"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5721 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5722 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5723 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5724 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5725 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5726 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5727 "summary" : "Is the patient protected against recycling?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5728 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5729 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5730 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5731 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5732 "description" : "Check out configuration options `MaximumStorageSize` and `MaximumPatientCount`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5733 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5734 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5735 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5736 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5737 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5738 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5739 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5740 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5741 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5742 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5743 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5744 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5745 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5746 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5747 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5748 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5749 "summary" : "Protect one patient against recycling",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5750 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5751 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5752 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5753 "/patients/{id}/reconstruct" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5754 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5755 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5756 "description" : "Reconstruct the main DICOM tags of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5757 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5758 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5759 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5760 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5761 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5762 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5763 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5764 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5765 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5766 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5767 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5768 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5769 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5770 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5771 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5772 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5773 "summary" : "Reconstruct tags of patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5774 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5775 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5776 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5777 "/patients/{id}/series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5778 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5779 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5780 "description" : "Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5781 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5782 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5783 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5784 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5785 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5786 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5787 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5788 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5789 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5790 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5791 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5792 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5793 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5794 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5795 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5796 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5797 "description" : "JSON array containing information about the child DICOM series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5798 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5799 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5800 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5801 "ID" : "52cc572c-3ee31930-c4b6d5e7-16c786dc-97bc209b",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5802 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5803 "e3dfd688-80e4743a-29c45f90-371ec4a4-04d18ae5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5804 "4fecddf1-518346e4-4f30176b-c453b3d8-65899230",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5805 "c9a55bc1-9e98ba4b-bc455dc3-24c4c525-1b171b6c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5806 "135cca6f-4c099fdd-afc99251-f58a819b-5a0222eb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5807 "719d58b1-2a259486-7cc5919d-68a2bd30-da2cd290",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5808 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5809 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5810 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5811 "LastUpdate" : "20180414T091542",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5812 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5813 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5814 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5815 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5816 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5817 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5818 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5819 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5820 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5821 "summary" : "Get child series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5822 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5823 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5824 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5825 "/patients/{id}/shared-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5826 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5827 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5828 "description" : "Extract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5829 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5830 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5831 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5832 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5833 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5834 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5835 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5836 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5837 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5838 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5839 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5840 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5841 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5842 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5843 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5844 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5845 "description" : "JSON object containing the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5846 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5847 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5848 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5849 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5850 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5851 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5852 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5853 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5854 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5855 "Value" : "ORIGINAL\\PRIMARY\\AXIAL\\CT_SOM5 SPI"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5856 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5857 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5858 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5859 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5860 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5861 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5862 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5863 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5864 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5865 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5866 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5867 "0008,0021" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5868 "Name" : "SeriesDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5869 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5870 "Value" : "20060531"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5871 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5872 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5873 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5874 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5875 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5876 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5877 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5878 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5879 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5880 "summary" : "Get shared tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5881 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5882 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5883 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5884 "/patients/{id}/statistics" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5885 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5886 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5887 "description" : "Get statistics about the given patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5888 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5889 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5890 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5891 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5892 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5893 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5894 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5895 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5896 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5897 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5898 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5899 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5900 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5901 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5902 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5903 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5904 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5905 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5906 "CountInstances" : 166,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5907 "CountSeries" : 1,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5908 "CountStudies" : 1,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5909 "DicomDiskSize" : "87460012",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5910 "DicomDiskSizeMB" : 83,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5911 "DicomUncompressedSize" : "87460012",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5912 "DicomUncompressedSizeMB" : 83,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5913 "DiskSize" : "89640436",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5914 "DiskSizeMB" : 85,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5915 "UncompressedSize" : "89640436",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5916 "UncompressedSizeMB" : 85
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5917 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5918 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5919 "CountInstances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5920 "description" : "Number of child instances within this patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5921 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5922 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5923 "CountSeries" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5924 "description" : "Number of child series within this patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5925 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5926 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5927 "CountStudies" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5928 "description" : "Number of child studies within this patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5929 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5930 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5931 "DicomDiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5932 "description" : "Size on the disk of the DICOM instances associated with the patient, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5933 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5934 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5935 "DicomDiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5936 "description" : "Size on the disk of the DICOM instances associated with the patient, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5937 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5938 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5939 "DicomUncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5940 "description" : "Size on the disk of the uncompressed DICOM instances associated with the patient, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5941 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5942 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5943 "DicomUncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5944 "description" : "Size on the disk of the uncompressed DICOM instances associated with the patient, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5945 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5946 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5947 "DiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5948 "description" : "Size of the patient on the disk in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5949 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5950 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5951 "DiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5952 "description" : "Size of the patient on the disk, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5953 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5954 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5955 "UncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5956 "description" : "Size of the patient after decompression in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5957 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5958 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5959 "UncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5960 "description" : "Size of the patient after decompression, expressed in megabytes (MB). This is different from `DiskSizeMB` iff `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5961 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5962 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5963 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5964 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5965 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5966 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5967 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5968 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5969 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5970 "summary" : "Get patient statistics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5971 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5972 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5973 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5974 "/patients/{id}/studies" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5975 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5976 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5977 "description" : "Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5978 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5979 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5980 "description" : "Orthanc identifier of the patient of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5981 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5982 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5983 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5984 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5985 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5986 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5987 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5988 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5989 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5990 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5991 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5992 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5993 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5994 "description" : "JSON array containing information about the child DICOM studies",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5995 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5996 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5997 "ID" : "e98b9ac7-dd31ac40-ff046cb2-f0400d30-12f81d85",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5998 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5999 "LastUpdate" : "20180414T091542",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6000 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6001 "AccessionNumber" : "0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6002 "InstitutionName" : "dPJ",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6003 "ReferringPhysicianName" : "YzTEkpkak0p0Tk5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6004 "RequestedProcedureDescription" : "CT2 tête, face, sinus",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6005 "StudyDate" : "20060531",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6006 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6007 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6008 "ParentPatient" : "46e6332c-677825b6-202fcf7c-f787bc5f-7b07c382",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6009 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6010 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6011 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6012 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6013 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6014 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6015 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6016 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6017 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6018 "summary" : "Get child studies",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6019 "tags" : [ "Patients" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6020 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6021 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6022 "/peers" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6023 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6024 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6025 "description" : "List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the `OrthancPeers` configuration option, or to the information stored in the database if `OrthancPeersInDatabase` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6026 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6027 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6028 "description" : "If present, retrieve detailed information about the individual Orthanc peers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6029 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6030 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6031 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6032 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6033 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6034 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6035 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6036 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6037 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6038 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6039 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6040 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6041 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6042 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6043 "description" : "JSON array containing either the identifiers of the peers, or detailed information about the peers (if `expand` argument is provided)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6044 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6045 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6046 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6047 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6048 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6049 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6050 "summary" : "List Orthanc peers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6051 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6052 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6053 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6054 "/peers/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6055 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6056 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6057 "description" : "Delete one Orthanc peer. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6058 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6059 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6060 "description" : "Identifier of the Orthanc peer of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6061 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6062 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6063 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6064 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6065 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6066 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6067 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6068 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6069 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6070 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6071 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6072 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6073 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6074 "summary" : "Delete Orthanc peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6075 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6076 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6077 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6078 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6079 "description" : "List the operations that are available for an Orthanc peer.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6080 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6081 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6082 "description" : "Identifier of the peer of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6083 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6084 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6085 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6086 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6087 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6088 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6089 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6090 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6091 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6092 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6093 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6094 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6095 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6096 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6097 "description" : "List of the available operations"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6098 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6099 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6100 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6101 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6102 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6103 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6104 "summary" : "List operations on peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6105 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6106 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6107 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6108 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6109 "description" : "Define a new Orthanc peer, or update an existing one. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6110 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6111 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6112 "description" : "Identifier of the new/updated Orthanc peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6113 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6114 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6115 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6116 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6117 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6118 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6119 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6120 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6121 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6122 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6123 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6124 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6125 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6126 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6127 "CertificateFile" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6128 "description" : "SSL certificate for the HTTPS connections",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6129 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6130 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6131 "CertificateKeyFile" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6132 "description" : "Key file for the SSL certificate for the HTTPS connections",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6133 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6134 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6135 "CertificateKeyPassword" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6136 "description" : "Key password for the SSL certificate for the HTTPS connections",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6137 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6138 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6139 "HttpHeaders" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6140 "description" : "HTTP headers to be used for the connections to the remote peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6141 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6142 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6143 "Password" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6144 "description" : "Password for the credentials",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6145 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6146 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6147 "URL" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6148 "description" : "URL of the root of the REST API of the remote Orthanc peer, for instance `http://localhost:8042/`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6149 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6150 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6151 "Username" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6152 "description" : "Username for the credentials",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6153 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6154 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6155 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6156 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6157 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6158 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6159 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6160 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6161 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6162 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6163 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6164 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6165 "summary" : "Update Orthanc peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6166 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6167 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6168 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6169 "/peers/{id}/configuration" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6170 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6171 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6172 "description" : "Get detailed information about the configuration of some Orthanc peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6173 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6174 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6175 "description" : "Identifier of the peer of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6176 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6177 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6178 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6179 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6180 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6181 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6182 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6183 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6184 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6185 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6186 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6187 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6188 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6189 "description" : "Configuration of the peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6190 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6191 "HttpHeaders" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6192 "Password" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6193 "Pkcs11" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6194 "Url" : "http://127.0.1.1:5000/",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6195 "Username" : "alice"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6196 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6197 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6198 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6199 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6200 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6201 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6202 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6203 "summary" : "Get peer configuration",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6204 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6205 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6206 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6207 "/peers/{id}/store" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6208 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6209 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6210 "description" : "Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#sending-one-resource",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6211 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6212 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6213 "description" : "Identifier of the modality of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6214 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6215 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6216 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6217 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6218 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6219 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6220 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6221 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6222 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6223 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6224 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6225 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6226 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6227 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6228 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6229 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6230 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6231 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6232 "Compress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6233 "description" : "Whether to compress the DICOM instances using gzip before the actual sending",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6234 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6235 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6236 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6237 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6238 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6239 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6240 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6241 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6242 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6243 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6244 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6245 "description" : "List of the Orthanc identifiers of all the DICOM resources to be sent",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6246 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6247 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6248 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6249 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6250 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6251 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6252 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6253 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6254 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6255 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6256 "description" : "Transcode to the provided DICOM transfer syntax before the actual sending",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6257 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6258 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6259 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6260 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6261 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6262 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6263 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6264 "description" : "The Orthanc identifier of one resource to be sent"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6265 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6266 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6267 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6268 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6269 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6270 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6271 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6272 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6273 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6274 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6275 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6276 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6277 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6278 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6279 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6280 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6281 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6282 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6283 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6284 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6285 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6286 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6287 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6288 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6289 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6290 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6291 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6292 "summary" : "Send to Orthanc peer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6293 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6294 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6295 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6296 "/peers/{id}/system" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6297 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6298 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6299 "description" : "Get system information about some Orthanc peer. This corresponds to doing a `GET` request against the `/system` URI of the remote peer. This route can be used to test connectivity.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6300 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6301 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6302 "description" : "Identifier of the peer of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6303 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6304 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6305 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6306 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6307 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6308 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6309 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6310 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6311 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6312 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6313 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6314 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6315 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6316 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6317 "description" : "System information about the peer"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6318 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6319 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6320 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6321 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6322 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6323 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6324 "summary" : "Get peer system information",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6325 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6326 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6327 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6328 "/plugins" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6329 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6330 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6331 "description" : "List all the installed plugins",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6332 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6333 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6334 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6335 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6336 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6337 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6338 "description" : "JSON array containing the identifiers of the installed plugins",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6339 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6340 "explorer.js",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6341 "authorization",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6342 "connectivity-checks",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6343 "dicom-web",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6344 "gdcm",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6345 "mysql-index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6346 "mysql-storage",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6347 "postgresql-index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6348 "postgresql-storage",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6349 "serve-folders",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6350 "stone-webviewer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6351 "transfers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6352 "web-viewer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6353 "worklists",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6354 "wsi"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6355 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6356 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6357 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6358 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6359 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6360 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6361 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6362 "summary" : "List plugins",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6363 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6364 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6365 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6366 "/plugins/explorer.js" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6367 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6368 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6369 "description" : "Get the JavaScript extensions that are installed by all the plugins using the `OrthancPluginExtendOrthancExplorer()` function of the plugin SDK. This route is for internal use of Orthanc Explorer.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6370 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6371 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6372 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6373 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6374 "application/javascript" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6375 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6376 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6377 "description" : "The JavaScript extensions"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6378 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6379 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6380 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6381 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6382 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6383 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6384 "summary" : "JavaScript extensions to Orthanc Explorer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6385 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6386 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6387 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6388 "/plugins/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6389 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6390 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6391 "description" : "Get system information about the plugin whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6392 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6393 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6394 "description" : "Identifier of the job of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6395 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6396 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6397 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6398 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6399 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6400 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6401 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6402 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6403 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6404 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6405 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6406 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6407 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6408 "description" : "JSON object containing information about the plugin",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6409 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6410 "Description" : "Implementation of DICOMweb (QIDO-RS, STOW-RS and WADO-RS) and WADO-URI.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6411 "ExtendsOrthancExplorer" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6412 "ID" : "dicom-web",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6413 "RootUri" : "../dicom-web/app/client/index.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6414 "Version" : "1.4"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6415 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6416 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6417 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6418 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6419 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6420 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6421 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6422 "summary" : "Get plugin",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6423 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6424 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6425 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6426 "/queries" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6427 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6428 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6429 "description" : "List the identifiers of all the query/retrieve operations on DICOM modalities, as initiated by calls to `/modalities/{id}/query`. The length of this list is bounded by the `QueryRetrieveSize` configuration option of Orthanc. https://book.orthanc-server.com/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6430 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6431 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6432 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6433 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6434 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6435 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6436 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6437 "description" : "JSON array containing the identifiers"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6438 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6439 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6440 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6441 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6442 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6443 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6444 "summary" : "List query/retrieve operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6445 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6446 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6447 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6448 "/queries/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6449 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6450 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6451 "description" : "Delete the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6452 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6453 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6454 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6455 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6456 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6457 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6458 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6459 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6460 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6461 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6462 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6463 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6464 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6465 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6466 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6467 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6468 "summary" : "Delete a query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6469 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6470 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6471 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6472 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6473 "description" : "List the available operations for the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6474 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6475 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6476 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6477 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6478 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6479 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6480 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6481 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6482 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6483 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6484 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6485 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6486 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6487 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6488 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6489 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6490 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6491 "description" : "JSON array containing the list of operations"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6492 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6493 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6494 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6495 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6496 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6497 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6498 "summary" : "List operations on a query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6499 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6500 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6501 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6502 "/queries/{id}/answers" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6503 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6504 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6505 "description" : "List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6506 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6507 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6508 "description" : "If present, retrieve detailed information about the individual answers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6509 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6510 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6511 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6512 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6513 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6514 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6515 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6516 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6517 "description" : "If present and if `expand` is present, format the tags of the answers in human-readable format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6518 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6519 "name" : "simplify",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6520 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6521 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6522 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6523 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6524 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6525 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6526 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6527 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6528 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6529 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6530 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6531 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6532 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6533 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6534 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6535 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6536 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6537 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6538 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6539 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6540 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6541 "description" : "JSON array containing the indices of the answers, or detailed information about the reported answers (if `expand` argument is provided)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6542 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6543 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6544 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6545 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6546 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6547 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6548 "summary" : "List answers to a query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6549 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6550 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6551 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6552 "/queries/{id}/answers/{index}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6553 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6554 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6555 "description" : "List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6556 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6557 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6558 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6559 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6560 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6561 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6562 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6563 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6564 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6565 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6566 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6567 "description" : "Index of the answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6568 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6569 "name" : "index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6570 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6571 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6572 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6573 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6574 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6575 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6576 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6577 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6578 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6579 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6580 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6581 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6582 "description" : "JSON array containing the list of operations"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6583 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6584 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6585 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6586 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6587 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6588 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6589 "summary" : "List operations on an answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6590 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6591 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6592 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6593 "/queries/{id}/answers/{index}/content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6594 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6595 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6596 "description" : "Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6597 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6598 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6599 "description" : "If present, format the tags of the answer in human-readable format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6600 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6601 "name" : "simplify",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6602 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6603 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6604 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6605 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6606 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6607 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6608 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6609 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6610 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6611 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6612 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6613 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6614 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6615 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6616 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6617 "description" : "Index of the answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6618 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6619 "name" : "index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6620 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6621 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6622 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6623 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6624 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6625 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6626 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6627 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6628 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6629 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6630 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6631 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6632 "description" : "JSON object containing the DICOM tags of the answer"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6633 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6634 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6635 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6636 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6637 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6638 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6639 "summary" : "Get one answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6640 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6641 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6642 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6643 "/queries/{id}/answers/{index}/query-instances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6644 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6645 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6646 "description" : "Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6647 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6648 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6649 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6650 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6651 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6652 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6653 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6654 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6655 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6656 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6657 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6658 "description" : "Index of the answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6659 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6660 "name" : "index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6661 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6662 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6663 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6664 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6665 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6666 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6667 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6668 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6669 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6670 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6671 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6672 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6673 "Query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6674 "description" : "Associative array containing the filter on the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6675 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6676 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6677 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6678 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6679 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6680 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6681 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6682 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6683 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6684 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6685 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6686 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6687 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6688 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6689 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6690 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6691 "description" : "Identifier of the query, to be used with `/queries/{id}`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6692 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6693 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6694 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6695 "description" : "Root path to the query in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6696 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6697 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6698 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6699 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6700 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6701 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6702 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6703 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6704 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6705 "summary" : "Query the child instances of an answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6706 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6707 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6708 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6709 "/queries/{id}/answers/{index}/query-series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6710 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6711 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6712 "description" : "Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6713 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6714 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6715 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6716 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6717 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6718 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6719 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6720 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6721 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6722 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6723 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6724 "description" : "Index of the answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6725 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6726 "name" : "index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6727 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6728 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6729 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6730 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6731 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6732 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6733 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6734 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6735 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6736 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6737 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6738 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6739 "Query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6740 "description" : "Associative array containing the filter on the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6741 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6742 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6743 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6744 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6745 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6746 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6747 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6748 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6749 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6750 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6751 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6752 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6753 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6754 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6755 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6756 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6757 "description" : "Identifier of the query, to be used with `/queries/{id}`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6758 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6759 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6760 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6761 "description" : "Root path to the query in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6762 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6763 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6764 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6765 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6766 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6767 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6768 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6769 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6770 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6771 "summary" : "Query the child series of an answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6772 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6773 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6774 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6775 "/queries/{id}/answers/{index}/query-studies" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6776 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6777 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6778 "description" : "Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6779 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6780 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6781 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6782 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6783 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6784 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6785 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6786 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6787 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6788 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6789 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6790 "description" : "Index of the answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6791 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6792 "name" : "index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6793 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6794 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6795 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6796 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6797 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6798 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6799 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6800 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6801 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6802 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6803 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6804 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6805 "Query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6806 "description" : "Associative array containing the filter on the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6807 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6808 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6809 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6810 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6811 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6812 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6813 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6814 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6815 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6816 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6817 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6818 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6819 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6820 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6821 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6822 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6823 "description" : "Identifier of the query, to be used with `/queries/{id}`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6824 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6825 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6826 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6827 "description" : "Root path to the query in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6828 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6829 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6830 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6831 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6832 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6833 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6834 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6835 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6836 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6837 "summary" : "Query the child studies of an answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6838 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6839 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6840 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6841 "/queries/{id}/answers/{index}/retrieve" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6842 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6843 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6844 "description" : "Start a C-MOVE SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6845 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6846 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6847 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6848 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6849 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6850 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6851 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6852 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6853 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6854 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6855 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6856 "description" : "Index of the answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6857 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6858 "name" : "index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6859 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6860 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6861 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6862 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6863 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6864 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6865 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6866 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6867 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6868 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6869 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6870 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6871 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6872 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6873 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6874 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6875 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6876 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6877 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6878 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6879 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6880 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6881 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6882 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6883 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6884 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6885 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6886 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6887 "TargetAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6888 "description" : "AET of the target modality. By default, the AET of Orthanc is used, as defined in the `DicomAet` configuration option.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6889 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6890 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6891 "Timeout" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6892 "description" : "Timeout for the C-MOVE command, in seconds",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6893 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6894 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6895 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6896 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6897 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6898 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6899 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6900 "description" : "AET of the target modality"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6901 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6902 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6903 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6904 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6905 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6906 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6907 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6908 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6909 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6910 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6911 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6912 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6913 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6914 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6915 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6916 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6917 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6918 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6919 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6920 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6921 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6922 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6923 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6924 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6925 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6926 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6927 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6928 "summary" : "Retrieve one answer",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6929 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6930 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6931 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6932 "/queries/{id}/level" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6933 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6934 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6935 "description" : "Get the query level (value of the `QueryRetrieveLevel` tag) of the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6936 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6937 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6938 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6939 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6940 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6941 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6942 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6943 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6944 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6945 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6946 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6947 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6948 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6949 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6950 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6951 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6952 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6953 "description" : "The level"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6954 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6955 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6956 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6957 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6958 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6959 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6960 "summary" : "Get level of original query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6961 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6962 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6963 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6964 "/queries/{id}/modality" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6965 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6966 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6967 "description" : "Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6968 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6969 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6970 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6971 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6972 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6973 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6974 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6975 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6976 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6977 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6978 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6979 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6980 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6981 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6982 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6983 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6984 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6985 "description" : "The identifier of the DICOM modality"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6986 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6987 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6988 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6989 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6990 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6991 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6992 "summary" : "Get modality of original query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6993 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6994 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6995 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6996 "/queries/{id}/query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6997 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6998 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6999 "description" : "Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7000 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7001 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7002 "description" : "If present, format the tags of the DICOM filter in human-readable format",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7003 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7004 "name" : "simplify",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7005 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7006 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7007 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7008 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7009 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7010 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7011 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7012 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7013 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7014 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7015 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7016 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7017 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7018 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7019 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7020 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7021 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7022 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7023 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7024 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7025 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7026 "description" : "Content of the original query"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7027 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7028 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7029 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7030 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7031 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7032 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7033 "summary" : "Get original query arguments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7034 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7035 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7036 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7037 "/queries/{id}/retrieve" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7038 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7039 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7040 "description" : "Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7041 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7042 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7043 "description" : "Identifier of the query of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7044 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7045 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7046 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7047 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7048 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7049 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7050 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7051 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7052 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7053 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7054 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7055 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7056 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7057 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7058 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7059 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7060 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7061 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7062 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7063 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7064 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7065 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7066 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7067 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7068 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7069 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7070 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7071 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7072 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7073 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7074 "TargetAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7075 "description" : "AET of the target modality. By default, the AET of Orthanc is used, as defined in the `DicomAet` configuration option.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7076 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7077 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7078 "Timeout" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7079 "description" : "Timeout for the C-MOVE command, in seconds",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7080 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7081 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7082 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7083 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7084 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7085 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7086 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7087 "description" : "AET of the target modality"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7088 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7089 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7090 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7091 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7092 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7093 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7094 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7095 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7096 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7097 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7098 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7099 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7100 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7101 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7102 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7103 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7104 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7105 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7106 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7107 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7108 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7109 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7110 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7111 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7112 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7113 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7114 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7115 "summary" : "Retrieve all answers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7116 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7117 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7118 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7119 "/series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7120 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7121 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7122 "description" : "List the Orthanc identifiers of all the available DICOM series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7123 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7124 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7125 "description" : "If present, retrieve detailed information about the individual series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7126 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7127 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7128 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7129 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7130 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7131 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7132 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7133 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7134 "description" : "Limit the number of results",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7135 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7136 "name" : "limit",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7137 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7138 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7139 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7140 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7141 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7142 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7143 "description" : "Show only the resources since the provided index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7144 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7145 "name" : "since",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7146 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7147 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7148 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7149 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7150 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7151 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7152 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7153 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7154 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7155 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7156 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7157 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported series (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7158 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7159 "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7160 "7124dba7-09803f33-98b73826-33f14632-ea842d29"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7161 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7162 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7163 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7164 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7165 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7166 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7167 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7168 "summary" : "List the available series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7169 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7170 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7171 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7172 "/series/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7173 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7174 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7175 "description" : "Delete the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7176 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7177 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7178 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7179 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7180 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7181 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7182 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7183 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7184 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7185 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7186 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7187 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7188 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7189 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7190 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7191 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7192 "summary" : "Delete some series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7193 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7194 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7195 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7196 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7197 "description" : "Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7198 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7199 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7200 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7201 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7202 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7203 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7204 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7205 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7206 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7207 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7208 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7209 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7210 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7211 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7212 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7213 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7214 "description" : "Information about the DICOM series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7215 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7216 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7217 "ID" : "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7218 "Instances" : [ "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f" ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7219 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7220 "LastUpdate" : "20180414T091542",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7221 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7222 "ImageOrientationPatient" : "0\\1\\0\\0\\0\\-1",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7223 "Manufacturer" : "Philips",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7224 "Modality" : "CT",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7225 "PerformedProcedureStepDescription" : "CT2 tête, face, sinus",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7226 "ProtocolName" : "COU 2 mm/Neck/Sv",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7227 "SeriesInstanceUID" : "1.2.840.113704.1.111.5692.1127828999.2",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7228 "SeriesNumber" : "2276",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7229 "StationName" : "ctrad"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7230 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7231 "ParentStudy" : "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7232 "Status" : "Unknown",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7233 "Type" : "Series"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7234 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7235 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7236 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7237 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7238 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7239 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7240 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7241 "summary" : "Get information about some series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7242 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7243 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7244 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7245 "/series/{id}/anonymize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7246 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7247 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7248 "description" : "Start a job that will anonymize all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7249 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7250 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7251 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7252 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7253 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7254 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7255 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7256 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7257 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7258 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7259 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7260 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7261 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7262 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7263 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7264 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7265 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7266 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7267 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7268 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7269 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7270 "DicomVersion" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7271 "description" : "Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7272 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7273 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7274 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7275 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7276 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7277 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7278 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7279 "description" : "List of DICOM tags whose value must not be destroyed by the anonymization",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7280 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7281 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7282 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7283 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7284 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7285 "KeepPrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7286 "description" : "Keep the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7287 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7288 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7289 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7290 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7291 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7292 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7293 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7294 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7295 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7296 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7297 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7298 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7299 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7300 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7301 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7302 "description" : "List of additional tags to be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7303 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7304 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7305 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7306 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7307 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7308 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7309 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7310 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7311 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7312 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7313 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7314 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7315 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7316 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7317 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7318 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7319 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7320 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7321 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7322 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7323 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7324 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7325 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7326 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7327 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7328 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7329 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7330 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7331 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7332 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7333 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7334 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7335 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7336 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7337 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7338 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7339 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7340 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7341 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7342 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7343 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7344 "summary" : "Anonymize series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7345 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7346 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7347 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7348 "/series/{id}/archive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7349 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7350 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7351 "description" : "Synchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7352 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7353 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7354 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7355 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7356 "name" : "transcode",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7357 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7358 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7359 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7360 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7361 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7362 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7363 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7364 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7365 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7366 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7367 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7368 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7369 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7370 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7371 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7372 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7373 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7374 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7375 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7376 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7377 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7378 "description" : "ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7379 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7380 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7381 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7382 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7383 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7384 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7385 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7386 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7387 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7388 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7389 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7390 "description" : "Create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7391 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7392 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7393 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7394 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7395 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7396 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7397 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7398 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7399 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7400 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7401 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7402 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7403 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7404 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7405 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7406 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7407 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7408 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7409 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7410 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7411 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7412 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7413 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7414 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7415 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7416 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7417 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7418 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7419 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7420 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7421 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7422 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7423 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7424 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7425 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7426 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7427 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7428 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7429 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7430 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7431 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7432 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7433 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7434 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7435 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7436 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7437 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7438 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7439 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7440 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7441 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7442 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7443 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7444 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7445 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7446 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7447 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7448 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7449 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7450 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7451 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7452 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7453 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7454 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7455 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7456 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7457 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7458 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7459 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7460 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7461 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7462 "/series/{id}/attachments" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7463 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7464 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7465 "description" : "Get the list of attachments that are associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7466 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7467 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7468 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7469 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7470 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7471 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7472 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7473 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7474 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7475 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7476 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7477 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7478 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7479 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7480 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7481 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7482 "description" : "JSON array containing the names of the attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7483 "example" : []
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7484 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7485 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7486 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7487 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7488 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7489 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7490 "summary" : "List attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7491 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7492 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7493 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7494 "/series/{id}/attachments/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7495 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7496 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7497 "description" : "Delete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7498 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7499 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7500 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7501 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7502 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7503 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7504 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7505 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7506 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7507 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7508 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7509 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7510 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7511 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7512 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7513 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7514 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7515 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7516 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7517 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7518 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7519 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7520 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7521 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7522 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7523 "summary" : "Delete attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7524 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7525 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7526 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7527 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7528 "description" : "Get the list of the operations that are available for attachments associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7529 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7530 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7531 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7532 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7533 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7534 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7535 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7536 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7537 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7538 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7539 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7540 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7541 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7542 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7543 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7544 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7545 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7546 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7547 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7548 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7549 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7550 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7551 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7552 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7553 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7554 "description" : "List of the available operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7555 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7556 "compress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7557 "compressed-data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7558 "compressed-md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7559 "compressed-size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7560 "data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7561 "is-compressed",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7562 "md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7563 "size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7564 "uncompress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7565 "verify-md5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7566 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7567 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7568 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7569 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7570 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7571 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7572 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7573 "summary" : "List operations on attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7574 "tags" : [ "Other" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7575 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7576 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7577 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7578 "description" : "Attach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7579 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7580 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7581 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7582 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7583 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7584 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7585 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7586 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7587 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7588 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7589 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7590 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7591 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7592 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7593 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7594 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7595 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7596 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7597 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7598 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7599 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7600 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7601 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7602 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7603 "description" : "Binary data containing the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7604 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7605 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7606 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7607 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7608 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7609 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7610 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7611 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7612 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7613 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7614 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7615 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7616 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7617 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7618 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7619 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7620 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7621 "summary" : "Set attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7622 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7623 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7624 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7625 "/series/{id}/attachments/{name}/compress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7626 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7627 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7628 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7629 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7630 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7631 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7632 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7633 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7634 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7635 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7636 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7637 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7638 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7639 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7640 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7641 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7642 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7643 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7644 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7645 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7646 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7647 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7648 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7649 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7650 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7651 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7652 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7653 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7654 "summary" : "Compress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7655 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7656 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7657 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7658 "/series/{id}/attachments/{name}/compressed-data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7659 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7660 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7661 "description" : "Get the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7662 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7663 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7664 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7665 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7666 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7667 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7668 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7669 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7670 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7671 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7672 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7673 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7674 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7675 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7676 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7677 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7678 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7679 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7680 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7681 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7682 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7683 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7684 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7685 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7686 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7687 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7688 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7689 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7690 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7691 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7692 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7693 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7694 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7695 "summary" : "Get attachment (no decompression)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7696 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7697 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7698 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7699 "/series/{id}/attachments/{name}/compressed-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7700 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7701 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7702 "description" : "Get the MD5 hash of one attachment associated with the given series, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7703 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7704 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7705 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7706 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7707 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7708 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7709 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7710 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7711 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7712 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7713 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7714 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7715 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7716 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7717 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7718 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7719 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7720 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7721 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7722 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7723 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7724 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7725 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7726 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7727 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7728 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7729 "description" : "The MD5 of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7730 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7731 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7732 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7733 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7734 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7735 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7736 "summary" : "Get MD5 of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7737 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7738 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7739 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7740 "/series/{id}/attachments/{name}/compressed-size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7741 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7742 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7743 "description" : "Get the size of one attachment associated with the given series, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7744 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7745 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7746 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7747 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7748 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7749 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7750 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7751 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7752 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7753 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7754 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7755 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7756 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7757 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7758 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7759 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7760 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7761 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7762 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7763 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7764 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7765 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7766 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7767 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7768 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7769 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7770 "description" : "The size of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7771 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7772 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7773 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7774 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7775 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7776 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7777 "summary" : "Get size of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7778 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7779 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7780 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7781 "/series/{id}/attachments/{name}/data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7782 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7783 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7784 "description" : "Get the (binary) content of one attachment associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7785 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7786 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7787 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7788 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7789 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7790 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7791 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7792 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7793 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7794 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7795 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7796 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7797 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7798 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7799 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7800 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7801 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7802 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7803 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7804 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7805 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7806 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7807 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7808 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7809 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7810 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7811 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7812 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7813 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7814 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7815 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7816 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7817 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7818 "summary" : "Get attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7819 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7820 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7821 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7822 "/series/{id}/attachments/{name}/is-compressed" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7823 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7824 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7825 "description" : "Test whether the attachment has been stored as a compressed file on the disk.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7826 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7827 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7828 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7829 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7830 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7831 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7832 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7833 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7834 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7835 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7836 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7837 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7838 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7839 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7840 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7841 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7842 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7843 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7844 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7845 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7846 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7847 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7848 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7849 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7850 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7851 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7852 "description" : "`0` if the attachment was stored uncompressed, `1` if it was compressed"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7853 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7854 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7855 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7856 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7857 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7858 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7859 "summary" : "Is attachment compressed?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7860 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7861 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7862 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7863 "/series/{id}/attachments/{name}/md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7864 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7865 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7866 "description" : "Get the MD5 hash of one attachment associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7867 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7868 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7869 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7870 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7871 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7872 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7873 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7874 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7875 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7876 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7877 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7878 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7879 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7880 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7881 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7882 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7883 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7884 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7885 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7886 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7887 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7888 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7889 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7890 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7891 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7892 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7893 "description" : "The MD5 of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7894 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7895 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7896 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7897 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7898 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7899 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7900 "summary" : "Get MD5 of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7901 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7902 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7903 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7904 "/series/{id}/attachments/{name}/size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7905 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7906 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7907 "description" : "Get the size of one attachment associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7908 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7909 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7910 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7911 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7912 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7913 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7914 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7915 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7916 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7917 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7918 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7919 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7920 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7921 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7922 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7923 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7924 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7925 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7926 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7927 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7928 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7929 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7930 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7931 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7932 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7933 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7934 "description" : "The size of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7935 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7936 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7937 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7938 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7939 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7940 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7941 "summary" : "Get size of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7942 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7943 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7944 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7945 "/series/{id}/attachments/{name}/uncompress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7946 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7947 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7948 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7949 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7950 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7951 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7952 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7953 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7954 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7955 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7956 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7957 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7958 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7959 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7960 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7961 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7962 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7963 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7964 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7965 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7966 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7967 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7968 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7969 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7970 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7971 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7972 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7973 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7974 "summary" : "Uncompress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7975 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7976 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7977 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7978 "/series/{id}/attachments/{name}/verify-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7979 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7980 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7981 "description" : "Verify that the attachment is not corrupted, by validating its MD5 hash",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7982 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7983 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7984 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7985 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7986 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7987 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7988 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7989 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7990 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7991 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7992 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7993 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7994 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7995 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7996 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7997 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7998 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7999 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8000 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8001 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8002 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8003 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8004 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8005 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8006 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8007 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8008 "description" : "On success, a valid JSON object is returned"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8009 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8010 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8011 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8012 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8013 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8014 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8015 "summary" : "Verify attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8016 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8017 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8018 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8019 "/series/{id}/instances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8020 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8021 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8022 "description" : "Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8023 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8024 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8025 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8026 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8027 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8028 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8029 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8030 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8031 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8032 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8033 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8034 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8035 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8036 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8037 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8038 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8039 "description" : "JSON array containing information about the child DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8040 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8041 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8042 "FileSize" : 368852,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8043 "FileUuid" : "9016272a-ee8c-41b2-afc6-dcfe06dd3be8",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8044 "ID" : "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8045 "IndexInSeries" : 1,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8046 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8047 "ImagePositionPatient" : "0\\-159\\-425.915649",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8048 "InstanceCreationDate" : "20050927",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8049 "InstanceCreationTime" : "155030.000000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8050 "InstanceNumber" : "1",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8051 "SOPInstanceUID" : "1.2.840.113704.7.1.1.6632.1127829031.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8052 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8053 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8054 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8055 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8056 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8057 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8058 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8059 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8060 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8061 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8062 "summary" : "Get child instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8063 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8064 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8065 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8066 "/series/{id}/instances-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8067 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8068 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8069 "description" : "Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8070 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8071 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8072 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8073 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8074 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8075 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8076 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8077 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8078 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8079 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8080 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8081 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8082 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8083 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8084 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8085 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8086 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8087 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8088 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8089 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8090 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8091 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8092 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8093 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8094 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8095 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8096 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8097 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8098 "description" : "JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8099 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8100 "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8101 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8102 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8103 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8104 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8105 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8106 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8107 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8108 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8109 "Value" : "ORIGINAL\\PRIMARY\\LOCALIZER\\ES"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8110 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8111 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8112 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8113 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8114 "Value" : "20050927"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8115 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8116 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8117 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8118 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8119 "Value" : "155030.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8120 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8121 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8122 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8123 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8124 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8125 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8126 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8127 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8128 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8129 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8130 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8131 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8132 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8133 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8134 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8135 "summary" : "Get tags of instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8136 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8137 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8138 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8139 "/series/{id}/media" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8140 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8141 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8142 "description" : "Synchronously create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8143 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8144 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8145 "description" : "If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8146 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8147 "name" : "extended",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8148 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8149 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8150 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8151 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8152 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8153 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8154 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8155 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8156 "name" : "transcode",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8157 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8158 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8159 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8160 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8161 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8162 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8163 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8164 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8165 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8166 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8167 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8168 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8169 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8170 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8171 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8172 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8173 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8174 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8175 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8176 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8177 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8178 "description" : "ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8179 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8180 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8181 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8182 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8183 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8184 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8185 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8186 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8187 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8188 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8189 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8190 "description" : "Create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8191 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8192 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8193 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8194 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8195 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8196 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8197 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8198 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8199 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8200 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8201 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8202 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8203 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8204 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8205 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8206 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8207 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8208 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8209 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8210 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8211 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8212 "Extended" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8213 "description" : "If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8214 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8215 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8216 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8217 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8218 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8219 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8220 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8221 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8222 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8223 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8224 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8225 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8226 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8227 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8228 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8229 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8230 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8231 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8232 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8233 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8234 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8235 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8236 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8237 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8238 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8239 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8240 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8241 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8242 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8243 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8244 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8245 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8246 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8247 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8248 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8249 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8250 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8251 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8252 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8253 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8254 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8255 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8256 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8257 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8258 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8259 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8260 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8261 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8262 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8263 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8264 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8265 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8266 "/series/{id}/metadata" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8267 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8268 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8269 "description" : "Get the list of metadata that are associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8270 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8271 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8272 "description" : "If present, also retrieve the value of the individual metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8273 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8274 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8275 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8276 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8277 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8278 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8279 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8280 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8281 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8282 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8283 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8284 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8285 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8286 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8287 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8288 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8289 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8290 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8291 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8292 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8293 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8294 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8295 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8296 "example" : [ "LastUpdate" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8297 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8298 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8299 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8300 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8301 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8302 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8303 "summary" : "List metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8304 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8305 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8306 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8307 "/series/{id}/metadata/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8308 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8309 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8310 "description" : "Delete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8311 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8312 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8313 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8314 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8315 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8316 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8317 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8318 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8319 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8320 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8321 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8322 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8323 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8324 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8325 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8326 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8327 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8328 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8329 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8330 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8331 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8332 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8333 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8334 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8335 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8336 "summary" : "Delete metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8337 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8338 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8339 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8340 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8341 "description" : "Get the value of a metadata that is associated with the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8342 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8343 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8344 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8345 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8346 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8347 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8348 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8349 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8350 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8351 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8352 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8353 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8354 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8355 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8356 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8357 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8358 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8359 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8360 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8361 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8362 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8363 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8364 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8365 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8366 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8367 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8368 "description" : "Value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8369 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8370 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8371 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8372 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8373 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8374 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8375 "summary" : "Get metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8376 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8377 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8378 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8379 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8380 "description" : "Set the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8381 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8382 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8383 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8384 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8385 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8386 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8387 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8388 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8389 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8390 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8391 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8392 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8393 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8394 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8395 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8396 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8397 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8398 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8399 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8400 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8401 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8402 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8403 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8404 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8405 "description" : "String value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8406 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8407 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8408 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8409 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8410 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8411 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8412 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8413 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8414 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8415 "summary" : "Set metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8416 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8417 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8418 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8419 "/series/{id}/modify" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8420 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8421 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8422 "description" : "Start a job that will modify all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8423 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8424 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8425 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8426 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8427 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8428 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8429 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8430 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8431 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8432 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8433 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8434 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8435 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8436 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8437 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8438 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8439 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8440 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8441 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8442 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8443 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8444 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8445 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8446 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8447 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8448 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8449 "description" : "Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8450 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8451 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8452 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8453 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8454 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8455 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8456 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8457 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8458 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8459 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8460 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8461 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8462 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8463 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8464 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8465 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8466 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8467 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8468 "description" : "List of tags that must be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8469 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8470 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8471 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8472 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8473 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8474 "RemovePrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8475 "description" : "Remove the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8476 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8477 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8478 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8479 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8480 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8481 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8482 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8483 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8484 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8485 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8486 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8487 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8488 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8489 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8490 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8491 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8492 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8493 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8494 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8495 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8496 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8497 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8498 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8499 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8500 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8501 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8502 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8503 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8504 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8505 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8506 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8507 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8508 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8509 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8510 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8511 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8512 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8513 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8514 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8515 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8516 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8517 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8518 "summary" : "Modify series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8519 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8520 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8521 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8522 "/series/{id}/module" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8523 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8524 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8525 "description" : "Get the series module of the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8526 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8527 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8528 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8529 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8530 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8531 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8532 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8533 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8534 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8535 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8536 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8537 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8538 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8539 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8540 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8541 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8542 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8543 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8544 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8545 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8546 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8547 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8548 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8549 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8550 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8551 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8552 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8553 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8554 "description" : "Information about the DICOM series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8555 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8556 "0008,0060" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8557 "Name" : "Modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8558 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8559 "Value" : "CT"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8560 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8561 "0008,1111" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8562 "Name" : "ReferencedPerformedProcedureStepSequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8563 "Type" : "Sequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8564 "Value" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8565 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8566 "0008,1150" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8567 "Name" : "ReferencedSOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8568 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8569 "Value" : "1.2.840.10008.3.1.2.3.3"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8570 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8571 "0008,1155" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8572 "Name" : "ReferencedSOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8573 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8574 "Value" : "1.2.840.113704.1.111.4496.1127828841.54"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8575 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8576 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8577 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8578 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8579 "0018,1030" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8580 "Name" : "ProtocolName",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8581 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8582 "Value" : "COU 2 mm/Neck/Sv"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8583 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8584 "0018,5100" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8585 "Name" : "PatientPosition",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8586 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8587 "Value" : "HFS"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8588 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8589 "0020,000e" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8590 "Name" : "SeriesInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8591 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8592 "Value" : "1.2.840.113704.1.111.5692.1127828999.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8593 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8594 "0020,0011" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8595 "Name" : "SeriesNumber",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8596 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8597 "Value" : "2276"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8598 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8599 "0040,0253" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8600 "Name" : "PerformedProcedureStepID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8601 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8602 "Value" : "A10011234815"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8603 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8604 "0040,0254" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8605 "Name" : "PerformedProcedureStepDescription",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8606 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8607 "Value" : "CT2 tête, face, sinus"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8608 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8609 "0040,0260" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8610 "Name" : "PerformedProtocolCodeSequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8611 "Type" : "Sequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8612 "Value" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8613 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8614 "0008,0100" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8615 "Name" : "CodeValue",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8616 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8617 "Value" : "CTTETE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8618 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8619 "0008,0102" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8620 "Name" : "CodingSchemeDesignator",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8621 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8622 "Value" : "XPLORE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8623 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8624 "0008,0104" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8625 "Name" : "CodeMeaning",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8626 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8627 "Value" : "CT2 tête, face, sinus"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8628 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8629 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8630 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8631 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8632 "0040,0275" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8633 "Name" : "RequestAttributesSequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8634 "Type" : "Sequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8635 "Value" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8636 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8637 "0040,0007" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8638 "Name" : "ScheduledProcedureStepDescription",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8639 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8640 "Value" : "CT2 tête, face, sinus"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8641 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8642 "0040,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8643 "Name" : "ScheduledProtocolCodeSequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8644 "Type" : "Sequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8645 "Value" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8646 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8647 "0008,0100" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8648 "Name" : "CodeValue",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8649 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8650 "Value" : "CTTETE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8651 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8652 "0008,0102" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8653 "Name" : "CodingSchemeDesignator",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8654 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8655 "Value" : "XPLORE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8656 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8657 "0008,0104" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8658 "Name" : "CodeMeaning",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8659 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8660 "Value" : "CT2 TÊTE, FACE, SINUS"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8661 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8662 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8663 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8664 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8665 "0040,0009" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8666 "Name" : "ScheduledProcedureStepID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8667 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8668 "Value" : "A10011234815"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8669 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8670 "0040,1001" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8671 "Name" : "RequestedProcedureID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8672 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8673 "Value" : "A10011234814"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8674 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8675 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8676 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8677 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8678 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8679 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8680 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8681 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8682 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8683 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8684 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8685 "summary" : "Get series module",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8686 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8687 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8688 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8689 "/series/{id}/ordered-slices" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8690 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8691 "deprecated" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8692 "description" : "Sort the instances and frames (slices) of the DICOM series whose Orthanc identifier is provided in the URL. This URI is essentially used by the Orthanc Web viewer and by the Osimis Web viewer.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8693 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8694 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8695 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8696 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8697 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8698 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8699 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8700 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8701 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8702 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8703 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8704 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8705 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8706 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8707 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8708 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8709 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8710 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8711 "Dicom" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8712 "/instances/fa1fc64f-e7a051a7-c1233b31-e19bca08-54629531/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8713 "/instances/f5701efb-98170697-404d15f6-59baf69e-4e8ddfae/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8714 "/instances/3b2a215c-2560d4b0-e3730c07-87d3fa7d-3fef44ed/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8715 "/instances/6059d07c-02ae8c74-9436dc7c-007b4d5d-4c770a30/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8716 "/instances/99264275-213c3190-73251bdc-97ccfdb4-1f9656d9/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8717 "/instances/40df6ac1-5ec86316-035ff3c1-07e5c8a8-f6cbd37c/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8718 "/instances/08ff3a1a-c8fb57d9-4e24d9cb-2ed22b80-0ff7461e/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8719 "/instances/6fe353dd-544ce7af-58ce22dd-ab67370c-873330fc/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8720 "/instances/3ad70bbe-bc51faff-860461d2-44745ccf-0ebbbbc8/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8721 "/instances/9058e01a-31a7d982-1691e575-a8607d94-29a9aaca/file",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8722 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8723 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8724 "Slices" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8725 "/instances/fa1fc64f-e7a051a7-c1233b31-e19bca08-54629531/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8726 "/instances/f5701efb-98170697-404d15f6-59baf69e-4e8ddfae/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8727 "/instances/3b2a215c-2560d4b0-e3730c07-87d3fa7d-3fef44ed/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8728 "/instances/6059d07c-02ae8c74-9436dc7c-007b4d5d-4c770a30/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8729 "/instances/99264275-213c3190-73251bdc-97ccfdb4-1f9656d9/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8730 "/instances/40df6ac1-5ec86316-035ff3c1-07e5c8a8-f6cbd37c/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8731 "/instances/08ff3a1a-c8fb57d9-4e24d9cb-2ed22b80-0ff7461e/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8732 "/instances/6fe353dd-544ce7af-58ce22dd-ab67370c-873330fc/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8733 "/instances/3ad70bbe-bc51faff-860461d2-44745ccf-0ebbbbc8/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8734 "/instances/9058e01a-31a7d982-1691e575-a8607d94-29a9aaca/frames/0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8735 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8736 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8737 "SlicesShort" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8738 [ "fa1fc64f-e7a051a7-c1233b31-e19bca08-54629531", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8739 [ "f5701efb-98170697-404d15f6-59baf69e-4e8ddfae", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8740 [ "3b2a215c-2560d4b0-e3730c07-87d3fa7d-3fef44ed", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8741 [ "6059d07c-02ae8c74-9436dc7c-007b4d5d-4c770a30", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8742 [ "99264275-213c3190-73251bdc-97ccfdb4-1f9656d9", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8743 [ "40df6ac1-5ec86316-035ff3c1-07e5c8a8-f6cbd37c", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8744 [ "08ff3a1a-c8fb57d9-4e24d9cb-2ed22b80-0ff7461e", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8745 [ "6fe353dd-544ce7af-58ce22dd-ab67370c-873330fc", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8746 [ "3ad70bbe-bc51faff-860461d2-44745ccf-0ebbbbc8", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8747 [ "9058e01a-31a7d982-1691e575-a8607d94-29a9aaca", 0, 1 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8748 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8749 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8750 "Type" : "Volume"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8751 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8752 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8753 "Dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8754 "description" : "Ordered list of paths to DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8755 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8756 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8757 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8758 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8759 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8760 "Slices" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8761 "description" : "Ordered list of paths to frames. It is recommended to use this field, as it is also valid in the case of multiframe images.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8762 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8763 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8764 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8765 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8766 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8767 "SlicesShort" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8768 "description" : "Same information as the `Slices` field, but in a compact form",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8769 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8770 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8771 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8772 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8773 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8774 "Type" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8775 "description" : "Can be `Volume` (for 3D volumes) or `Sequence` (notably for cine images)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8776 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8777 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8778 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8779 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8780 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8781 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8782 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8783 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8784 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8785 "summary" : "Order the slices",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8786 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8787 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8788 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8789 "/series/{id}/patient" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8790 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8791 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8792 "description" : "Get detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8793 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8794 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8795 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8796 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8797 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8798 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8799 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8800 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8801 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8802 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8803 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8804 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8805 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8806 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8807 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8808 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8809 "description" : "Information about the parent DICOM patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8810 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8811 "ID" : "2f74083e-9b042648-10edac14-b26950f8-f82ec3a0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8812 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8813 "LastUpdate" : "20180414T091601",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8814 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8815 "PatientBirthDate" : "19910101",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8816 "PatientID" : "Vafk,T,6",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8817 "PatientName" : "PHENIX",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8818 "PatientSex" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8819 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8820 "Studies" : [ "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a" ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8821 "Type" : "Patient"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8822 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8823 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8824 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8825 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8826 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8827 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8828 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8829 "summary" : "Get parent patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8830 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8831 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8832 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8833 "/series/{id}/reconstruct" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8834 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8835 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8836 "description" : "Reconstruct the main DICOM tags of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8837 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8838 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8839 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8840 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8841 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8842 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8843 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8844 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8845 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8846 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8847 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8848 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8849 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8850 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8851 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8852 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8853 "summary" : "Reconstruct tags of series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8854 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8855 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8856 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8857 "/series/{id}/shared-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8858 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8859 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8860 "description" : "Extract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8861 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8862 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8863 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8864 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8865 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8866 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8867 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8868 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8869 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8870 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8871 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8872 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8873 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8874 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8875 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8876 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8877 "description" : "JSON object containing the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8878 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8879 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8880 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8881 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8882 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8883 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8884 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8885 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8886 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8887 "Value" : "ORIGINAL\\PRIMARY\\LOCALIZER\\ES"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8888 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8889 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8890 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8891 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8892 "Value" : "20050927"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8893 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8894 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8895 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8896 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8897 "Value" : "155030.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8898 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8899 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8900 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8901 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8902 "Value" : "1.2.840.10008.5.1.4.1.1.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8903 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8904 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8905 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8906 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8907 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8908 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8909 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8910 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8911 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8912 "summary" : "Get shared tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8913 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8914 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8915 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8916 "/series/{id}/statistics" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8917 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8918 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8919 "description" : "Get statistics about the given series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8920 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8921 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8922 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8923 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8924 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8925 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8926 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8927 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8928 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8929 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8930 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8931 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8932 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8933 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8934 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8935 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8936 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8937 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8938 "CountInstances" : 1,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8939 "DicomDiskSize" : "368852",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8940 "DicomDiskSizeMB" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8941 "DicomUncompressedSize" : "368852",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8942 "DicomUncompressedSizeMB" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8943 "DiskSize" : "381000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8944 "DiskSizeMB" : 0,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8945 "UncompressedSize" : "381000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8946 "UncompressedSizeMB" : 0
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8947 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8948 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8949 "CountInstances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8950 "description" : "Number of child instances within this series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8951 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8952 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8953 "DicomDiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8954 "description" : "Size on the disk of the DICOM instances associated with the series, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8955 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8956 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8957 "DicomDiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8958 "description" : "Size on the disk of the DICOM instances associated with the series, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8959 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8960 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8961 "DicomUncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8962 "description" : "Size on the disk of the uncompressed DICOM instances associated with the series, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8963 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8964 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8965 "DicomUncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8966 "description" : "Size on the disk of the uncompressed DICOM instances associated with the series, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8967 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8968 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8969 "DiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8970 "description" : "Size of the series on the disk in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8971 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8972 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8973 "DiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8974 "description" : "Size of the series on the disk, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8975 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8976 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8977 "UncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8978 "description" : "Size of the series after decompression in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8979 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8980 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8981 "UncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8982 "description" : "Size of the series after decompression, expressed in megabytes (MB). This is different from `DiskSizeMB` iff `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8983 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8984 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8985 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8986 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8987 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8988 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8989 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8990 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8991 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8992 "summary" : "Get series statistics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8993 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8994 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8995 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8996 "/series/{id}/study" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8997 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8998 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8999 "description" : "Get detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9000 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9001 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9002 "description" : "Orthanc identifier of the series of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9003 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9004 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9005 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9006 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9007 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9008 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9009 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9010 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9011 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9012 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9013 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9014 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9015 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9016 "description" : "Information about the parent DICOM study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9017 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9018 "ID" : "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9019 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9020 "LastUpdate" : "20180414T091601",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9021 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9022 "AccessionNumber" : "A10011234814",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9023 "InstitutionName" : "HUG",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9024 "ReferringPhysicianName" : "CHIR-PED^CHIR-PE",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9025 "RequestedProcedureDescription" : "CT2 TÊTE, FACE, SINUS",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9026 "RequestingPhysician" : "KOHLER^Romain",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9027 "StudyDate" : "20050927",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9028 "StudyDescription" : "CT2 tête, face, sinus",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9029 "StudyID" : "1361",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9030 "StudyInstanceUID" : "2.16.840.1.113669.632.20.1211.10000098591",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9031 "StudyTime" : "154952.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9032 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9033 "ParentPatient" : "2f74083e-9b042648-10edac14-b26950f8-f82ec3a0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9034 "PatientMainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9035 "PatientBirthDate" : "19910101",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9036 "PatientID" : "Vafk,T,6",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9037 "PatientName" : "PHENIX",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9038 "PatientSex" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9039 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9040 "Series" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9041 "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9042 "7696013f-4c89c563-2b071693-5d1f97f6-f8ab232d",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9043 "17cc7e52-4f1a3e4d-9182f727-56e9cc71-c037892f"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9044 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9045 "Type" : "Study"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9046 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9047 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9048 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9049 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9050 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9051 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9052 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9053 "summary" : "Get parent study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9054 "tags" : [ "Series" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9055 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9056 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9057 "/statistics" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9058 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9059 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9060 "description" : "Get statistics related to the database of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9061 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9062 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9063 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9064 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9065 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9066 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9067 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9068 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9069 "CountInstances" : 2552,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9070 "CountPatients" : 8,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9071 "CountSeries" : 26,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9072 "CountStudies" : 8,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9073 "TotalDiskSize" : "1068132148",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9074 "TotalDiskSizeMB" : 1018,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9075 "TotalUncompressedSize" : "1068132148",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9076 "TotalUncompressedSizeMB" : 1018
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9077 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9078 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9079 "CountInstances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9080 "description" : "Number of DICOM instances stored in Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9081 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9082 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9083 "CountPatients" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9084 "description" : "Number of patients stored in Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9085 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9086 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9087 "CountSeries" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9088 "description" : "Number of DICOM series stored in Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9089 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9090 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9091 "CountStudies" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9092 "description" : "Number of DICOM studies stored in Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9093 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9094 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9095 "TotalDiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9096 "description" : "Size of the storage area (in bytes)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9097 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9098 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9099 "TotalDiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9100 "description" : "Size of the storage area (in megabytes)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9101 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9102 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9103 "TotalUncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9104 "description" : "Total size of all the files once uncompressed (in bytes). This corresponds to `TotalDiskSize` if no compression is enabled, cf. `StorageCompression` configuration option",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9105 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9106 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9107 "TotalUncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9108 "description" : "Total size of all the files once uncompressed (in megabytes)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9109 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9110 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9111 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9112 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9113 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9114 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9115 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9116 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9117 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9118 "summary" : "Get database statistics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9119 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9120 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9121 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9122 "/storage-commitment/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9123 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9124 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9125 "description" : "Get the storage commitment report whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9126 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9127 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9128 "description" : "Identifier of the storage commitment report",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9129 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9130 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9131 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9132 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9133 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9134 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9135 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9136 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9137 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9138 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9139 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9140 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9141 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9142 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9143 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9144 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9145 "Failures" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9146 "description" : "List of failures that have been encountered during the storage commitment request",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9147 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9148 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9149 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9150 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9151 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9152 "RemoteAET" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9153 "description" : "AET of the remote DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9154 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9155 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9156 "Status" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9157 "description" : "Can be `Success`, `Failure`, or `Pending` (the latter means that no report has been received yet)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9158 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9159 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9160 "Success" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9161 "description" : "List of DICOM instances that have been acknowledged by the remote modality, each one is reported as a JSON object containing the `SOPClassUID` and `SOPInstanceUID` DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9162 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9163 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9164 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9165 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9166 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9167 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9168 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9169 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9170 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9171 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9172 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9173 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9174 "summary" : "Get storage commitment report",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9175 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9176 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9177 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9178 "/storage-commitment/{id}/remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9179 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9180 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9181 "description" : "Remove out of Orthanc, the DICOM instances that have been reported to have been properly received the storage commitment report whose identifier is provided in the URL. This is only possible if the `Status` of the storage commitment report is `Success`. https://book.orthanc-server.com/users/storage-commitment.html#removing-the-instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9182 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9183 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9184 "description" : "Identifier of the storage commitment report",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9185 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9186 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9187 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9188 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9189 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9190 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9191 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9192 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9193 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9194 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9195 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9196 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9197 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9198 "summary" : "Remove after storage commitment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9199 "tags" : [ "Networking" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9200 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9201 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9202 "/studies" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9203 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9204 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9205 "description" : "List the Orthanc identifiers of all the available DICOM studies",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9206 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9207 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9208 "description" : "If present, retrieve detailed information about the individual studies",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9209 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9210 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9211 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9212 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9213 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9214 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9215 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9216 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9217 "description" : "Limit the number of results",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9218 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9219 "name" : "limit",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9220 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9221 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9222 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9223 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9224 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9225 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9226 "description" : "Show only the resources since the provided index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9227 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9228 "name" : "since",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9229 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9230 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9231 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9232 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9233 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9234 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9235 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9236 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9237 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9238 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9239 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9240 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported studies (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9241 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9242 "6c65289b-db2fcb71-7eaf73f4-8e12470c-a4d6d7cf",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9243 "6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9244 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9245 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9246 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9247 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9248 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9249 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9250 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9251 "summary" : "List the available studies",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9252 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9253 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9254 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9255 "/studies/{id}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9256 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9257 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9258 "description" : "Delete the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9259 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9260 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9261 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9262 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9263 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9264 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9265 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9266 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9267 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9268 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9269 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9270 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9271 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9272 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9273 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9274 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9275 "summary" : "Delete some study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9276 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9277 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9278 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9279 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9280 "description" : "Get detailed information about the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9281 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9282 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9283 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9284 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9285 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9286 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9287 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9288 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9289 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9290 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9291 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9292 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9293 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9294 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9295 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9296 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9297 "description" : "Information about the DICOM study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9298 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9299 "ID" : "27f7126f-4f66fb14-03f4081b-f9341db2-53925988",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9300 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9301 "LastUpdate" : "20180414T091532",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9302 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9303 "AccessionNumber" : "0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9304 "InstitutionName" : "7GEFF0GbzqCNo43Yd0,Ibu,zQSSX",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9305 "ReferringPhysicianName" : "dAEvNTxZJO0E",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9306 "RequestedProcedureDescription" : "IRM cérébrale, neuro-crâne",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9307 "StudyDate" : "20061201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9308 "StudyDescription" : "IRM cérébrale, neuro-crâne",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9309 "StudyID" : "218211405",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9310 "StudyInstanceUID" : "2.16.840.1.113669.632.20.1211.10000357775",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9311 "StudyTime" : "141645.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9312 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9313 "ParentPatient" : "16738bc3-e47ed42a-43ce044c-a3414a45-cb069bd0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9314 "PatientMainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9315 "PatientBirthDate" : "19490301",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9316 "PatientID" : "5Yp0E",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9317 "PatientName" : "BRAINIX",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9318 "PatientSex" : "0000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9319 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9320 "Series" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9321 "635faa23-fd8378ee-d03bce29-ee47c2fb-a65c5509",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9322 "dc0216d2-a406a5ad-31ef7a78-113ae9d9-29939f9e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9323 "1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9324 "4baa97c7-d53d3d82-a5eb9403-17ef5a77-4e0efb55",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9325 "2ac1316d-3e432022-62eabff2-c59f5475-9b1ac3f8",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9326 "ae164c84-e5bd0366-ba937a6d-65414092-f294d6b6",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9327 "3ca69615-fcd4a4fb-e5f2cc9d-9c7a49a5-add98bbf"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9328 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9329 "Type" : "Study"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9330 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9331 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9332 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9333 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9334 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9335 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9336 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9337 "summary" : "Get information about some study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9338 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9339 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9340 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9341 "/studies/{id}/anonymize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9342 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9343 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9344 "description" : "Start a job that will anonymize all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9345 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9346 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9347 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9348 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9349 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9350 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9351 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9352 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9353 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9354 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9355 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9356 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9357 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9358 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9359 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9360 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9361 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9362 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9363 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9364 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9365 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9366 "DicomVersion" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9367 "description" : "Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9368 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9369 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9370 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9371 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9372 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9373 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9374 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9375 "description" : "List of DICOM tags whose value must not be destroyed by the anonymization",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9376 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9377 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9378 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9379 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9380 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9381 "KeepPrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9382 "description" : "Keep the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9383 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9384 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9385 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9386 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9387 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9388 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9389 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9390 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9391 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9392 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9393 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9394 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9395 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9396 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9397 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9398 "description" : "List of additional tags to be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9399 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9400 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9401 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9402 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9403 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9404 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9405 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9406 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9407 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9408 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9409 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9410 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9411 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9412 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9413 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9414 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9415 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9416 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9417 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9418 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9419 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9420 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9421 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9422 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9423 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9424 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9425 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9426 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9427 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9428 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9429 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9430 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9431 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9432 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9433 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9434 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9435 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9436 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9437 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9438 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9439 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9440 "summary" : "Anonymize study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9441 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9442 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9443 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9444 "/studies/{id}/archive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9445 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9446 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9447 "description" : "Synchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9448 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9449 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9450 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9451 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9452 "name" : "transcode",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9453 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9454 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9455 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9456 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9457 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9458 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9459 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9460 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9461 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9462 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9463 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9464 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9465 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9466 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9467 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9468 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9469 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9470 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9471 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9472 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9473 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9474 "description" : "ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9475 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9476 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9477 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9478 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9479 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9480 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9481 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9482 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9483 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9484 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9485 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9486 "description" : "Create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9487 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9488 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9489 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9490 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9491 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9492 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9493 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9494 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9495 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9496 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9497 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9498 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9499 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9500 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9501 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9502 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9503 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9504 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9505 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9506 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9507 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9508 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9509 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9510 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9511 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9512 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9513 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9514 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9515 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9516 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9517 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9518 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9519 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9520 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9521 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9522 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9523 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9524 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9525 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9526 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9527 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9528 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9529 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9530 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9531 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9532 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9533 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9534 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9535 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9536 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9537 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9538 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9539 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9540 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9541 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9542 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9543 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9544 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9545 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9546 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9547 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9548 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9549 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9550 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9551 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9552 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9553 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9554 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9555 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9556 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9557 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9558 "/studies/{id}/attachments" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9559 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9560 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9561 "description" : "Get the list of attachments that are associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9562 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9563 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9564 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9565 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9566 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9567 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9568 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9569 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9570 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9571 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9572 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9573 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9574 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9575 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9576 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9577 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9578 "description" : "JSON array containing the names of the attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9579 "example" : []
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9580 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9581 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9582 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9583 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9584 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9585 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9586 "summary" : "List attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9587 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9588 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9589 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9590 "/studies/{id}/attachments/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9591 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9592 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9593 "description" : "Delete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9594 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9595 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9596 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9597 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9598 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9599 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9600 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9601 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9602 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9603 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9604 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9605 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9606 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9607 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9608 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9609 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9610 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9611 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9612 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9613 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9614 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9615 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9616 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9617 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9618 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9619 "summary" : "Delete attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9620 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9621 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9622 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9623 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9624 "description" : "Get the list of the operations that are available for attachments associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9625 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9626 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9627 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9628 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9629 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9630 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9631 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9632 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9633 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9634 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9635 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9636 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9637 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9638 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9639 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9640 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9641 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9642 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9643 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9644 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9645 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9646 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9647 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9648 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9649 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9650 "description" : "List of the available operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9651 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9652 "compress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9653 "compressed-data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9654 "compressed-md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9655 "compressed-size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9656 "data",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9657 "is-compressed",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9658 "md5",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9659 "size",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9660 "uncompress",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9661 "verify-md5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9662 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9663 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9664 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9665 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9666 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9667 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9668 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9669 "summary" : "List operations on attachments",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9670 "tags" : [ "Other" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9671 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9672 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9673 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9674 "description" : "Attach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9675 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9676 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9677 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9678 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9679 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9680 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9681 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9682 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9683 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9684 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9685 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9686 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9687 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9688 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9689 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9690 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9691 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9692 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9693 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9694 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9695 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9696 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9697 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9698 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9699 "description" : "Binary data containing the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9700 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9701 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9702 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9703 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9704 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9705 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9706 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9707 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9708 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9709 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9710 "description" : "Empty JSON object in the case of a success"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9711 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9712 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9713 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9714 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9715 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9716 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9717 "summary" : "Set attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9718 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9719 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9720 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9721 "/studies/{id}/attachments/{name}/compress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9722 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9723 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9724 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9725 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9726 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9727 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9728 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9729 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9730 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9731 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9732 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9733 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9734 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9735 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9736 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9737 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9738 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9739 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9740 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9741 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9742 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9743 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9744 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9745 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9746 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9747 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9748 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9749 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9750 "summary" : "Compress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9751 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9752 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9753 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9754 "/studies/{id}/attachments/{name}/compressed-data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9755 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9756 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9757 "description" : "Get the (binary) content of one attachment associated with the given study. The attachment will not be decompressed if `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9758 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9759 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9760 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9761 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9762 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9763 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9764 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9765 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9766 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9767 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9768 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9769 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9770 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9771 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9772 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9773 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9774 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9775 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9776 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9777 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9778 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9779 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9780 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9781 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9782 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9783 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9784 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9785 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9786 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9787 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9788 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9789 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9790 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9791 "summary" : "Get attachment (no decompression)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9792 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9793 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9794 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9795 "/studies/{id}/attachments/{name}/compressed-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9796 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9797 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9798 "description" : "Get the MD5 hash of one attachment associated with the given study, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9799 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9800 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9801 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9802 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9803 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9804 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9805 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9806 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9807 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9808 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9809 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9810 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9811 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9812 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9813 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9814 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9815 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9816 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9817 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9818 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9819 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9820 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9821 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9822 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9823 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9824 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9825 "description" : "The MD5 of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9826 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9827 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9828 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9829 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9830 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9831 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9832 "summary" : "Get MD5 of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9833 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9834 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9835 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9836 "/studies/{id}/attachments/{name}/compressed-size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9837 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9838 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9839 "description" : "Get the size of one attachment associated with the given study, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9840 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9841 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9842 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9843 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9844 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9845 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9846 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9847 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9848 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9849 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9850 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9851 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9852 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9853 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9854 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9855 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9856 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9857 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9858 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9859 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9860 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9861 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9862 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9863 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9864 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9865 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9866 "description" : "The size of the attachment, as stored on the disk"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9867 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9868 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9869 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9870 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9871 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9872 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9873 "summary" : "Get size of attachment on disk",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9874 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9875 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9876 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9877 "/studies/{id}/attachments/{name}/data" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9878 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9879 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9880 "description" : "Get the (binary) content of one attachment associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9881 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9882 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9883 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9884 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9885 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9886 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9887 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9888 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9889 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9890 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9891 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9892 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9893 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9894 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9895 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9896 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9897 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9898 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9899 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9900 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9901 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9902 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9903 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9904 "application/octet-stream" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9905 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9906 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9907 "description" : "The attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9908 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9909 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9910 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9911 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9912 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9913 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9914 "summary" : "Get attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9915 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9916 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9917 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9918 "/studies/{id}/attachments/{name}/is-compressed" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9919 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9920 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9921 "description" : "Test whether the attachment has been stored as a compressed file on the disk.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9922 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9923 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9924 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9925 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9926 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9927 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9928 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9929 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9930 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9931 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9932 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9933 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9934 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9935 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9936 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9937 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9938 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9939 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9940 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9941 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9942 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9943 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9944 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9945 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9946 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9947 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9948 "description" : "`0` if the attachment was stored uncompressed, `1` if it was compressed"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9949 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9950 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9951 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9952 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9953 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9954 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9955 "summary" : "Is attachment compressed?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9956 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9957 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9958 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9959 "/studies/{id}/attachments/{name}/md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9960 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9961 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9962 "description" : "Get the MD5 hash of one attachment associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9963 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9964 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9965 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9966 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9967 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9968 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9969 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9970 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9971 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9972 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9973 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9974 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9975 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9976 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9977 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9978 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9979 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9980 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9981 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9982 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9983 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9984 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9985 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9986 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9987 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9988 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9989 "description" : "The MD5 of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9990 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9991 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9992 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9993 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9994 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9995 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9996 "summary" : "Get MD5 of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9997 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9998 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9999 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10000 "/studies/{id}/attachments/{name}/size" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10001 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10002 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10003 "description" : "Get the size of one attachment associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10004 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10005 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10006 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10007 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10008 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10009 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10010 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10011 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10012 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10013 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10014 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10015 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10016 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10017 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10018 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10019 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10020 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10021 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10022 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10023 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10024 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10025 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10026 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10027 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10028 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10029 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10030 "description" : "The size of the attachment"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10031 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10032 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10033 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10034 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10035 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10036 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10037 "summary" : "Get size of attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10038 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10039 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10040 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10041 "/studies/{id}/attachments/{name}/uncompress" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10042 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10043 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10044 "description" : "Change the compression scheme that is used to store an attachment.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10045 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10046 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10047 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10048 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10049 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10050 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10051 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10052 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10053 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10054 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10055 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10056 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10057 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10058 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10059 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10060 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10061 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10062 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10063 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10064 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10065 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10066 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10067 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10068 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10069 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10070 "summary" : "Uncompress attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10071 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10072 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10073 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10074 "/studies/{id}/attachments/{name}/verify-md5" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10075 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10076 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10077 "description" : "Verify that the attachment is not corrupted, by validating its MD5 hash",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10078 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10079 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10080 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10081 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10082 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10083 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10084 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10085 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10086 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10087 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10088 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10089 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10090 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10091 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10092 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10093 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10094 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10095 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10096 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10097 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10098 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10099 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10100 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10101 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10102 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10103 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10104 "description" : "On success, a valid JSON object is returned"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10105 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10106 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10107 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10108 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10109 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10110 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10111 "summary" : "Verify attachment",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10112 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10113 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10114 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10115 "/studies/{id}/instances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10116 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10117 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10118 "description" : "Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10119 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10120 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10121 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10122 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10123 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10124 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10125 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10126 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10127 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10128 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10129 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10130 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10131 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10132 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10133 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10134 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10135 "description" : "JSON array containing information about the child DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10136 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10137 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10138 "FileSize" : 527858,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10139 "FileUuid" : "42607af0-e2ca-402a-9cb4-8819a0485dbd",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10140 "ID" : "82cc1a6b-7b05d34e-cd74474b-594f0d43-94f609d8",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10141 "IndexInSeries" : 3,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10142 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10143 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10144 "ImagePositionPatient" : "-118.20798927708\\-118.00763136239\\71.7517339810729",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10145 "InstanceCreationDate" : "20061201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10146 "InstanceCreationTime" : "145313.000000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10147 "InstanceNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10148 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10149 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10150 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10151 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10152 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10153 "FileSize" : 527858,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10154 "FileUuid" : "f986a0de-cf3b-4acc-a2ca-ce6a5844ec63",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10155 "ID" : "2fbd6d5f-802f6561-b9d8da32-c54ead16-18a208bd",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10156 "IndexInSeries" : 13,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10157 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10158 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10159 "ImagePositionPatient" : "-116.77244740887\\-113.68593889565\\11.9247972592711",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10160 "InstanceCreationDate" : "20061201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10161 "InstanceCreationTime" : "145313.000000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10162 "InstanceNumber" : "13",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10163 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10164 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10165 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10166 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10167 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10168 "FileSize" : 527858,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10169 "FileUuid" : "64cc6dae-228d-4e60-82ea-34c540a09cfb",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10170 "ID" : "4dbca7c1-f6e1a582-b3196370-0151cac8-19caac8e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10171 "IndexInSeries" : 17,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10172 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10173 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10174 "ImagePositionPatient" : "-116.19823080464\\-111.95726186127\\-12.005976177752",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10175 "InstanceCreationDate" : "20061201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10176 "InstanceCreationTime" : "145313.000000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10177 "InstanceNumber" : "17",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10178 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10179 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10180 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10181 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10182 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10183 "FileSize" : 527858,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10184 "FileUuid" : "06823b17-6217-4534-b318-4de5c9157c74",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10185 "ID" : "98c6f0c7-e6f9812b-d0a9df8a-97eeaa41-fa891d8e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10186 "IndexInSeries" : 6,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10187 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10188 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10189 "ImagePositionPatient" : "-117.77732664509\\-116.71112352700\\53.8036520108580",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10190 "InstanceCreationDate" : "20061201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10191 "InstanceCreationTime" : "145313.000000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10192 "InstanceNumber" : "6",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10193 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10194 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10195 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10196 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10197 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10198 "FileSize" : 527858,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10199 "FileUuid" : "7012f4ad-e1f7-49a8-95e0-5050227b4090",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10200 "ID" : "c25f4e48-8f7d737e-3dbeafb5-f1563a30-eddf816c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10201 "IndexInSeries" : 20,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10202 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10203 "AcquisitionNumber" : "3",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10204 "ImagePositionPatient" : "-115.76756829186\\-110.66075450272\\-29.954057492315",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10205 "InstanceCreationDate" : "20061201",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10206 "InstanceCreationTime" : "145313.000000",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10207 "InstanceNumber" : "20",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10208 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10209 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10210 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10211 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10212 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10213 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10214 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10215 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10216 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10217 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10218 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10219 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10220 "summary" : "Get child instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10221 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10222 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10223 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10224 "/studies/{id}/instances-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10225 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10226 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10227 "description" : "Get the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10228 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10229 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10230 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10231 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10232 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10233 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10234 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10235 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10236 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10237 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10238 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10239 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10240 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10241 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10242 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10243 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10244 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10245 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10246 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10247 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10248 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10249 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10250 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10251 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10252 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10253 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10254 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10255 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10256 "description" : "JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10257 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10258 "00330d0f-911e5e8d-1e305bae-e5c53b73-d2a49298" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10259 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10260 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10261 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10262 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10263 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10264 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10265 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10266 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10267 "Value" : "ORIGINAL\\PRIMARY\\M_SE\\M\\SE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10268 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10269 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10270 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10271 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10272 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10273 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10274 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10275 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10276 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10277 "Value" : "145331.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10278 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10279 "0008,0014" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10280 "Name" : "InstanceCreatorUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10281 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10282 "Value" : "1.3.46.670589.11.8743.5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10283 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10284 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10285 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10286 "00402ce7-ac05c687-4d0839bc-cecd4fad-3d1b7eed" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10287 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10288 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10289 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10290 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10291 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10292 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10293 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10294 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10295 "Value" : "ORIGINAL\\PRIMARY\\M_FFE\\M\\FFE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10296 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10297 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10298 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10299 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10300 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10301 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10302 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10303 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10304 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10305 "Value" : "145326.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10306 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10307 "0008,0014" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10308 "Name" : "InstanceCreatorUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10309 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10310 "Value" : "1.3.46.670589.11.8743.5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10311 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10312 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10313 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10314 "00ffd506-6460663a-cda9bddc-a0090c47-145ba829" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10315 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10316 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10317 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10318 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10319 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10320 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10321 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10322 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10323 "Value" : "ORIGINAL\\PRIMARY\\M_FFE\\M\\FFE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10324 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10325 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10326 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10327 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10328 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10329 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10330 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10331 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10332 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10333 "Value" : "145346.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10334 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10335 "0008,0014" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10336 "Name" : "InstanceCreatorUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10337 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10338 "Value" : "1.3.46.670589.11.8743.5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10339 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10340 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10341 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10342 "01a6ffdc-335f82a7-c79360c2-2e6bbc35-d24ca33d" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10343 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10344 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10345 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10346 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10347 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10348 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10349 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10350 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10351 "Value" : "ORIGINAL\\PRIMARY\\M_SE\\M\\SE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10352 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10353 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10354 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10355 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10356 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10357 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10358 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10359 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10360 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10361 "Value" : "145313.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10362 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10363 "0008,0014" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10364 "Name" : "InstanceCreatorUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10365 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10366 "Value" : "1.3.46.670589.11.8743.5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10367 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10368 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10369 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10370 "0577c66f-25d7cc30-bb763c60-53bb7ba0-72c8b018" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10371 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10372 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10373 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10374 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10375 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10376 "0008,0008" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10377 "Name" : "ImageType",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10378 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10379 "Value" : "ORIGINAL\\PRIMARY\\M_FFE\\M\\FFE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10380 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10381 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10382 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10383 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10384 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10385 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10386 "0008,0013" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10387 "Name" : "InstanceCreationTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10388 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10389 "Value" : "145346.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10390 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10391 "0008,0014" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10392 "Name" : "InstanceCreatorUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10393 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10394 "Value" : "1.3.46.670589.11.8743.5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10395 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10396 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10397 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10398 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10399 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10400 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10401 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10402 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10403 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10404 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10405 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10406 "summary" : "Get tags of instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10407 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10408 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10409 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10410 "/studies/{id}/media" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10411 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10412 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10413 "description" : "Synchronously create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10414 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10415 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10416 "description" : "If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10417 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10418 "name" : "extended",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10419 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10420 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10421 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10422 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10423 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10424 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10425 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10426 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10427 "name" : "transcode",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10428 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10429 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10430 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10431 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10432 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10433 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10434 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10435 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10436 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10437 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10438 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10439 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10440 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10441 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10442 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10443 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10444 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10445 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10446 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10447 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10448 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10449 "description" : "ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10450 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10451 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10452 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10453 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10454 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10455 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10456 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10457 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10458 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10459 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10460 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10461 "description" : "Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10462 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10463 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10464 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10465 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10466 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10467 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10468 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10469 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10470 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10471 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10472 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10473 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10474 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10475 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10476 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10477 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10478 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10479 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10480 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10481 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10482 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10483 "Extended" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10484 "description" : "If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10485 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10486 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10487 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10488 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10489 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10490 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10491 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10492 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10493 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10494 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10495 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10496 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10497 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10498 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10499 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10500 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10501 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10502 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10503 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10504 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10505 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10506 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10507 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10508 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10509 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10510 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10511 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10512 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10513 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10514 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10515 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10516 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10517 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10518 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10519 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10520 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10521 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10522 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10523 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10524 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10525 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10526 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10527 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10528 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10529 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10530 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10531 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10532 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10533 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10534 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10535 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10536 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10537 "/studies/{id}/merge" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10538 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10539 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10540 "description" : "Start a new job so as to move some DICOM series into the DICOM study whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#merging",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10541 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10542 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10543 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10544 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10545 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10546 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10547 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10548 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10549 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10550 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10551 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10552 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10553 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10554 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10555 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10556 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10557 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10558 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10559 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10560 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10561 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10562 "KeepSource" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10563 "description" : "If set to `true`, instructs Orthanc to keep a copy of the original resources in their source study. By default, the original resources are deleted from Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10564 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10565 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10566 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10567 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10568 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10569 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10570 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10571 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10572 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10573 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10574 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10575 "description" : "The list of DICOM resources (patients, studies, series, and/or instances) to be merged into the study of interest (mandatory option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10576 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10577 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10578 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10579 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10580 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10581 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10582 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10583 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10584 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10585 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10586 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10587 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10588 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10589 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10590 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10591 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10592 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10593 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10594 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10595 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10596 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10597 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10598 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10599 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10600 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10601 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10602 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10603 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10604 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10605 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10606 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10607 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10608 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10609 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10610 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10611 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10612 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10613 "summary" : "Merge study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10614 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10615 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10616 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10617 "/studies/{id}/metadata" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10618 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10619 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10620 "description" : "Get the list of metadata that are associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10621 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10622 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10623 "description" : "If present, also retrieve the value of the individual metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10624 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10625 "name" : "expand",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10626 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10627 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10628 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10629 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10630 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10631 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10632 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10633 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10634 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10635 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10636 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10637 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10638 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10639 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10640 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10641 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10642 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10643 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10644 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10645 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10646 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10647 "example" : [ "LastUpdate" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10648 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10649 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10650 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10651 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10652 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10653 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10654 "summary" : "List metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10655 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10656 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10657 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10658 "/studies/{id}/metadata/{name}" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10659 "delete" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10660 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10661 "description" : "Delete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10662 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10663 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10664 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10665 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10666 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10667 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10668 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10669 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10670 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10671 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10672 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10673 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10674 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10675 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10676 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10677 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10678 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10679 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10680 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10681 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10682 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10683 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10684 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10685 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10686 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10687 "summary" : "Delete metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10688 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10689 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10690 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10691 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10692 "description" : "Get the value of a metadata that is associated with the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10693 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10694 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10695 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10696 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10697 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10698 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10699 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10700 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10701 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10702 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10703 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10704 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10705 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10706 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10707 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10708 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10709 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10710 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10711 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10712 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10713 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10714 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10715 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10716 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10717 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10718 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10719 "description" : "Value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10720 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10721 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10722 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10723 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10724 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10725 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10726 "summary" : "Get metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10727 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10728 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10729 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10730 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10731 "description" : "Set the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10732 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10733 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10734 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10735 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10736 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10737 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10738 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10739 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10740 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10741 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10742 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10743 "description" : "The name of the metadata, or its index (cf. `UserMetadata` configuration option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10744 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10745 "name" : "name",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10746 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10747 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10748 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10749 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10750 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10751 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10752 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10753 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10754 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10755 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10756 "description" : "String value of the metadata"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10757 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10758 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10759 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10760 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10761 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10762 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10763 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10764 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10765 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10766 "summary" : "Set metadata",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10767 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10768 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10769 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10770 "/studies/{id}/modify" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10771 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10772 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10773 "description" : "Start a job that will modify all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10774 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10775 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10776 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10777 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10778 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10779 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10780 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10781 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10782 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10783 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10784 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10785 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10786 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10787 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10788 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10789 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10790 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10791 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10792 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10793 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10794 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10795 "Force" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10796 "description" : "Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10797 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10798 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10799 "Keep" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10800 "description" : "Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10801 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10802 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10803 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10804 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10805 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10806 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10807 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10808 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10809 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10810 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10811 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10812 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10813 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10814 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10815 "description" : "The private creator to be used for private tags in `Replace`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10816 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10817 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10818 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10819 "description" : "List of tags that must be removed from the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10820 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10821 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10822 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10823 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10824 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10825 "RemovePrivateTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10826 "description" : "Remove the private tags from the DICOM instances (defaults to `false`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10827 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10828 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10829 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10830 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10831 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10832 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10833 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10834 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10835 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10836 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10837 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10838 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10839 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10840 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10841 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10842 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10843 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10844 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10845 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10846 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10847 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10848 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10849 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10850 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10851 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10852 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10853 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10854 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10855 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10856 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10857 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10858 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10859 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10860 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10861 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10862 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10863 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10864 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10865 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10866 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10867 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10868 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10869 "summary" : "Modify study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10870 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10871 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10872 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10873 "/studies/{id}/module" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10874 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10875 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10876 "description" : "Get the study module of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10877 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10878 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10879 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10880 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10881 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10882 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10883 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10884 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10885 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10886 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10887 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10888 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10889 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10890 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10891 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10892 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10893 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10894 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10895 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10896 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10897 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10898 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10899 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10900 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10901 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10902 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10903 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10904 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10905 "description" : "Information about the DICOM study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10906 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10907 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10908 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10909 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10910 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10911 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10912 "0008,0030" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10913 "Name" : "StudyTime",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10914 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10915 "Value" : "141645.000000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10916 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10917 "0008,0050" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10918 "Name" : "AccessionNumber",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10919 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10920 "Value" : "0"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10921 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10922 "0008,0090" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10923 "Name" : "ReferringPhysicianName",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10924 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10925 "Value" : "dAEvNTxZJO0E"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10926 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10927 "0008,1030" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10928 "Name" : "StudyDescription",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10929 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10930 "Value" : "IRM cérébrale, neuro-crâne"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10931 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10932 "0008,1032" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10933 "Name" : "ProcedureCodeSequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10934 "Type" : "Sequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10935 "Value" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10936 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10937 "0008,0100" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10938 "Name" : "CodeValue",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10939 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10940 "Value" : "IRMCEREB"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10941 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10942 "0008,0102" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10943 "Name" : "CodingSchemeDesignator",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10944 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10945 "Value" : "XPLORE"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10946 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10947 "0008,0104" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10948 "Name" : "CodeMeaning",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10949 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10950 "Value" : "IRM cérébrale, neuro-crâne"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10951 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10952 "0008,010b" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10953 "Name" : "ContextGroupExtensionFlag",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10954 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10955 "Value" : "N"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10956 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10957 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10958 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10959 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10960 "0008,1110" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10961 "Name" : "ReferencedStudySequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10962 "Type" : "Sequence",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10963 "Value" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10964 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10965 "0008,1150" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10966 "Name" : "ReferencedSOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10967 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10968 "Value" : "1.2.840.10008.3.1.2.3.1"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10969 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10970 "0008,1155" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10971 "Name" : "ReferencedSOPInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10972 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10973 "Value" : "2.16.840.1.113669.632.20.1211.10000357775"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10974 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10975 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10976 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10977 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10978 "0020,000d" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10979 "Name" : "StudyInstanceUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10980 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10981 "Value" : "2.16.840.1.113669.632.20.1211.10000357775"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10982 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10983 "0020,0010" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10984 "Name" : "StudyID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10985 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10986 "Value" : "218211405"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10987 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10988 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10989 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10990 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10991 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10992 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10993 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10994 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10995 "summary" : "Get study module",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10996 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10997 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10998 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10999 "/studies/{id}/module-patient" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11000 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11001 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11002 "description" : "Get the patient module of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11003 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11004 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11005 "description" : "Also include the DICOM tags that are provided in this list, even if their associated value is long",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11006 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11007 "name" : "ignore-length",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11008 "required" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11009 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11010 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11011 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11012 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11013 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11014 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11015 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11016 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11017 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11018 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11019 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11020 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11021 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11022 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11023 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11024 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11025 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11026 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11027 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11028 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11029 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11030 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11031 "description" : "Information about the DICOM study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11032 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11033 "0010,0010" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11034 "Name" : "PatientName",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11035 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11036 "Value" : "BRAINIX"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11037 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11038 "0010,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11039 "Name" : "PatientID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11040 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11041 "Value" : "5Yp0E"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11042 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11043 "0010,0030" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11044 "Name" : "PatientBirthDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11045 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11046 "Value" : "19490301"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11047 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11048 "0010,0040" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11049 "Name" : "PatientSex",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11050 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11051 "Value" : "0000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11052 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11053 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11054 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11055 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11056 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11057 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11058 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11059 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11060 "summary" : "Get patient module of study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11061 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11062 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11063 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11064 "/studies/{id}/patient" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11065 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11066 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11067 "description" : "Get detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11068 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11069 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11070 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11071 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11072 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11073 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11074 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11075 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11076 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11077 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11078 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11079 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11080 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11081 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11082 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11083 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11084 "description" : "Information about the parent DICOM patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11085 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11086 "ID" : "16738bc3-e47ed42a-43ce044c-a3414a45-cb069bd0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11087 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11088 "LastUpdate" : "20180414T091532",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11089 "MainDicomTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11090 "PatientBirthDate" : "19490301",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11091 "PatientID" : "5Yp0E",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11092 "PatientName" : "BRAINIX",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11093 "PatientSex" : "0000"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11094 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11095 "Studies" : [ "27f7126f-4f66fb14-03f4081b-f9341db2-53925988" ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11096 "Type" : "Patient"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11097 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11098 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11099 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11100 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11101 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11102 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11103 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11104 "summary" : "Get parent patient",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11105 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11106 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11107 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11108 "/studies/{id}/reconstruct" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11109 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11110 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11111 "description" : "Reconstruct the main DICOM tags of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11112 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11113 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11114 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11115 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11116 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11117 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11118 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11119 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11120 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11121 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11122 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11123 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11124 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11125 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11126 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11127 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11128 "summary" : "Reconstruct tags of study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11129 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11130 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11131 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11132 "/studies/{id}/series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11133 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11134 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11135 "description" : "Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11136 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11137 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11138 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11139 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11140 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11141 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11142 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11143 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11144 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11145 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11146 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11147 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11148 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11149 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11150 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11151 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11152 "description" : "JSON array containing information about the child DICOM series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11153 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11154 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11155 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11156 "ID" : "635faa23-fd8378ee-d03bce29-ee47c2fb-a65c5509",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11157 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11158 "ed8aacd6-5d2cfad4-9e1a2f77-edf1cee5-8f3bdde0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11159 "7a93b85e-5956dbf9-894c1f27-dc73112f-4cbcda70",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11160 "065baa49-a7b4e4a0-e7468f1d-e9b5bca8-56316fa2",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11161 "ca69bc1a-a4fcc0a8-9e6828b0-c816dbaa-240fdc45",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11162 "edd8ff85-9805d97a-2375f736-40662993-aef40418",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11163 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11164 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11165 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11166 "LastUpdate" : "20180414T091528",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11167 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11168 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11169 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11170 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11171 "ID" : "dc0216d2-a406a5ad-31ef7a78-113ae9d9-29939f9e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11172 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11173 "2cd73574-190bb147-0a86bcca-68c75104-d22f09dd",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11174 "ff95b7c0-d14e3e42-d642eacd-281cb07c-4e0bbc8b",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11175 "22384bf2-0bbe7bdb-013f6ff2-f7834e9f-3d8754bf",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11176 "3e50a403-17c8ce10-6e0234e3-a8bed1bf-3dbc54ee",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11177 "3db0ed84-61a28da4-72a52d5a-3f7daa77-b81ddf17",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11178 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11179 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11180 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11181 "LastUpdate" : "20180414T091530",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11182 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11183 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11184 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11185 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11186 "ID" : "1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11187 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11188 "2db53a93-91179cd5-f2080c32-c9b156ec-b8f65fa7",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11189 "9058e01a-31a7d982-1691e575-a8607d94-29a9aaca",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11190 "40df6ac1-5ec86316-035ff3c1-07e5c8a8-f6cbd37c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11191 "144ca294-6e759cfb-e14e3404-e78a0a29-1dd3273c",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11192 "3b2a215c-2560d4b0-e3730c07-87d3fa7d-3fef44ed",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11193 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11194 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11195 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11196 "LastUpdate" : "20180414T091530",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11197 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11198 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11199 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11200 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11201 "ID" : "4baa97c7-d53d3d82-a5eb9403-17ef5a77-4e0efb55",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11202 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11203 "9b41ef96-b4031ffc-b1b7ea5d-8a38d55d-fe804601",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11204 "8137542c-069dd229-d0226fba-f8c571cd-19c7b61a",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11205 "985681e7-99cd2ce5-f7d79f12-27bfc29f-0e5a4d72",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11206 "f0b9f0ab-110181f8-ce83a1a2-4d8eb2c9-0b682503",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11207 "ef13019a-9edf339d-395d8632-558518bf-b82b1b21",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11208 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11209 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11210 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11211 "LastUpdate" : "20180414T091531",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11212 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11213 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11214 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11215 "ExpectedNumberOfInstances" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11216 "ID" : "2ac1316d-3e432022-62eabff2-c59f5475-9b1ac3f8",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11217 "Instances" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11218 "61eeef27-cb5515a3-0860ab44-90125207-a56e6883",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11219 "18bc4146-4bb09c43-e4080c80-19bfc186-6b3d7272",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11220 "00402ce7-ac05c687-4d0839bc-cecd4fad-3d1b7eed",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11221 "ea902bf2-6dc22ee9-e962333a-7ce2c27f-d684977e",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11222 "8371936f-4141219a-ca7d69df-0d82697e-271eef91",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11223 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11224 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11225 "IsStable" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11226 "LastUpdate" : "20180414T091531",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11227 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11228 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11229 "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11230 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11231 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11232 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11233 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11234 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11235 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11236 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11237 "summary" : "Get child series",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11238 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11239 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11240 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11241 "/studies/{id}/shared-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11242 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11243 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11244 "description" : "Extract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11245 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11246 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11247 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11248 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11249 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11250 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11251 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11252 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11253 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11254 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11255 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11256 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11257 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11258 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11259 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11260 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11261 "description" : "JSON object containing the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11262 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11263 "0008,0005" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11264 "Name" : "SpecificCharacterSet",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11265 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11266 "Value" : "ISO_IR 100"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11267 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11268 "0008,0012" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11269 "Name" : "InstanceCreationDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11270 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11271 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11272 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11273 "0008,0014" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11274 "Name" : "InstanceCreatorUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11275 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11276 "Value" : "1.3.46.670589.11.8743.5"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11277 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11278 "0008,0016" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11279 "Name" : "SOPClassUID",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11280 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11281 "Value" : "1.2.840.10008.5.1.4.1.1.4"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11282 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11283 "0008,0020" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11284 "Name" : "StudyDate",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11285 "Type" : "String",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11286 "Value" : "20061201"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11287 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11288 "{...}" : "..."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11289 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11290 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11291 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11292 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11293 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11294 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11295 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11296 "summary" : "Get shared tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11297 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11298 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11299 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11300 "/studies/{id}/split" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11301 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11302 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11303 "description" : "Start a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, by taking some of its children series out of it and putting them into a brand new study (this new study is created by setting the `StudyInstanceUID` tag to a random identifier): https://book.orthanc-server.com/users/anonymization.html#splitting",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11304 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11305 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11306 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11307 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11308 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11309 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11310 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11311 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11312 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11313 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11314 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11315 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11316 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11317 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11318 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11319 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11320 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11321 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11322 "description" : "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11323 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11324 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11325 "KeepSource" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11326 "description" : "If set to `true`, instructs Orthanc to keep a copy of the original series in the source study. By default, the original series are deleted from Orthanc.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11327 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11328 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11329 "Permissive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11330 "description" : "If `true`, ignore errors during the individual steps of the job.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11331 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11332 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11333 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11334 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11335 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11336 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11337 "Remove" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11338 "description" : "List of tags that must be removed in the new study (from the same modules as in the `Replace` option)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11339 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11340 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11341 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11342 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11343 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11344 "Replace" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11345 "description" : "Associative array to change the value of some DICOM tags in the new study. These tags must be part of the \"Patient Module Attributes\" or the \"General Study Module Attributes\", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11346 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11347 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11348 "Series" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11349 "description" : "The list of series to be separated from the parent study (mandatory option). These series must all be children of the same source study, that is specified in the URI.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11350 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11351 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11352 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11353 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11354 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11355 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11356 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11357 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11358 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11359 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11360 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11361 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11362 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11363 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11364 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11365 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11366 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11367 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11368 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11369 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11370 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11371 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11372 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11373 "description" : "In asynchronous mode, identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11374 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11375 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11376 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11377 "description" : "In asynchronous mode, path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11378 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11379 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11380 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11381 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11382 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11383 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11384 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11385 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11386 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11387 "summary" : "Split study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11388 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11389 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11390 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11391 "/studies/{id}/statistics" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11392 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11393 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11394 "description" : "Get statistics about the given study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11395 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11396 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11397 "description" : "Orthanc identifier of the study of interest",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11398 "in" : "path",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11399 "name" : "id",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11400 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11401 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11402 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11403 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11404 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11405 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11406 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11407 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11408 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11409 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11410 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11411 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11412 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11413 "CountInstances" : 232,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11414 "CountSeries" : 7,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11415 "DicomDiskSize" : "68153234",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11416 "DicomDiskSizeMB" : 64,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11417 "DicomUncompressedSize" : "68153234",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11418 "DicomUncompressedSizeMB" : 64,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11419 "DiskSize" : "72203548",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11420 "DiskSizeMB" : 68,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11421 "UncompressedSize" : "72203548",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11422 "UncompressedSizeMB" : 68
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11423 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11424 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11425 "CountInstances" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11426 "description" : "Number of child instances within this study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11427 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11428 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11429 "CountSeries" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11430 "description" : "Number of child series within this study",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11431 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11432 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11433 "DicomDiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11434 "description" : "Size on the disk of the DICOM instances associated with the study, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11435 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11436 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11437 "DicomDiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11438 "description" : "Size on the disk of the DICOM instances associated with the study, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11439 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11440 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11441 "DicomUncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11442 "description" : "Size on the disk of the uncompressed DICOM instances associated with the study, expressed in bytes",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11443 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11444 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11445 "DicomUncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11446 "description" : "Size on the disk of the uncompressed DICOM instances associated with the study, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11447 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11448 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11449 "DiskSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11450 "description" : "Size of the study on the disk in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11451 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11452 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11453 "DiskSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11454 "description" : "Size of the study on the disk, expressed in megabytes (MB)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11455 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11456 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11457 "UncompressedSize" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11458 "description" : "Size of the study after decompression in bytes, expressed as a string for 64bit compatibility with JSON",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11459 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11460 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11461 "UncompressedSizeMB" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11462 "description" : "Size of the study after decompression, expressed in megabytes (MB). This is different from `DiskSizeMB` iff `StorageCompression` is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11463 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11464 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11465 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11466 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11467 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11468 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11469 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11470 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11471 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11472 "summary" : "Get study statistics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11473 "tags" : [ "Studies" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11474 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11475 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11476 "/system" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11477 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11478 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11479 "description" : "Get system information about Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11480 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11481 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11482 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11483 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11484 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11485 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11486 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11487 "example" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11488 "ApiVersion" : 9,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11489 "DatabaseBackendPlugin" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11490 "DatabaseVersion" : 6,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11491 "DicomAet" : "ORTHANC",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11492 "DicomPort" : 4242,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11493 "HttpPort" : 8042,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11494 "IsHttpServerSecure" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11495 "Name" : "Orthanc Demo",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11496 "PluginsEnabled" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11497 "StorageAreaPlugin" : null,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11498 "Version" : "1.8.2"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11499 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11500 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11501 "ApiVersion" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11502 "description" : "Version of the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11503 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11504 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11505 "DatabaseBackendPlugin" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11506 "description" : "Information about the installed database index plugin (`null` if no such plugin is installed)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11507 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11508 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11509 "DatabaseVersion" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11510 "description" : "Version of the database: https://book.orthanc-server.com/developers/db-versioning.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11511 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11512 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11513 "DicomAet" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11514 "description" : "The DICOM AET of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11515 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11516 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11517 "DicomPort" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11518 "description" : "The port to the DICOM server of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11519 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11520 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11521 "HttpPort" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11522 "description" : "The port to the HTTP server of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11523 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11524 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11525 "IsHttpServerSecure" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11526 "description" : "Whether the REST API is properly secured (assuming no reverse proxy is in use): https://book.orthanc-server.com/faq/security.html#securing-the-http-server",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11527 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11528 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11529 "Name" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11530 "description" : "The name of the Orthanc server, cf. the `Name` configuration option",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11531 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11532 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11533 "PluginsEnabled" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11534 "description" : "Whether Orthanc was built with support for plugins",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11535 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11536 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11537 "StorageAreaPlugin" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11538 "description" : "Information about the installed storage area plugin (`null` if no such plugin is installed)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11539 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11540 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11541 "Version" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11542 "description" : "Version of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11543 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11544 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11545 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11546 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11547 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11548 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11549 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11550 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11551 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11552 "summary" : "Get system information",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11553 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11554 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11555 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11556 "/tools" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11557 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11558 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11559 "description" : "List the available operations under URI `/tools/`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11560 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11561 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11562 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11563 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11564 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11565 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11566 "description" : "List of the available operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11567 "example" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11568 "create-archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11569 "create-dicom",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11570 "create-media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11571 "create-media-extended",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11572 "default-encoding",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11573 "dicom-conformance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11574 "dicom-echo",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11575 "execute-script",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11576 "find",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11577 "generate-uid",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11578 "invalidate-tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11579 "log-level",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11580 "log-level-dicom",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11581 "log-level-generic",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11582 "log-level-http",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11583 "log-level-jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11584 "log-level-lua",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11585 "log-level-plugins",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11586 "log-level-sqlite",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11587 "lookup",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11588 "metrics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11589 "metrics-prometheus",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11590 "now",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11591 "now-local",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11592 "reconstruct",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11593 "reset",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11594 "shutdown"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11595 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11596 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11597 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11598 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11599 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11600 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11601 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11602 "summary" : "List operations",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11603 "tags" : [ "Other" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11604 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11605 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11606 "/tools/create-archive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11607 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11608 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11609 "description" : "Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11610 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11611 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11612 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11613 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11614 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11615 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11616 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11617 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11618 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11619 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11620 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11621 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11622 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11623 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11624 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11625 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11626 "description" : "The list of Orthanc identifiers of interest.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11627 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11628 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11629 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11630 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11631 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11632 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11633 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11634 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11635 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11636 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11637 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11638 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11639 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11640 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11641 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11642 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11643 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11644 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11645 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11646 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11647 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11648 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11649 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11650 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11651 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11652 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11653 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11654 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11655 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11656 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11657 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11658 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11659 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11660 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11661 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11662 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11663 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11664 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11665 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11666 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11667 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11668 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11669 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11670 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11671 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11672 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11673 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11674 "summary" : "Create ZIP archive",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11675 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11676 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11677 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11678 "/tools/create-dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11679 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11680 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11681 "description" : "Create one DICOM instance, and store it into Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11682 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11683 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11684 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11685 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11686 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11687 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11688 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11689 "Content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11690 "description" : "This field can be used to embed an image (pixel data) or a PDF inside the created DICOM instance. The PNG image, the JPEG image or the PDF file must be provided using their [data URI scheme encoding](https://en.wikipedia.org/wiki/Data_URI_scheme). This field can possibly contain a JSON array, in which case a DICOM series is created containing one DICOM instance for each item in the `Content` field.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11691 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11692 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11693 "InterpretBinaryTags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11694 "description" : "If some value in the `Tags` associative array is formatted according to some [data URI scheme encoding](https://en.wikipedia.org/wiki/Data_URI_scheme), whether this value is decoded to a binary value or kept as such (`true` by default)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11695 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11696 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11697 "Parent" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11698 "description" : "If present, the newly created instance will be attached to the parent DICOM resource whose Orthanc identifier is contained in this field. The DICOM tags of the parent modules in the DICOM hierarchy will be automatically copied to the newly created instance.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11699 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11700 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11701 "PrivateCreator" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11702 "description" : "The private creator to be used for private tags in `Tags`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11703 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11704 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11705 "Tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11706 "description" : "Associative array containing the tags of the new instance to be created",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11707 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11708 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11709 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11710 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11711 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11712 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11713 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11714 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11715 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11716 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11717 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11718 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11719 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11720 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11721 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11722 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11723 "description" : "Orthanc identifier of the newly created instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11724 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11725 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11726 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11727 "description" : "Path to access the instance in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11728 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11729 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11730 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11731 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11732 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11733 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11734 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11735 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11736 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11737 "summary" : "Create one DICOM instance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11738 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11739 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11740 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11741 "/tools/create-media" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11742 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11743 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11744 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11745 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11746 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11747 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11748 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11749 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11750 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11751 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11752 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11753 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11754 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11755 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11756 "Extended" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11757 "description" : "If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11758 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11759 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11760 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11761 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11762 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11763 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11764 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11765 "description" : "The list of Orthanc identifiers of interest.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11766 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11767 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11768 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11769 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11770 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11771 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11772 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11773 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11774 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11775 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11776 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11777 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11778 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11779 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11780 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11781 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11782 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11783 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11784 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11785 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11786 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11787 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11788 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11789 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11790 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11791 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11792 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11793 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11794 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11795 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11796 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11797 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11798 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11799 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11800 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11801 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11802 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11803 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11804 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11805 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11806 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11807 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11808 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11809 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11810 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11811 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11812 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11813 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11814 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11815 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11816 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11817 "/tools/create-media-extended" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11818 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11819 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11820 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11821 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11822 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11823 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11824 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11825 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11826 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11827 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11828 "Asynchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11829 "description" : "If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. Prefer this flavor wherever possible.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11830 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11831 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11832 "Extended" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11833 "description" : "If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `true`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11834 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11835 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11836 "Priority" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11837 "description" : "In asynchronous mode, the priority of the job. The lower the value, the higher the priority.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11838 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11839 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11840 "Resources" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11841 "description" : "The list of Orthanc identifiers of interest.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11842 "items" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11843 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11844 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11845 "type" : "array"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11846 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11847 "Synchronous" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11848 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior, but it is *not* be desirable to archive large amount of data, as it might lead to network timeouts.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11849 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11850 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11851 "Transcode" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11852 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11853 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11854 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11855 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11856 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11857 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11858 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11859 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11860 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11861 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11862 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11863 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11864 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11865 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11866 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11867 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11868 "ID" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11869 "description" : "Identifier of the job",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11870 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11871 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11872 "Path" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11873 "description" : "Path to access the job in the REST API",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11874 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11875 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11876 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11877 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11878 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11879 "application/zip" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11880 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11881 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11882 "description" : "In synchronous mode, the ZIP file containing the archive"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11883 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11884 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11885 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11886 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11887 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11888 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11889 "summary" : "Create DICOMDIR media",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11890 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11891 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11892 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11893 "/tools/default-encoding" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11894 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11895 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11896 "description" : "Get the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11897 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11898 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11899 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11900 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11901 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11902 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11903 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11904 "description" : "The name of the encoding"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11905 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11906 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11907 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11908 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11909 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11910 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11911 "summary" : "Get default encoding",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11912 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11913 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11914 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11915 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11916 "description" : "Change the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11917 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11918 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11919 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11920 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11921 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11922 "description" : "The name of the encoding. Check out configuration option `DefaultEncoding` for the allowed values."
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11923 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11924 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11925 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11926 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11927 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11928 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11929 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11930 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11931 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11932 "summary" : "Set default encoding",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11933 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11934 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11935 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11936 "/tools/dicom-conformance" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11937 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11938 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11939 "description" : "Get the DICOM conformance statement of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11940 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11941 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11942 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11943 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11944 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11945 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11946 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11947 "description" : "The DICOM conformance statement"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11948 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11949 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11950 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11951 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11952 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11953 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11954 "summary" : "Get DICOM conformance",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11955 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11956 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11957 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11958 "/tools/dicom-echo" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11959 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11960 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11961 "description" : "Trigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some `/modalities/{id}` (new in Orthanc 1.8.1)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11962 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11963 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11964 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11965 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11966 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11967 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11968 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11969 "AET" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11970 "description" : "AET of the remote DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11971 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11972 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11973 "CheckFind" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11974 "description" : "Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` configuration option. New in Orthanc 1.8.1.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11975 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11976 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11977 "Host" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11978 "description" : "Host address of the remote DICOM modality (typically, an IP address)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11979 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11980 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11981 "Manufacturer" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11982 "description" : "Manufacturer of the remote DICOM modality (check configuration option `DicomModalities` for possible values",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11983 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11984 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11985 "Port" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11986 "description" : "TCP port of the remote DICOM modality",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11987 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11988 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11989 "Timeout" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11990 "description" : "Timeout for the C-ECHO command, in seconds",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11991 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11992 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11993 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11994 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11995 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11996 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11997 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11998 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11999 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12000 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12001 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12002 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12003 "summary" : "Trigger C-ECHO SCU",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12004 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12005 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12006 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12007 "/tools/execute-script" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12008 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12009 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12010 "description" : "Execute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible, cf. configuration option `ExecuteLuaEnabled`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12011 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12012 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12013 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12014 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12015 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12016 "description" : "The Lua script to be executed"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12017 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12018 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12019 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12020 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12021 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12022 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12023 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12024 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12025 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12026 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12027 "description" : "Output of the Lua script"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12028 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12029 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12030 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12031 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12032 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12033 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12034 "summary" : "Execute Lua script",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12035 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12036 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12037 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12038 "/tools/find" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12039 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12040 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12041 "description" : "This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://book.orthanc-server.com/users/rest.html#performing-finds-within-orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12042 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12043 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12044 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12045 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12046 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12047 "description" : "",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12048 "properties" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12049 "CaseSensitive" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12050 "description" : "Enable case-sensitive search for PN value representations (defaults to configuration option `CaseSensitivePN`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12051 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12052 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12053 "Expand" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12054 "description" : "Also retrieve the content of the matching resources, not only their Orthanc identifiers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12055 "type" : "boolean"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12056 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12057 "Level" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12058 "description" : "Level of the query (`Patient`, `Study`, `Series` or `Instance`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12059 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12060 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12061 "Limit" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12062 "description" : "Limit the number of reported resources",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12063 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12064 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12065 "Query" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12066 "description" : "Associative array containing the filter on the values of the DICOM tags",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12067 "type" : "object"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12068 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12069 "Since" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12070 "description" : "Show only the resources since the provided index (in conjunction with `Limit`)",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12071 "type" : "number"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12072 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12073 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12074 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12075 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12076 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12077 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12078 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12079 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12080 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12081 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12082 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12083 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12084 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported resources (if `Expand` argument is `true`)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12085 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12086 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12087 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12088 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12089 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12090 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12091 "summary" : "Look for local resources",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12092 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12093 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12094 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12095 "/tools/generate-uid" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12096 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12097 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12098 "description" : "Generate a random DICOM identifier",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12099 "parameters" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12100 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12101 "description" : "Type of DICOM resource among: `patient`, `study`, `series` or `instance`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12102 "in" : "query",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12103 "name" : "level",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12104 "required" : true,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12105 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12106 "type" : "string"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12107 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12108 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12109 ],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12110 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12111 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12112 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12113 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12114 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12115 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12116 "description" : "The generated identifier"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12117 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12118 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12119 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12120 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12121 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12122 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12123 "summary" : "Generate an identifier",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12124 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12125 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12126 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12127 "/tools/invalidate-tags" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12128 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12129 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12130 "description" : "Remove all the attachments of the type \"DICOM-as-JSON\" that are associated will all the DICOM instances stored in Orthanc. These summaries will be automatically re-created on the next access. This is notably useful after changes to the `Dictionary` configuration option. https://book.orthanc-server.com/faq/orthanc-storage.html#storage-area",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12131 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12132 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12133 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12134 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12135 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12136 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12137 "summary" : "Invalidate DICOM-as-JSON summaries",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12138 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12139 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12140 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12141 "/tools/log-level" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12142 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12143 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12144 "description" : "Get the main log level of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12145 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12146 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12147 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12148 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12149 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12150 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12151 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12152 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12153 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12154 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12155 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12156 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12157 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12158 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12159 "summary" : "Get main log level",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12160 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12161 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12162 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12163 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12164 "description" : "Set the main log level of Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12165 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12166 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12167 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12168 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12169 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12170 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12171 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12172 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12173 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12174 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12175 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12176 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12177 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12178 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12179 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12180 "summary" : "Set main log level",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12181 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12182 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12183 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12184 "/tools/log-level-dicom" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12185 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12186 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12187 "description" : "Get the log level of the log category `dicom`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12188 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12189 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12190 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12191 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12192 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12193 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12194 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12195 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12196 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12197 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12198 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12199 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12200 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12201 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12202 "summary" : "Get log level for `dicom`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12203 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12204 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12205 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12206 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12207 "description" : "Set the log level of the log category `dicom`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12208 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12209 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12210 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12211 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12212 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12213 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12214 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12215 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12216 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12217 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12218 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12219 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12220 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12221 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12222 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12223 "summary" : "Set log level for `dicom`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12224 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12225 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12226 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12227 "/tools/log-level-generic" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12228 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12229 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12230 "description" : "Get the log level of the log category `generic`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12231 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12232 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12233 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12234 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12235 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12236 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12237 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12238 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12239 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12240 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12241 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12242 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12243 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12244 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12245 "summary" : "Get log level for `generic`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12246 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12247 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12248 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12249 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12250 "description" : "Set the log level of the log category `generic`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12251 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12252 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12253 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12254 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12255 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12256 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12257 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12258 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12259 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12260 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12261 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12262 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12263 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12264 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12265 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12266 "summary" : "Set log level for `generic`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12267 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12268 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12269 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12270 "/tools/log-level-http" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12271 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12272 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12273 "description" : "Get the log level of the log category `http`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12274 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12275 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12276 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12277 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12278 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12279 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12280 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12281 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12282 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12283 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12284 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12285 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12286 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12287 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12288 "summary" : "Get log level for `http`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12289 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12290 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12291 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12292 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12293 "description" : "Set the log level of the log category `http`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12294 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12295 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12296 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12297 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12298 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12299 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12300 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12301 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12302 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12303 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12304 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12305 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12306 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12307 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12308 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12309 "summary" : "Set log level for `http`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12310 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12311 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12312 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12313 "/tools/log-level-jobs" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12314 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12315 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12316 "description" : "Get the log level of the log category `jobs`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12317 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12318 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12319 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12320 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12321 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12322 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12323 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12324 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12325 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12326 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12327 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12328 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12329 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12330 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12331 "summary" : "Get log level for `jobs`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12332 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12333 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12334 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12335 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12336 "description" : "Set the log level of the log category `jobs`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12337 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12338 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12339 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12340 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12341 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12342 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12343 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12344 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12345 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12346 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12347 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12348 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12349 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12350 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12351 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12352 "summary" : "Set log level for `jobs`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12353 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12354 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12355 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12356 "/tools/log-level-lua" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12357 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12358 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12359 "description" : "Get the log level of the log category `lua`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12360 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12361 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12362 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12363 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12364 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12365 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12366 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12367 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12368 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12369 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12370 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12371 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12372 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12373 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12374 "summary" : "Get log level for `lua`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12375 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12376 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12377 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12378 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12379 "description" : "Set the log level of the log category `lua`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12380 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12381 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12382 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12383 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12384 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12385 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12386 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12387 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12388 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12389 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12390 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12391 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12392 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12393 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12394 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12395 "summary" : "Set log level for `lua`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12396 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12397 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12398 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12399 "/tools/log-level-plugins" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12400 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12401 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12402 "description" : "Get the log level of the log category `plugins`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12403 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12404 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12405 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12406 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12407 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12408 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12409 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12410 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12411 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12412 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12413 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12414 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12415 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12416 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12417 "summary" : "Get log level for `plugins`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12418 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12419 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12420 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12421 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12422 "description" : "Set the log level of the log category `plugins`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12423 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12424 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12425 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12426 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12427 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12428 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12429 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12430 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12431 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12432 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12433 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12434 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12435 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12436 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12437 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12438 "summary" : "Set log level for `plugins`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12439 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12440 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12441 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12442 "/tools/log-level-sqlite" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12443 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12444 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12445 "description" : "Get the log level of the log category `sqlite`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12446 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12447 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12448 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12449 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12450 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12451 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12452 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12453 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12454 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12455 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12456 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12457 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12458 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12459 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12460 "summary" : "Get log level for `sqlite`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12461 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12462 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12463 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12464 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12465 "description" : "Set the log level of the log category `sqlite`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12466 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12467 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12468 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12469 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12470 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12471 "description" : "Possible values: `default`, `verbose` or `trace`"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12472 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12473 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12474 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12475 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12476 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12477 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12478 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12479 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12480 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12481 "summary" : "Set log level for `sqlite`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12482 "tags" : [ "Logs" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12483 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12484 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12485 "/tools/lookup" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12486 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12487 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12488 "description" : "This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12489 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12490 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12491 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12492 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12493 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12494 "description" : "The DICOM identifier of interest (i.e. the value of `PatientID`, `StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`)"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12495 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12496 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12497 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12498 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12499 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12500 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12501 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12502 "application/json" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12503 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12504 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12505 "description" : "JSON array containing a list of matching Orthanc resources, each item in the list corresponding to a JSON object with the fields `Type`, `ID` and `Path` identifying one DICOM resource that is stored by Orthanc"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12506 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12507 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12508 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12509 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12510 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12511 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12512 "summary" : "Look for DICOM identifiers",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12513 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12514 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12515 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12516 "/tools/metrics" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12517 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12518 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12519 "description" : "Returns a Boolean specifying whether Prometheus metrics are collected and exposed at `/tools/metrics-prometheus`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12520 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12521 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12522 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12523 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12524 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12525 "examples" : {},
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12526 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12527 "description" : "`1` if metrics are collected, `0` if metrics are disabled"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12528 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12529 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12530 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12531 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12532 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12533 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12534 "summary" : "Are metrics collected?",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12535 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12536 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12537 "put" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12538 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12539 "description" : "Enable or disable the collection and publication of metrics at `/tools/metrics-prometheus`",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12540 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12541 "requestBody" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12542 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12543 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12544 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12545 "description" : "`1` if metrics are collected, `0` if metrics are disabled"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12546 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12547 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12548 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12549 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12550 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12551 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12552 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12553 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12554 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12555 "summary" : "Enable collection of metrics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12556 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12557 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12558 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12559 "/tools/metrics-prometheus" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12560 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12561 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12562 "description" : "Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://book.orthanc-server.com/users/advanced-rest.html#instrumentation-with-prometheus",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12563 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12564 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12565 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12566 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12567 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12568 "example" : "orthanc_count_instances 2552 1609310738535\northanc_count_patients 8 1609310738535\northanc_count_series 26 1609310738535\northanc_count_studies 8 1609310738535\northanc_disk_size_mb 1018.65021 1609310738535\northanc_jobs_completed 10 1609310738535\northanc_jobs_failed 0 1609310738535\northanc_jobs_pending 0 1609310738535\northanc_jobs_running 0 1609310738535\northanc_jobs_success 10 1609310738535\northanc_rest_api_active_requests 1 1609310738534\northanc_rest_api_duration_ms 305 1609310737152\northanc_storage_read_duration_ms 2 1609310732748\northanc_uncompressed_size_mb 1018.65021 1609310738535\n"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12569 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12570 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12571 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12572 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12573 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12574 "summary" : "Get usage metrics",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12575 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12576 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12577 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12578 "/tools/now" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12579 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12580 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12581 "description" : "Get UTC time",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12582 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12583 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12584 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12585 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12586 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12587 "example" : "20201230T064538",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12588 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12589 "description" : "The UTC time"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12590 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12591 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12592 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12593 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12594 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12595 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12596 "summary" : "Get UTC time",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12597 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12598 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12599 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12600 "/tools/now-local" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12601 "get" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12602 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12603 "description" : "Get local time",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12604 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12605 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12606 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12607 "content" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12608 "text/plain" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12609 "example" : "20201230T064538",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12610 "schema" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12611 "description" : "The local time"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12612 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12613 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12614 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12615 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12616 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12617 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12618 "summary" : "Get local time",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12619 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12620 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12621 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12622 "/tools/reconstruct" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12623 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12624 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12625 "description" : "Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated.",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12626 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12627 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12628 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12629 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12630 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12631 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12632 "summary" : "Reconstruct all the index",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12633 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12634 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12635 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12636 "/tools/reset" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12637 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12638 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12639 "description" : "Restart Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12640 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12641 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12642 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12643 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12644 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12645 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12646 "summary" : "Restart Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12647 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12648 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12649 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12650 "/tools/shutdown" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12651 "post" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12652 "deprecated" : false,
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12653 "description" : "Shutdown Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12654 "parameters" : [],
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12655 "responses" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12656 "200" : {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12657 "description" : ""
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12658 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12659 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12660 "summary" : "Shutdown Orthanc",
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12661 "tags" : [ "System" ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12662 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12663 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12664 },
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12665 "servers" : [
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12666 {
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12667 "url" : "https://demo.orthanc-server.com/"
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12668 }
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12669 ]
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12670 }