Mercurial > hg > orthanc-book
annotate OpenAPI/orthanc-openapi.yaml @ 287:eeb2c72dd5df
api doc: asynchronous
author | Alain Mazy <alain@mazy.be> |
---|---|
date | Tue, 24 Sep 2019 17:44:21 +0200 |
parents | 833d4ec1c1e8 |
children | 2e71e7cc0ec5 |
rev | line source |
---|---|
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 openapi: 3.0.0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 info: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 title: Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 version: 1.0.0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 description: >- |
273 | 6 One of the major strengths of Orthanc lies in its built-in RESTful API, that can be used to drive Orthanc from external applications, independently of the programming language that is used to develop these applications. The REST API of Orthanc gives a full programmatic access to all the core features of Orthanc. Importantly, Orthanc Explorer (the embedded administrative interface of Orthanc) entirely resorts to this REST API for all its features. This implies that anything that can be done through Orthanc Explorer, can also be done through REST queries.<p> |
275 | 7 This documentation is <b>work-in-progress</b>: The entire REST API is not covered yet. Please contribute by improving the source code of the documentation: https://bitbucket.org/sjodogne/orthanc-book/src/default/ |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 servers: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
9 - url: 'https://demo.orthanc-server.com' |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
10 components: |
286 | 11 |
12 #################################################################################### | |
13 ## SCHEMAS / MODELS | |
14 #################################################################################### | |
15 | |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
16 schemas: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
17 patient: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
18 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
19 ID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
20 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
21 Studies: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
22 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
23 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
24 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
25 MainDicomTags: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
26 type: object |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
27 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
28 OtherPatientIDs: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
29 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
30 PatientBirthDate: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
31 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
32 PatientName: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
33 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
34 PatientSex: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
35 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
36 ParentPatient: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
37 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
38 Type: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
39 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
40 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
41 - Patient |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
42 example: { |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
43 "ID" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
44 "MainDicomTags" : { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
45 "OtherPatientIDs" : "(null)", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
46 "PatientBirthDate" : "0", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
47 "PatientID" : "000000185", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
48 "PatientName" : "Anonymous^Unknown", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
49 "PatientSex" : "O" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
50 }, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
51 "Studies" : [ "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15" ], |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
52 "Type" : "Patient" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
53 } |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
54 study: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
55 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
56 ID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
57 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
58 Series: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
59 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
60 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
61 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
62 MainDicomTags: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
63 type: object |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
64 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
65 AccesionNumber: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
66 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
67 StudyDate: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
68 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
69 StudyDescription: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
70 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
71 StudyID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
72 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
73 StudyInstanceUID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
74 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
75 StudyTime: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
76 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
77 ParentPatient: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
78 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
79 Type: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
80 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
81 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
82 - Study |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
83 example: { |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
84 "ID" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
85 "MainDicomTags" : { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
86 "AccessionNumber" : "(null)", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
87 "StudyDate" : "20120716", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
88 "StudyDescription" : "TestSUVce-TF", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
89 "StudyID" : "23848", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
90 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
91 "StudyTime" : "170728" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
92 }, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
93 "ParentPatient" : "07a6ec1c-1be5920b-18ef5358-d24441f3-10e926ea", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
94 "Series" : [ |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
95 "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
96 "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
97 "7384c47e-6398f2a8-901846ef-da1e2e0b-6c50d598" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
98 ], |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
99 "Type" : "Study" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
100 } |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
101 series: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
102 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
103 ID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
104 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
105 ExpectedNumberOfInstances: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
106 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
107 Instances: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
108 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
109 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
110 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
111 MainDicomTags: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
112 type: object |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
113 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
114 Manufacturer: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
115 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
116 Modality: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
117 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
118 NumberOfSlices: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
119 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
120 ProtocolName: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
121 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
122 SeriesDate: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
123 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
124 SeriesDescription: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
125 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
126 SeriesInstanceUID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
127 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
128 SeriesNumber: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
129 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
130 SeriesTime: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
131 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
132 StationName: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
133 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
134 ParentStudy: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
135 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
136 Type: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
137 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
138 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
139 - Series |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
140 Status: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
141 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
142 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
143 - Complete |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
144 example: { |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
145 "ExpectedNumberOfInstances" : 45, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
146 "ID" : "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
147 "Instances" : [ |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
148 "41bc3f74-360f9d10-6ae9ffa4-01ea2045-cbd457dd", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
149 "1d3de868-6c4f0494-709fd140-7ccc4c94-a6daa3a8", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
150 "1010f80b-161b71c0-897ec01b-c85cd206-e669a3ea", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
151 "e668dcbf-8829a100-c0bd203b-41e404d9-c533f3d4" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
152 ], |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
153 "MainDicomTags" : { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
154 "Manufacturer" : "Philips Medical Systems", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
155 "Modality" : "PT", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
156 "NumberOfSlices" : "45", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
157 "ProtocolName" : "CHU/Body_PET/CT___50", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
158 "SeriesDate" : "20120716", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
159 "SeriesDescription" : "[WB_CTAC] Body", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
160 "SeriesInstanceUID" : "1.3.46.670589.28.2.12.30.26407.37145.2.2516.0.1342458737", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
161 "SeriesNumber" : "587370", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
162 "SeriesTime" : "171121", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
163 "StationName" : "r054-svr" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
164 }, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
165 "ParentStudy" : "9ad2b0da-a406c43c-6e0df76d-1204b86f-78d12c15", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
166 "Status" : "Complete", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
167 "Type" : "Series" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
168 } |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
169 instance: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
170 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
171 FileSize: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
172 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
173 FileUuid: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
174 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
175 ID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
176 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
177 IndexInSeries: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
178 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
179 MainDicomTags: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
180 type: object |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
181 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
182 AcquisitionNumber: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
183 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
184 ImageIndex: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
185 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
186 ImagePositionPatient: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
187 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
188 InstanceNumber: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
189 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
190 SOPInstanceUID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
191 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
192 ParentSeries: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
193 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
194 Type: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
195 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
196 - Instance |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
197 example: { |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
198 "FileSize" : 35440, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
199 "FileUuid" : "7976ad32-4d15-439b-8789-bf70f52200ec", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
200 "ID" : "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
201 "IndexInSeries" : 59, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
202 "MainDicomTags" : { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
203 "AcquisitionNumber" : "2", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
204 "ImageIndex" : "59", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
205 "ImagePositionPatient" : "-134.74816\\-272.14441\\-712.764", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
206 "InstanceNumber" : "59", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
207 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
208 }, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
209 "ParentSeries" : "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
210 "Type" : "Instance" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
211 } |
286 | 212 |
213 | |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
214 jobId: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
215 properties: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
216 ID: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
217 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
218 Path: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
219 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
220 example: { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
221 "ID": "11541b16-e368-41cf-a8e9-3acf4061d238", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
222 "Path": "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
223 } |
286 | 224 |
225 | |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
226 jobCStore: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
227 properties: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
228 Description: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
229 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
230 FailedInstancesCount: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
231 type: number |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
232 InstancesCount: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
233 type: number |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
234 LocalAet: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
235 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
236 RemoteAet: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
237 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
238 example: { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
239 "Description": "REST API", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
240 "FailedInstancesCount": 0, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
241 "InstancesCount": 1, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
242 "LocalAet": "ORTHANCA", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
243 "RemoteAet": "ORTHANCB" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
244 } |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
245 jobPeerStore: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
246 properties: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
247 Description: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
248 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
249 FailedInstancesCount: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
250 type: number |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
251 InstancesCount: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
252 type: number |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
253 Peer: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
254 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
255 example: { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
256 "Description": "REST API", |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
257 "FailedInstancesCount": 0, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
258 "InstancesCount": 1, |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
259 "Peer": [ |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
260 "http://127.0.0.1:8543/" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
261 ] |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
262 } |
286 | 263 |
264 | |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
265 listOfResourcesWithAsynchOption: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
266 properties: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
267 Resources: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
268 description: A list of resources IDs (Patient, Studies, Series or Instances) |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
269 type: array |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
270 items: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
271 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
272 Asynchronous: |
287 | 273 description: true to create a job and return immediately, false to wait for job completion. |
274 The response will vary according to this parameter. If the call is synchronous, you'll receive | |
275 a completed job in the response while if the call is asynchronous, you'll receive a job identifier. | |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
276 type: boolean |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
277 example: { |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
278 "Resources" : ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"], |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
279 "Asynchronous" : true |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
280 } |
286 | 281 |
282 | |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
283 listOfResources: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
284 description: A list of resources IDs (Patient, Studies, Series or Instances) |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
285 schema: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
286 type: array |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
287 items: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
288 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
289 example: ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"] |
286 | 290 |
291 | |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
292 singleResource: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
293 description: A resource ID (Patient, Studies, Series or Instances) |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
294 type: string |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
295 example: "62cdfbea-07c71f0c-cd643b19-841a306a-01221339" |
286 | 296 |
297 #################################################################################### | |
298 ## ROUTES / PATHS | |
299 #################################################################################### | |
300 | |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
301 paths: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
302 /instances: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
303 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
304 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
305 description: The upload of DICOM files is possible by querying the REST API using the following syntax. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
306 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
307 description: DICOM file |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
308 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
309 application/dicom: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
310 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
311 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
312 description: New instance successfully posted |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
313 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
314 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
315 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
316 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
317 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
318 description: New Orthanc instance ID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
319 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
320 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
321 description: URL path for the instance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
322 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
323 Status: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
324 description: Status |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
325 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
326 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
327 - Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
328 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
329 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
330 description: Get all DICOM instances ID's in Orthanc |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
331 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
332 - name: limit |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
333 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
334 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
335 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
336 description: Limit the number of results to the specified. number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
337 - name: since |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
338 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
339 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
340 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
341 description: Show only the resources since the index provided. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
342 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
343 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
344 description: Array of all instances ID's |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
345 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
346 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
347 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
348 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
349 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
350 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
351 example: [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
352 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
353 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
354 ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
355 /instances/{Id}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
356 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
357 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
358 description: Get an instance from Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
359 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
360 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
361 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
362 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
363 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
364 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
365 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
366 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
367 description: Orthanc instance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
368 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
369 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
370 schema: |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
371 $ref: "#/components/schemas/instance" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
372 delete: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
373 tags : [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
374 description: Delete an instance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
375 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
376 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
377 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
378 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
379 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
380 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
381 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
382 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
383 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
384 /instances/{Id}/simplified-tags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
385 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
386 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
387 description: Get the human readable tags for the DICOM instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
388 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
389 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
390 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
391 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
392 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
393 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
394 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
395 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
396 description: DICOM tags and values |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
397 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
398 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
399 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
400 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
401 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
402 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
403 "AccessionNumber" : null, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
404 "AcquisitionDate" : "20120716", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
405 "AcquisitionDateTime" : "20120716171219", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
406 "AcquisitionTime" : "171219", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
407 "ActualFrameDuration" : "3597793", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
408 "AttenuationCorrectionMethod" : "CTAC-SG", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
409 "PatientID" : "000000185", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
410 "PatientName" : "Anonymous^Unknown", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
411 "PatientOrientationCodeSequence" : [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
412 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
413 "CodeMeaning" : "recumbent", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
414 "CodeValue" : "F-10450", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
415 "CodingSchemeDesignator" : "99SDM", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
416 "PatientOrientationModifierCodeSequence" : [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
417 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
418 "CodeMeaning" : "supine", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
419 "CodeValue" : "F-10340", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
420 "CodingSchemeDesignator" : "99SDM" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
421 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
422 ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
423 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
424 ], |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
425 "StudyDescription" : "TestSUVce-TF", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
426 "StudyID" : "23848", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
427 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
428 "StudyTime" : "171117", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
429 "TypeOfDetectorMotion" : "NONE", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
430 "Units" : "BQML", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
431 "Unknown" : null, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
432 "WindowCenter" : "1.496995e+04", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
433 "WindowWidth" : "2.993990e+04" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
434 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
435 /instances/{Id}/tags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
436 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
437 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
438 description: Get the detailed tags for the DICOM instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
439 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
440 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
441 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
442 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
443 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
444 type: string |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
445 - name: simplify |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
446 required: false |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
447 description: Show more user-friendly tags like in /simplified-tags |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
448 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
449 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
450 type: boolean |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
451 - name: short |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
452 required: false |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
453 description: Shorten the values so that they are not separate JSON objects with the user-friendly description of the tag and the type. Instead, values are given as direct values to the tags. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
454 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
455 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
456 type: boolean |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
457 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
458 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
459 description: DICOM tags and values |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
460 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
461 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
462 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
463 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
464 example: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
465 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
466 "0008,0005" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
467 "Name" : "SpecificCharacterSet", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
468 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
469 "Value" : "ISO_IR 100" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
470 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
471 "0008,0008" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
472 "Name" : "ImageType", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
473 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
474 "Value" : "ORIGINAL\\PRIMARY\\HEADER_CORRECTED" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
475 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
476 "0008,0016" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
477 "Name" : "SOPClassUID", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
478 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
479 "Value" : "1.2.840.10008.5.1.4.1.1.128" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
480 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
481 "0008,0018" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
482 "Name" : "SOPInstanceUID", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
483 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
484 "Value" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
485 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
486 "0008,0020" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
487 "Name" : "StudyDate", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
488 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
489 "Value" : "20040304" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
490 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
491 "0008,0021" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
492 "Name" : "SeriesDate", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
493 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
494 "Value" : "20040304" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
495 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
496 "0008,0022" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
497 "Name" : "AcquisitionDate", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
498 "Type" : "String", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
499 "Value" : "20040304" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
500 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
501 } |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
502 /instances/{Id}/header: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
503 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
504 tags: [Instances] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
505 description: Get the detailed header tags for the DICOM instance. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
506 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
507 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
508 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
509 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
510 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
511 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
512 - name: simplify |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
513 required: false |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
514 description: Show more user-friendly tags like in /simplified-tags |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
515 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
516 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
517 type: boolean |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
518 - name: short |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
519 required: false |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
520 description: Shorten the values so that they are not separate JSON objects with the user-friendly description of the tag and the type. Instead, values are given as direct values to the tags. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
521 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
522 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
523 type: boolean |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
524 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
525 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
526 description: DICOM tags and values |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
527 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
528 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
529 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
530 type: object |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
531 example: { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
532 "0002,0000" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
533 "Name" : "FileMetaInformationGroupLength", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
534 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
535 "Value" : "222" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
536 }, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
537 "0002,0002" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
538 "Name" : "MediaStorageSOPClassUID", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
539 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
540 "Value" : "1.2.840.10008.5.1.4.1.1.128" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
541 }, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
542 "0002,0003" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
543 "Name" : "MediaStorageSOPInstanceUID", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
544 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
545 "Value" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
546 }, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
547 "0002,0010" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
548 "Name" : "TransferSyntaxUID", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
549 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
550 "Value" : "1.2.840.10008.1.2.1" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
551 }, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
552 "0002,0012" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
553 "Name" : "ImplementationClassUID", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
554 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
555 "Value" : "1.2.826.0.1.3680043.2.1143.107.104.103.115.2.2.4" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
556 }, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
557 "0002,0013" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
558 "Name" : "ImplementationVersionName", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
559 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
560 "Value" : "GDCM 2.2.4" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
561 }, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
562 "0002,0016" : { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
563 "Name" : "SourceApplicationEntityTitle", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
564 "Type" : "String", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
565 "Value" : "gdcmconv" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
566 } |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
567 } |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
568 /instances/{Id}/content/{Tag}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
569 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
570 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
571 description: Get the value for a single tag of a DICOM instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
572 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
573 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
574 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
575 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
576 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
577 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
578 - name: Tag |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
579 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
580 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
581 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
582 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
583 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
584 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
585 description: Returns the DICOM tag value or value sub-structure. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
586 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
587 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
588 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
589 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
590 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
591 example: Anonymous^Unknown |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
592 /instances/{Id}/file: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
593 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
594 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
595 description: Download the DICOM instance file in DCM format. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
596 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
597 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
598 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
599 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
600 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
601 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
602 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
603 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
604 description: DICOM file contents |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
605 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
606 application/dicom: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
607 /instances/{Id}/preview: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
608 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
609 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
610 description: Download a preview image of the DICOM instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
611 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
612 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
613 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
614 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
615 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
616 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
617 - name: Accept |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
618 description: Default is image/png |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
619 required: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
620 in: header |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
621 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
622 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
623 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
624 - image/png |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
625 - image/jpeg |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
626 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
627 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
628 description: DICOM preview |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
629 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
630 image/png: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
631 image/jpg: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
632 /instances/{Id}/{PixelFormat}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
633 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
634 tags: [Instances] |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
635 description: Download an image of the DICOM instance in the specified format. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
636 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
637 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
638 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
639 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
640 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
641 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
642 - name: PixelFormat |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
643 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
644 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
645 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
646 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
647 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
648 - image-uint8 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
649 - image-uint16 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
650 - image-int16 |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
651 - matlab |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
652 - raw |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
653 - raw.gz |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
654 - name: Accept |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
655 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
656 in: header |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
657 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
658 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
659 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
660 - image/png |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
661 - image/jpeg |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
662 - image/x-portable-arbitrarymap |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
663 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
664 200: |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
665 description: Image |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
666 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
667 image/png: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
668 image/jpg: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
669 image/x-portable-arbitrarymap: {} |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
670 application/octet-stream: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
671 text/plain: {} |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
672 /instances/{Id}/pdf: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
673 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
674 tags: [Instances] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
675 description: Download the embedded PDF of the DICOM instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
676 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
677 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
678 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
679 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
680 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
681 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
682 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
683 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
684 description: The raw PDF bytes are returned. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
685 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
686 application/pdf: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
687 404: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
688 description: The instance does not contain an encapsulated PDF or the instance is not found. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
689 /series: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
690 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
691 tags: [Series] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
692 description: Get all DICOM series ID's in Orthanc |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
693 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
694 - name: limit |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
695 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
696 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
697 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
698 description: Limit the number of results to the specified. number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
699 - name: since |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
700 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
701 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
702 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
703 description: Show only the resources since the index provided. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
704 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
705 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
706 description: Array of all series ID's |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
707 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
708 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
709 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
710 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
711 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
712 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
713 example: [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
714 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
715 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
716 ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
717 /series/{Id}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
718 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
719 tags: [Series] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
720 description: Get a series from Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
721 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
722 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
723 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
724 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
725 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
726 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
727 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
728 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
729 description: Orthanc series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
730 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
731 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
732 schema: |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
733 $ref: "#/components/schemas/series" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
734 delete: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
735 tags : [Series] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
736 description: Delete a series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
737 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
738 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
739 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
740 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
741 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
742 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
743 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
744 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
745 description: Success |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
746 /series/{Id}/instances: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
747 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
748 tags: [Series] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
749 description: Get the instances for a series |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
750 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
751 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
752 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
753 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
754 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
755 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
756 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
757 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
758 description: Orthanc instances |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
759 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
760 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
761 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
762 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
763 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
764 $ref: "#/components/schemas/instance" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
765 |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
766 /studies: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
767 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
768 tags: [Studies] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
769 description: Get all DICOM studies ID's in Orthanc |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
770 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
771 - name: limit |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
772 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
773 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
774 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
775 description: Limit the number of results to the specified. number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
776 - name: since |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
777 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
778 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
779 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
780 description: Show only the resources since the index provided. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
781 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
782 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
783 description: Array of all study ID's |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
784 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
785 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
786 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
787 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
788 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
789 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
790 example: [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
791 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
792 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
793 ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
794 /studies/{Id}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
795 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
796 tags: [Studies] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
797 description: Get a study from Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
798 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
799 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
800 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
801 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
802 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
803 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
804 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
805 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
806 description: Orthanc study |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
807 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
808 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
809 schema: |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
810 $ref: "#/components/schemas/study" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
811 delete: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
812 tags : [Studies] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
813 description: Delete a study |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
814 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
815 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
816 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
817 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
818 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
819 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
820 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
821 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
822 description: Success |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
823 /studies/{Id}/series: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
824 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
825 tags: [Studies] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
826 description: Get the series for a study |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
827 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
828 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
829 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
830 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
831 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
832 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
833 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
834 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
835 description: Orthanc series |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
836 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
837 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
838 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
839 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
840 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
841 $ref: "#/components/schemas/series" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
842 /studies/{Id}/instances: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
843 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
844 tags: [Studies] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
845 description: Get the instances for a study |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
846 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
847 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
848 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
849 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
850 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
851 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
852 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
853 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
854 description: Orthanc instances |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
855 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
856 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
857 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
858 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
859 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
860 $ref: "#/components/schemas/instance" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
861 |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
862 /patients: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
863 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
864 tags: [Patients] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
865 description: Get all DICOM patient ID's in Orthanc |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
866 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
867 - name: limit |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
868 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
869 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
870 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
871 description: Limit the number of results to the specified. number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
872 - name: since |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
873 in: query |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
874 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
875 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
876 description: Show only the resources since the index provided. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
877 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
878 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
879 description: Array of all patient ID's |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
880 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
881 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
882 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
883 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
884 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
885 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
886 example: [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
887 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
888 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
889 ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
890 /patients/{Id}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
891 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
892 tags: [Patients] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
893 description: Get a patient from Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
894 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
895 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
896 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
897 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
898 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
899 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
900 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
901 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
902 description: Orthanc patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
903 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
904 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
905 schema: |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
906 $ref: "#/components/schemas/patient" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
907 delete: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
908 tags : [Patients] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
909 description: Delete a patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
910 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
911 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
912 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
913 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
914 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
915 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
916 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
917 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
918 description: Success |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
919 /patients/{Id}/studies: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
920 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
921 tags: [Patients] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
922 description: Get the studies for a patient |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
923 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
924 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
925 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
926 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
927 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
928 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
929 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
930 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
931 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
932 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
933 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
934 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
935 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
936 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
937 $ref: "#/components/schemas/study" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
938 /patients/{Id}/series: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
939 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
940 tags: [Patients] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
941 description: Get the series for a patient |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
942 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
943 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
944 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
945 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
946 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
947 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
948 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
949 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
950 description: Orthanc series |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
951 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
952 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
953 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
954 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
955 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
956 $ref: "#/components/schemas/series" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
957 /patients/{Id}/instances: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
958 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
959 tags: [Patients] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
960 description: Get the instances for a patient |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
961 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
962 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
963 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
964 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
965 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
966 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
967 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
968 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
969 description: Orthanc instances |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
970 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
971 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
972 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
973 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
974 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
975 $ref: "#/components/schemas/instance" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
976 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
977 /peers: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
978 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
979 tags: [Orthanc Peers] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
980 description: Get a list of Orthanc peers. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
981 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
982 - name: expand |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
983 in: query |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
984 required: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
985 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
986 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
987 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
988 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
989 description: List of Orthanc peers |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
990 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
991 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
992 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
993 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
994 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
995 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
996 /peers/{Peer}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
997 put: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
998 tags: [Orthanc Peers] |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
999 summary: Add a new Orthanc peer. |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1000 description: Note that this will only be stored in memory unless the 'OrthancPeersInDatabase' configuration option is set. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1001 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1002 - name: Peer |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1003 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1004 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1005 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1006 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1007 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1008 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1009 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1010 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1011 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1012 Url: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1013 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1014 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1015 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1016 description: Peer created |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1017 /peers/{Peer}/store: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1018 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1019 tags: [Orthanc Peers] |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1020 summary: Send resources to an Orthanc peer. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1021 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1022 - name: Peer |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1023 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1024 required: true |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1025 description: the peer alias as defined in the Orthanc configuration file |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1026 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1027 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1028 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1029 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1030 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1031 schema: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1032 oneOf: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1033 - $ref: "#/components/schemas/listOfResourcesWithAsynchOption" |
286 | 1034 - $ref: "#/components/schemas/listOfResources" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1035 text/plain: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1036 schema: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1037 $ref: "#/components/schemas/singleResource" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1038 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1039 200: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1040 description: Jobs that have been created |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1041 content: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1042 application/json: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1043 schema: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1044 oneOf: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1045 - $ref: "#/components/schemas/jobId" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1046 - $ref: "#/components/schemas/jobPeerStore" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1047 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1048 /modalities/{Modality}/store: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1049 post: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1050 tags: [Remote Modalities] |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1051 summary: Send resources from Orthanc to a remote modality through C-Store. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1052 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1053 - name: Modality |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1054 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1055 required: true |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1056 description: the modality alias where you want to send data (as defined in the Orthanc configuration file) |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1057 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1058 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1059 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1060 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1061 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1062 schema: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1063 oneOf: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1064 - $ref: "#/components/schemas/listOfResourcesWithAsynchOption" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1065 - $ref: "#/components/schemas/listOfResources" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1066 text/plain: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1067 schema: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1068 $ref: "#/components/schemas/singleResource" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1069 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1070 200: |
285
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1071 description: Jobs that have been created |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1072 content: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1073 application/json: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1074 schema: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1075 oneOf: |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1076 - $ref: "#/components/schemas/jobId" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1077 - $ref: "#/components/schemas/jobCStore" |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1078 |
45ed5ab7f92a
documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents:
275
diff
changeset
|
1079 |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1080 /modalities/{Modality}/query: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1081 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1082 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1083 description: To initiate a query you perform a POST command against the Modality with the identifiers you are looking for. This search is case insensitive unless configured otherwise within the Orthanc configuration file. Note that queries are cleaned up after a period of inactivity, which can sometimes be very short. You will need to access the query results quickly. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1084 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1085 - name: Modality |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1086 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1087 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1088 description: The Modality to be queried from within the Orthanc configuration file |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1089 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1090 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1091 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1092 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1093 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1094 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1095 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1096 Level: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1097 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1098 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1099 - Patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1100 - Study |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1101 - Series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1102 - Instance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1103 Query: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1104 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1105 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1106 PatientID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1107 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1108 StudyDescription: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1109 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1110 description: Match the study description. Note that wildcard "*" can be used to match any text (eg. "*Chest*"). |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1111 PatientName: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1112 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1113 StudyDate: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1114 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1115 description: This is the study date in the format "20160504". Note that ranges can be used using a hyphen (eg. "20160504-" and "20160504-20170504"). |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1116 StudyTime: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1117 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1118 required: [Level, Query] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1119 example: {"Level":"Study","Query": {"PatientID":"","StudyDescription":"*Chest*","PatientName":""}} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1120 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1121 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1122 description: Query successful |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1123 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1124 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1125 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1126 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1127 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1128 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1129 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1130 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1131 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1132 "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1133 "Path": "/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1134 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1135 /queries/{QueryID}/level: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1136 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1137 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1138 description: Review the query level, such as Patient, Study, Series or Instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1139 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1140 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1141 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1142 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1143 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1144 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1145 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1146 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1147 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1148 description: Return the level of the query, whether Patient, Study, Series or Instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1149 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1150 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1151 example: Series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1152 /queries/{QueryID}/modality: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1153 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1154 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1155 description: Review the query modality name that the query was originally performed against. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1156 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1157 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1158 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1159 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1160 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1161 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1162 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1163 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1164 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1165 description: Return the name of the modality that the query was run against. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1166 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1167 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1168 example: SomeModalityName |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1169 /queries/{QueryID}/query: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1170 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1171 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1172 description: Review the query that was posted. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1173 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1174 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1175 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1176 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1177 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1178 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1179 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1180 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1181 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1182 description: Return the query identifiers that were used originally when it was posted. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1183 /queries/{QueryID}/answers: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1184 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1185 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1186 description: Review the query answers. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1187 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1188 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1189 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1190 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1191 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1192 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1193 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1194 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1195 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1196 description: Return the query answers. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1197 /queries/{QueryID}/answers/{Idx}/content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1198 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1199 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1200 description: Review a specific query answer. If there are content items missing, you may add them by adding that identifier to the original query. For example if we wanted Modalities listed in this JSON answer in the initial query we would add to the POST body "ModalitiesInStudy":"" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1201 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1202 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1203 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1204 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1205 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1206 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1207 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1208 - name: Idx |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1209 description: This is the index of a specific answer in the list of answers of the query. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1210 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1211 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1212 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1213 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1214 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1215 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1216 description: Return a single query answer |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1217 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1218 application/json: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1219 /queries/{QueryID}/retrieve: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1220 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1221 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1222 description: You can perform a C-Move to retrieve all studies within the original query using a post command and identifying the Modality (named in this example Orthanc), to be one to in the POST contents. The C-Move can be done asynchronously using an Orthanc job using a JSON parameter in the request body. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1223 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1224 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1225 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1226 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1227 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1228 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1229 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1230 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1231 description: The request body is the name of the modality to perform the C-Move or a JSON structure with additional information. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1232 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1233 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1234 example: Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1235 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1236 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1237 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1238 TargetAet: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1239 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1240 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1241 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1242 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1243 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1244 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1245 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1246 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1247 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1248 example: {"TargetAet":"Orthanc","Synchronous":false} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1249 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1250 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1251 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1252 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1253 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1254 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1255 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1256 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1257 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1258 description: The ID of the job if the retrieve is asynchronous (ie. Synchronous is set to true) |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1259 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1260 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1261 description: The URL path of the job if the retrieve is asynchronous (ie. Synchronous is set to false) |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1262 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1263 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1264 "Path" : "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1265 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1266 /queries/{QueryID}/answers/{Idx}/retrieve: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1267 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1268 tags: [Remote Modalities] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1269 description: You can perform a C-Move to retrieve a specific study within the original query using a post command and identifying the Modality (named in this example Orthanc), to be one to in the POST contents. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1270 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1271 - name: QueryID |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1272 description: This is the query ID that comes from posting a query to the modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1273 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1274 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1275 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1276 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1277 - name: Idx |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1278 description: This is the index of a specific answer in the list of answers of the query. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1279 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1280 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1281 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1282 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1283 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1284 description: The request body is the name of the modality to perform the C-Move. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1285 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1286 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1287 example: Orthanc |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1288 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1289 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1290 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1291 /tools/find: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1292 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1293 tags: [Find] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1294 description: Performing a find within Orthanc is very similar to using Queries against DICOM modalities and the additional options listed above work with find also. When performing a find, you will receive the Orthanc ID’s of all the matched items within your find. For example if you perform a study level find and 5 Studies match you will receive 5 study level Orthanc ID’s in JSON format as a response. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1295 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1296 description: The request body gives the parameters for the find much like when querying a remote modality. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1297 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1298 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1299 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1300 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1301 Level: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1302 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1303 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1304 - Patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1305 - Study |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1306 - Series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1307 - Instance |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1308 Expand: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1309 type: boolean |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1310 description: Returns an array of resources instead of just ID's. |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1311 Limit: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1312 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1313 Query: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1314 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1315 Modality: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1316 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1317 StudyDate: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1318 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1319 PatientID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1320 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1321 example: {"Level":"Instance","Limit": 2, "Query":{"Modality":"CR","StudyDate":"20180323-","PatientID":"*"}} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1322 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1323 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1324 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1325 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1326 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1327 schema: |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1328 oneOf: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1329 - type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1330 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1331 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1332 - type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1333 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1334 $ref: "#/components/schemas/instance" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1335 - type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1336 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1337 $ref: "#/components/schemas/series" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1338 - type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1339 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1340 $ref: "#/components/schemas/study" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1341 - type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1342 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1343 $ref: "#/components/schemas/patient" |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1344 example: [ "6821d761-31fb55a9-031ebecb-ba7f9aae-ffe4ddc0", "2cc6336f-2d4ae733-537b3ca3-e98184b1-ba494b35" ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1345 /changes: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1346 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1347 tags: [Tracking Changes] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1348 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1349 - name: limit |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1350 description: Limit the number of changes to a maximum of the provided number. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1351 in: query |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1352 required: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1353 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1354 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1355 - name: since |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1356 description: Show only changes that have happened after the change with the provided sequence number. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1357 in: query |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1358 required: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1359 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1360 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1361 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. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1362 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1363 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1364 description: The list of recent changes |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1365 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1366 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1367 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1368 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1369 Changes: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1370 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1371 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1372 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1373 ChangeType: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1374 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1375 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1376 - NewPatient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1377 - NewStudy |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1378 - NewSeries |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1379 - NewInstance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1380 - StablePatient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1381 - StableStudy |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1382 - StableSeries |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1383 - StableInstance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1384 Date: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1385 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1386 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1387 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1388 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1389 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1390 ResourceType: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1391 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1392 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1393 - Patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1394 - Study |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1395 - Series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1396 - Instance |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1397 Seq: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1398 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1399 Done: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1400 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1401 description: The flag Done is set to true if no further event has occurred after this lastly returned event. If Done is set to false, further events are available and can be retrieved. This is done by setting the since option that specifies from which sequence number the changes must be returned. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1402 Last: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1403 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1404 description: The flag Last records the sequence number of the lastly returned event. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1405 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1406 "Changes" : [ |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1407 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1408 "ChangeType" : "NewInstance", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1409 "Date" : "20130507T143902", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1410 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1411 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1412 "ResourceType" : "Instance", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1413 "Seq" : 921 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1414 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1415 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1416 "ChangeType" : "NewSeries", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1417 "Date" : "20130507T143902", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1418 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1419 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1420 "ResourceType" : "Series", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1421 "Seq" : 922 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1422 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1423 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1424 "ChangeType" : "NewStudy", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1425 "Date" : "20130507T143902", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1426 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1427 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1428 "ResourceType" : "Study", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1429 "Seq" : 923 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1430 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1431 { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1432 "ChangeType" : "NewPatient", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1433 "Date" : "20130507T143902", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1434 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1435 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1436 "ResourceType" : "Patient", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1437 "Seq" : 924 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1438 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1439 ], |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1440 "Done" : true, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1441 "Last" : 924 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1442 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1443 delete: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1444 tags : [Tracking Changes] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1445 description: Clear the content of the changes log |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1446 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1447 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1448 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1449 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1450 /exports: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1451 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1452 tags: [Exported Resources] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1453 description: For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1454 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1455 200: {description: Success} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1456 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1457 delete: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1458 tags: [Exported Resources] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1459 description: 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. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1460 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1461 200: {description: Success} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1462 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1463 /instances/{Id}/anonymize: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1464 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1465 tags: [Anonymization] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1466 description: Anonymize the instance by erasing all the tags that are specified in Table E.1-1 from PS 3.15 of the DICOM standard 2008 or 2017c (default). The response will contain the anonymized DICOM result. New UUIDs are automatically generated for the instance. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1467 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1468 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1469 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1470 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1471 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1472 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1473 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1474 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1475 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1476 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1477 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1478 DicomVersion: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1479 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1480 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1481 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1482 - 2017c |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1483 - 2008 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1484 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1485 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1486 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1487 Keep: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1488 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1489 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1490 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1491 description: List of DICOM tags that should be kept through the anonymization process. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1492 KeepPrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1493 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1494 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1495 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1496 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1497 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1498 description: The response contains a DICOM file that has been anonymized. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1499 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1500 application/dicom: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1501 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1502 /patients/{Id}/anonymize: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1503 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1504 tags: [Anonymization] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1505 description: Anonymize the patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1506 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1507 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1508 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1509 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1510 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1511 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1512 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1513 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1514 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1515 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1516 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1517 DicomVersion: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1518 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1519 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1520 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1521 - 2017c |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1522 - 2008 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1523 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1524 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1525 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1526 Keep: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1527 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1528 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1529 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1530 description: List of DICOM tags that should be kept through the anonymization process. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1531 KeepPrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1532 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1533 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1534 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1535 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1536 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1537 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1538 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1539 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1540 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1541 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1542 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1543 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1544 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1545 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1546 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1547 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1548 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1549 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1550 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1551 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1552 description: The ID of the new anonymized patient. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1553 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1554 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1555 description: The URL of the new anonymized patient. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1556 PatientID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1557 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1558 Type: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1559 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1560 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1561 - Patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1562 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1563 "ID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1564 "Path" : "/patients/f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1565 "PatientID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1566 "Type" : "Patient" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1567 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1568 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1569 /studies/{Id}/anonymize: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1570 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1571 tags: [Anonymization] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1572 description: Anonymize the study |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1573 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1574 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1575 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1576 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1577 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1578 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1579 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1580 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1581 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1582 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1583 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1584 DicomVersion: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1585 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1586 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1587 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1588 - 2017c |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1589 - 2008 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1590 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1591 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1592 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1593 Keep: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1594 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1595 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1596 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1597 description: List of DICOM tags that should be kept through the anonymization process. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1598 KeepPrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1599 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1600 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1601 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1602 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1603 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1604 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1605 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1606 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1607 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1608 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1609 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1610 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1611 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1612 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1613 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1614 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1615 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1616 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1617 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1618 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1619 description: The ID of the new anonymized study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1620 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1621 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1622 description: The URL of the new anonymized study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1623 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1624 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1625 "Path" : "/studies/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1626 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1627 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1628 /series/{Id}/anonymize: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1629 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1630 tags: [Anonymization] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1631 description: Anonymize the series |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1632 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1633 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1634 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1635 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1636 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1637 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1638 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1639 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1640 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1641 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1642 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1643 DicomVersion: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1644 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1645 description: Specifies which version of the DICOM standard shall be used for anonymization. Allowed values are 2008 and 2017c (default value if the parameter is absent). This parameter has been introduced in Orthanc 1.3.0. In earlier version, the 2008 standard was used. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1646 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1647 - 2017c |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1648 - 2008 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1649 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1650 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1651 description: Replace is an associative array that associates a DICOM tag with its new string value. The value is dynamically cast to the proper DICOM data type (an HTTP error will occur if the cast fails). Replacements are applied after all the tags to anonymize have been removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1652 Keep: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1653 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1654 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1655 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1656 description: List of DICOM tags that should be kept through the anonymization process. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1657 KeepPrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1658 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1659 description: If KeepPrivateTags is set to true in the JSON request, private tags (i.e. manufacturer-specific tags) are not removed by the anonymization process. The default behavior consists in removing the private tags, as such tags can contain patient-specific information. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1660 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1661 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1662 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1663 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1664 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1665 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1666 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1667 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1668 example: {"Replace":{"PatientName":"Hello","0010-1001":"World"},"Keep":["StudyDescription", "SeriesDescription"],"KeepPrivateTags": true, "DicomVersion" : "2017c"} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1669 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1670 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1671 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1672 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1673 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1674 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1675 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1676 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1677 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1678 description: The ID of the new anonymized series. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1679 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1680 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1681 description: The URL of the new anonymized series. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1682 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1683 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1684 "Path" : "/series/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1685 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1686 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1687 /instances/{Id}/modify: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1688 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1689 tags: [Modification] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1690 description: Orthanc allows to modify a set of specified tags in a single DICOM instance and to download the resulting modified DICOM file. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1691 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1692 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1693 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1694 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1695 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1696 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1697 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1698 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1699 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1700 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1701 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1702 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1703 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1704 description: The Replace associative array specifies the substitions to be applied (cf. anonymization). |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1705 Remove: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1706 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1707 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1708 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1709 description: The Remove array specifies the list of the tags to remove. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1710 RemovePrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1711 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1712 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1713 Force: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1714 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1715 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1716 default: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1717 example: {"Replace":{"PatientName":"hello","PatientID":"world"},"Remove":["InstitutionName"],"RemovePrivateTags": true, "Force": true} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1718 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1719 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1720 description: The response contains a DICOM file that has been anonymized. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1721 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1722 application/dicom: {} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1723 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1724 /studies/{Id}/modify: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1725 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1726 tags: [Modification] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1727 description: It is possible to modify all the instances from a study or from a series in a single request. In this case, the modified instances are stored back into the Orthanc store. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1728 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1729 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1730 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1731 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1732 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1733 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1734 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1735 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1736 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1737 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1738 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1739 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1740 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1741 description: The Replace associative array specifies the substitions to be applied (cf. anonymization). |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1742 Remove: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1743 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1744 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1745 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1746 description: The Remove array specifies the list of the tags to remove. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1747 RemovePrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1748 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1749 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1750 Force: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1751 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1752 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1753 default: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1754 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1755 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1756 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1757 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1758 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1759 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1760 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1761 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1762 example: {"Replace":{"InstitutionName":"My own clinic"}} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1763 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1764 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1765 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1766 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1767 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1768 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1769 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1770 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1771 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1772 description: The ID of the new modified study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1773 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1774 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1775 description: The URL of the new modified study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1776 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1777 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1778 "Path" : "/studies/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1779 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1780 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1781 /series/{Id}/modify: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1782 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1783 tags: [Modification] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1784 description: It is possible to modify all the instances from a study or from a series in a single request. In this case, the modified instances are stored back into the Orthanc store. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1785 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1786 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1787 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1788 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1789 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1790 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1791 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1792 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1793 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1794 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1795 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1796 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1797 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1798 description: The Replace associative array specifies the substitions to be applied (cf. anonymization). |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1799 Remove: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1800 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1801 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1802 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1803 description: The Remove array specifies the list of the tags to remove. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1804 RemovePrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1805 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1806 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1807 Force: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1808 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1809 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1810 default: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1811 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1812 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1813 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1814 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1815 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1816 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1817 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1818 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1819 example: {"Replace":{"InstitutionName":"My own clinic"}} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1820 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1821 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1822 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1823 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1824 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1825 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1826 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1827 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1828 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1829 description: The ID of the new modified study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1830 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1831 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1832 description: The URL of the new modified study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1833 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1834 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1835 "Path" : "/series/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1836 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1837 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1838 /patients/{Id}/modify: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1839 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1840 tags: [Modification] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1841 description: Starting with Orthanc 0.7.5, Orthanc can also modify all the instances of a patient with a single REST call. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1842 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1843 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1844 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1845 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1846 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1847 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1848 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1849 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1850 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1851 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1852 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1853 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1854 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1855 description: The Replace associative array specifies the substitions to be applied (cf. anonymization). |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1856 Remove: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1857 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1858 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1859 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1860 description: The Remove array specifies the list of the tags to remove. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1861 RemovePrivateTags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1862 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1863 description: If RemovePrivateTags is set to true, the private tags (i.e. manufacturer-specific tags) are removed. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1864 Force: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1865 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1866 description: The Force option must be set to true, in order to allow the modification of the PatientID, as such a modification of the DICOM identifiers might lead to breaking the DICOM model of the real-world. In general, any explicit modification to one of the PatientID, StudyInstanceUID, SeriesInstanceUID, and SOPInstanceUID requires Force to be set to true, in order to prevent any unwanted side effect. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1867 default: false |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1868 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1869 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1870 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1871 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1872 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1873 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1874 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1875 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1876 example: {"Replace":{"PatientID":"Hello","PatientName":"Sample patient name"},"Force":true} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1877 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1878 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1879 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1880 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1881 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1882 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1883 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1884 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1885 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1886 description: The ID of the new modified patient. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1887 Path: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1888 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1889 description: The URL of the new modified patient. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1890 PatientID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1891 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1892 Type: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1893 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1894 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1895 - Patient |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1896 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1897 "ID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1898 "Path" : "/patients/f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1899 "PatientID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1900 "Type" : "Patient" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1901 } |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1902 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1903 /studies/{Id}/split: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1904 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1905 tags: [Split/merge DICOM studies] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1906 description: "Starting with Orthanc 1.5.0, Orthanc supports splitting and merging DICOM studies through its REST API. By issuing the example command, the series whose Orthanc identifier is 6ca4c9f3-5e895cb3-4d82c6da-09e060fe-9c59f228, and that is part of the source study with identifier in the URL, will be removed from the source study, and will be moved to a brand new study. This is done by generating a new value for all the following DICOM tags in the DICOM instances of the series of interest: StudyInstanceUID (0x0020, 0x000d), SeriesInstanceUID (0x0020, 0x000e), and SOPInstanceUID (0x0008, 0x0018)" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1907 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1908 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1909 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1910 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1911 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1912 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1913 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1914 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1915 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1916 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1917 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1918 Series: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1919 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1920 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1921 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1922 description: Series gives 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. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1923 Replace: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1924 type: object |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1925 description: Replace allows to overwrite the DICOM tags that are part of the "Patient Module Attributes" and the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1926 Remove: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1927 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1928 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1929 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1930 description: Remove allows to remove DICOM tags from the same modules as in the Replace options. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1931 KeepSource: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1932 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1933 description: KeepSource (Boolean value), 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. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1934 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1935 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1936 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1937 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1938 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1939 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1940 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1941 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1942 example: {"Series":["6ca4c9f3-5e895cb3-4d82c6da-09e060fe-9c59f228"],"Replace":{"PatientName":"HELLO"},"Remove":["AccessionNumber"]} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1943 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1944 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1945 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1946 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1947 /studies/{Id}/merge: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1948 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1949 tags: [Split/merge DICOM studies] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1950 description: "Merge DICOM series into another DICOM study. By issuing this command, the DICOM series whose Orthanc identifier is ef2ce55f-9342856a-aee23907-2667e859-9f3b734d, will be merged into target study with identifier Id in the URL. As in the case of splitting, this is done by updating the following DICOM tags: StudyInstanceUID (0x0020, 0x000d), SeriesInstanceUID (0x0020, 0x000e), and SOPInstanceUID (0x0008, 0x0018). Furthermore, all the DICOM tags that are part of the “Patient Module Attributes” and the “General Study Module Attributes” (as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3), are modified to match the target study." |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1951 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1952 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1953 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1954 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1955 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1956 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1957 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1958 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1959 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1960 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1961 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1962 Resources: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1963 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1964 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1965 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1966 description: Resources gives the list of source studies or source series that are to be merged into the target study. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1967 KeepSource: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1968 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1969 description: KeepSource (Boolean value), if set to true, instructs Orthanc to keep the source studies and series. By default, the original resources are deleted from Orthanc. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1970 Synchronous: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1971 type: boolean |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1972 default: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1973 description: If Synchronous is set to false then this operation runs as an Orthanc job. The output of this request will indicate the Job ID. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1974 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1975 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1976 default: 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1977 description: If Synchronous is set to false then this sets the priority of the job. The default priority is 0. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1978 example: {"Resources":["ef2ce55f-9342856a-aee23907-2667e859-9f3b734d"]} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1979 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1980 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1981 description: Success |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1982 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1983 /instances/{Id}/frames: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1984 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1985 tags: [Frames] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1986 description: Get the list of frames for a DICOM instance. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1987 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1988 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1989 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1990 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1991 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1992 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1993 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1994 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1995 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1996 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1997 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1998 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
1999 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2000 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2001 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2002 example: [0, 75] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2003 /instances/{Id}/frames/{Idx}/{PixelFormat}: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2004 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2005 tags: [Frames] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2006 description: Get the image data of a frame within an instance. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2007 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2008 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2009 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2010 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2011 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2012 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2013 - name: Idx |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2014 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2015 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2016 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2017 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2018 - name: PixelFormat |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2019 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2020 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2021 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2022 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2023 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2024 - image-uint8 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2025 - image-uint16 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2026 - image-int16 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2027 - matlab |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2028 - raw |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2029 - raw.gz |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2030 - name: Accept |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2031 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2032 in: header |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2033 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2034 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2035 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2036 - image/png |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2037 - image/jpeg |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2038 - image/x-portable-arbitrarymap |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2039 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2040 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2041 description: Image |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2042 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2043 image/png: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2044 image/jpg: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2045 image/x-portable-arbitrarymap: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2046 application/octet-stream: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2047 text/plain: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2048 /instances/{Id}/frames/{Idx}/preview: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2049 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2050 tags: [Frames] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2051 description: Download a preview image of the frame of a DICOM instance. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2052 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2053 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2054 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2055 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2056 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2057 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2058 - name: Idx |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2059 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2060 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2061 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2062 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2063 - name: Accept |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2064 description: Default is image/png |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2065 required: false |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2066 in: header |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2067 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2068 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2069 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2070 - image/png |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2071 - image/jpeg |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2072 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2073 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2074 description: DICOM preview |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2075 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2076 image/png: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2077 image/jpg: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2078 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2079 /tools/lookup: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2080 post: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2081 tags: [Lookup] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2082 description: Lookup resources by their UID |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2083 requestBody: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2084 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2085 text/plain: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2086 example: "1.2.826.0.1.3680043.8.1055.1.20111103111148288.81713267.86905863" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2087 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2088 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2089 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2090 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2091 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2092 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2093 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2094 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2095 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2096 ID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2097 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2098 Path: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2099 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2100 Type: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2101 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2102 enum: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2103 - Patient |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2104 - Study |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2105 - Series |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2106 - Instance |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2107 example: { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2108 "ID" : "53a15d3a-ec236c65-5958be97-e31b8725-5f55ca69", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2109 "Path" : "/instances/53a15d3a-ec236c65-5958be97-e31b8725-5f55ca69", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2110 "Type" : "Instance" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2111 } |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2112 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2113 /tools/create-archive: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2114 post: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2115 tags: [Archive] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2116 description: Create an archive (zip) of the specified resource ID's as a collection of DICOM files. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2117 requestBody: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2118 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2119 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2120 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2121 oneOf: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2122 - type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2123 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2124 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2125 - properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2126 Synchronous: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2127 type: boolean |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2128 default: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2129 description: If synchronous is set to false then the archive is created through a job. The job ID and path will be given in the response. Once that job is complete then you can access the archive from the /jobs/{Id}/archive endpoint. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2130 Resources: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2131 type: array |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2132 items: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2133 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2134 example: [ |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2135 'ca29faea-b6a0e17f-067743a1-8b778011-a48b2a17', |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2136 '0a9b3153-2512774b-2d9580de-1fc3dcf6-3bd83918', |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2137 '1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0' |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2138 ] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2139 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2140 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2141 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2142 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2143 application/zip: {} |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2144 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2145 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2146 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2147 ID: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2148 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2149 Path: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2150 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2151 example: { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2152 "ID" : "6c5bab22-79ae-4eca-b0af-d979431801bd", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2153 "Path" : "/jobs/6c5bab22-79ae-4eca-b0af-d979431801bd" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2154 } |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2155 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2156 /tools/default-encoding: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2157 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2158 tags: [I18N] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2159 description: Get the default text encoding for the Orthanc server. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2160 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2161 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2162 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2163 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2164 text/plain: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2165 example: Latin1 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2166 post: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2167 tags: [I18N] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2168 description: Set the default text encoding for the Orthanc server. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2169 requestBody: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2170 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2171 text/plain: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2172 example: "Latin1" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2173 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2174 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2175 description: Success |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2176 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2177 /jobs: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2178 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2179 tags: [Jobs] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2180 description: The list of all jobs can be retrieved as follows. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2181 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2182 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2183 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2184 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2185 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2186 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2187 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2188 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2189 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2190 example: [ "e0d12aac-47eb-454f-bb7f-9857931e2904" ] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2191 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2192 /jobs/{Id}: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2193 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2194 tags: [Jobs] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2195 description: The list of all jobs can be retrieved as follows. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2196 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2197 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2198 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2199 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2200 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2201 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2202 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2203 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2204 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2205 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2206 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2207 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2208 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2209 CompletionTime: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2210 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2211 Content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2212 type: array |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2213 items: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2214 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2215 Description: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2216 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2217 InstanceCount: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2218 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2219 UncompressedSizeMB: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2220 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2221 CreationTime: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2222 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2223 EffectiveRuntime: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2224 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2225 ErrorCode: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2226 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2227 ErrorDescription: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2228 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2229 ID: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2230 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2231 Priority: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2232 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2233 Progress: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2234 type: number |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2235 State: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2236 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2237 enum: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2238 - Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2239 - Failure |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2240 - Pending |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2241 - Running |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2242 - Paused |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2243 - Retry |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2244 Timestamp: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2245 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2246 Type: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2247 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2248 example: { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2249 "CompletionTime" : "20190306T095223.753851", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2250 "Content" : { |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2251 "Description" : "REST API", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2252 "InstancesCount" : 1, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2253 "UncompressedSizeMB" : 0 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2254 }, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2255 "CreationTime" : "20190306T095223.750666", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2256 "EffectiveRuntime" : 0.001, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2257 "ErrorCode" : 0, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2258 "ErrorDescription" : "Success", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2259 "ID" : "e0d12aac-47eb-454f-bb7f-9857931e2904", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2260 "Priority" : 0, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2261 "Progress" : 100, |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2262 "State" : "Success", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2263 "Timestamp" : "20190306T095408.556082", |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2264 "Type" : "Archive" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2265 } |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2266 /jobs/{Id}/archive: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2267 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2268 tags: [Jobs] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2269 description: Get the archive generated by the job. Note that the job must be an archive job and it must be complete. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2270 parameters: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2271 - name: Id |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2272 required: true |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2273 in: path |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2274 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2275 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2276 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2277 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2278 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2279 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2280 application/zip: {} |
265
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2281 /jobs/{Id}/cancel: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2282 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2283 tags: [Jobs] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2284 description: Cancel the job |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2285 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2286 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2287 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2288 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2289 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2290 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2291 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2292 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2293 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2294 /jobs/{Id}/pause: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2295 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2296 tags: [Jobs] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2297 description: Pause the job |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2298 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2299 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2300 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2301 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2302 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2303 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2304 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2305 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2306 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2307 /jobs/{Id}/resume: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2308 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2309 tags: [Jobs] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2310 description: Resume the job |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2311 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2312 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2313 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2314 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2315 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2316 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2317 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2318 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2319 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2320 /jobs/{Id}/resubmit: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2321 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2322 tags: [Jobs] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2323 description: Retry the job |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2324 parameters: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2325 - name: Id |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2326 required: true |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2327 in: path |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2328 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2329 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2330 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2331 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2332 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2333 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2334 /tools/create-dicom: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2335 post: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2336 tags: [PDF] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2337 description: The /tools/create-dicom URI can be used to upload a PDF file to Orthanc. You can retrieve the PDF from the instance using /instances/{Id}/pdf. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2338 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2339 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2340 application/json: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2341 schema: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2342 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2343 Tags: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2344 properties: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2345 PatientName: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2346 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2347 Modality: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2348 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2349 Content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2350 type: string |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2351 pattern: 'data:application/pdf;base64,.*' |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2352 description: Base 64 encoded bytes of the PDF to store. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2353 example: {"Tags" : {"PatientName" : "Benjamino", "Modality" : "CT"},"Content" : "data:application/pdf;base64,<base64contentsofpdf>"} |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2354 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2355 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2356 description: The ID of the new DICOM instance is returned. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2357 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2358 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2359 example: "e0d12aac-47eb-454f-bb7f-9857931e2904" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2360 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2361 /tools/metrics-prometheus: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2362 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2363 tags: [Prometheus Metrics] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2364 description: Orthanc publishes its metrics according to the text-based format of Prometheus (check also the OpenMetrics project), onto the /tools/metrics-prometheus URI of the REST API. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2365 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2366 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2367 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2368 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2369 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2370 example: | |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2371 orthanc_count_instances 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2372 orthanc_count_patients 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2373 orthanc_count_series 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2374 orthanc_count_studies 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2375 orthanc_disk_size_mb 0.0135002136 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2376 orthanc_jobs_completed 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2377 orthanc_jobs_failed 0 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2378 orthanc_jobs_pending 0 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2379 orthanc_jobs_running 0 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2380 orthanc_jobs_success 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2381 orthanc_rest_api_active_requests 1 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2382 orthanc_rest_api_duration_ms 0 1551868094265 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2383 orthanc_storage_create_duration_ms 0 1551865919315 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2384 orthanc_storage_read_duration_ms 0 1551865943752 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2385 orthanc_store_dicom_duration_ms 5 1551865919319 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2386 orthanc_uncompressed_size_mb 0.0135002136 1551868380543 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2387 |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2388 /tools/metrics: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2389 get: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2390 tags: [Prometheus Metrics] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2391 description: Get the enablement state of the metrics gathering. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2392 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2393 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2394 description: Success |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2395 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2396 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2397 example: "1" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2398 put: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2399 tags: [Prometheus Metrics] |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2400 description: Set the enablement state of the metrics gathering. |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2401 requestBody: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2402 content: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2403 text/plain: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2404 example: "1" |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2405 responses: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2406 200: |
4e1a034ace3f
initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2407 description: Success |
267
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2408 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2409 /system: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2410 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2411 tags: [System] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2412 description: Get system information for the Orthanc server. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2413 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2414 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2415 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2416 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2417 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2418 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2419 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2420 ApiVersion: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2421 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2422 DatabaseBackendPlugin: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2423 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2424 DatabaseVersion: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2425 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2426 DicomAet: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2427 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2428 DicomPort: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2429 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2430 HttpPort: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2431 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2432 Name: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2433 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2434 PluginsEnabled: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2435 type: boolean |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2436 StorageAreaPlugin: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2437 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2438 Version: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2439 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2440 example: { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2441 "ApiVersion" : 3, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2442 "DatabaseBackendPlugin" : null, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2443 "DatabaseVersion" : 6, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2444 "DicomAet" : "ORTHANC", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2445 "DicomPort" : 4242, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2446 "HttpPort" : 8042, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2447 "Name" : "Orthanc Demo", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2448 "PluginsEnabled" : true, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2449 "StorageAreaPlugin" : null, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2450 "Version" : "1.5.7" |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2451 } |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2452 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2453 /statistics: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2454 get: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2455 tags: [Statistics] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2456 description: Get statistics about the data stored in Orthanc. |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2457 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2458 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2459 description: Success |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2460 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2461 application/json: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2462 schema: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2463 properties: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2464 CountInstances: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2465 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2466 CountPatients: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2467 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2468 CountSeries: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2469 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2470 CountStudies: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2471 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2472 TotalDiskSize: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2473 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2474 TotalDiskSizeMB: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2475 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2476 TotalUncompressedSize: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2477 type: string |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2478 TotalUncompressedSizeMB: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2479 type: number |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2480 example: { |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2481 "CountInstances" : 2352, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2482 "CountPatients" : 7, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2483 "CountSeries" : 23, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2484 "CountStudies" : 7, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2485 "TotalDiskSize" : "913213057", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2486 "TotalDiskSizeMB" : 870, |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2487 "TotalUncompressedSize" : "913213057", |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2488 "TotalUncompressedSizeMB" : 870 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2489 } |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2490 |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2491 /tools/execute-script: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2492 post: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2493 tags: [Lua] |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2494 description: Execute the posted Lua script |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2495 requestBody: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2496 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2497 text/plain: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2498 example: print(42) |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2499 responses: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2500 200: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2501 description: Script executed |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2502 content: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2503 text/plain: |
0a97b61ae021
updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
265
diff
changeset
|
2504 example: "42" |