forked from bioinformatics-ua/dicoogle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdicoogle_web_api.yaml
1318 lines (1316 loc) · 34.5 KB
/
dicoogle_web_api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
description:
<p>Specification of the Dicoogle's PACS archive public API. This page describes all services available
by default to the common user of the Dicoogle open-source PACS archive.
In the given examples, the Demo website is used to try out the services. They may also be tried in
your local deploy of Dicoogle through the base path <a href="http://localhost:8080">http://localhost:8080</a>,
or another base path previously set. More information about Dicoogle configuration available in
<a href="https://bioinformatics-ua.github.io/dicoogle-learning-pack/">Dicoogle Learning Pack</a>.</p>
<p>Finally, the Dicoogle Team encourage you to try out the official Javascript client API,
dicoogle-client-js, available in <a href="https://github.com/bioinformatics-ua/dicoogle-client-js">GitHub</a>
and documented in detail in <a href="https://bioinformatics-ua.github.io/dicoogle-client-js/">GitHub Pages</a>.</p>
<p>Useful external links:</p>
<p>- <a href="http://www.dicoogle.com">Dicoogle Website</a> </p>
<p>- <a href="https://github.com/bioinformatics-ua/dicoogle">Dicoogle GitHub</a> </p>
<p>- <a href="https://bioinformatics-ua.github.io/dicoogle-learning-pack/">Dicoogle Learning Pack</a> </p>
<p>- <a href="https://bioinformatics-ua.github.io/dicoogle-api/javadoc/">Dicoogle Javadoc</a> </p>
<p>- <a href="https://github.com/bioinformatics-ua/dicoogle-client-js">Dicoogle Javascript Client</a> </p>
<br>
version: 3.0.0
title: Dicoogle
contact:
name: Support
url: http://dicoogle.com/about/
license:
name: GNU General Public License v3.0
url: https://www.gnu.org/licenses/gpl-3.0.en.html
servers:
- url: http://demo.dicoogle.com/
- url: http://localhost:8080/
- url: http://yourdicooglehost/
externalDocs:
description: Dicoogle API
url: https://bioinformatics-ua.github.io/dicoogle-api/
tags:
- name: Authentication
description: Authentication related services
- name: User
description: User related services
- name: Search
description: Search related services
- name: Index
description: Index related services
- name: Management
description: Management related services
- name: Misc
description: Misc related services
paths:
/login:
post:
tags:
- Authentication
summary: Log in to Dicoogle using the given credentials
operationId: login
parameters:
- in: query
name: username
description: The unique user name for the client
required: true
schema:
type: string
- in: query
name: password
description: The user's password for authentication
required: true
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
"401":
description: Wrong login credentials
get:
tags:
- Authentication
summary: Check if logged in
operationId: status
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/FullUser"
security:
- dicoogle_auth:
- user
/logout:
post:
tags:
- Authentication
summary: Log out from the server
operationId: logout
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
security:
- dicoogle_auth:
- user
/user:
put:
tags:
- User
summary: Create a user in the system
operationId: createUser
parameters:
- in: query
name: username
description: The unique user name for the client
required: true
schema:
type: string
- in: query
name: password
description: The user's password for authentication
required: true
schema:
type: string
- in: query
name: admin
description: Whether the user has administrator privileges or not
required: true
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
get:
tags:
- User
summary: Get all the users in the system
operationId: getUsers
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Users"
delete:
tags:
- User
summary: Remove a user from the system
operationId: deleteUser
parameters:
- in: query
name: username
description: The unique user name for the client
required: true
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
/search:
get:
tags:
- Search
summary: Perform a text query
operationId: search
parameters:
- in: query
name: query
description: the text query
required: true
schema:
type: string
- in: query
name: provider
description: a list of provider plugins
required: false
schema:
type: string
- in: query
name: field
description: ""
required: false
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Results"
"400":
description: Invalid supplied parameters
/searchDIM:
get:
tags:
- Search
summary: Perform a text query with DIM-formatted outcome
operationId: searchDIM
parameters:
- in: query
name: query
description: the text query
required: true
schema:
type: string
- in: query
name: provider
description: a list of provider plugins
required: false
schema:
type: string
- in: query
name: field
description: ""
required: false
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/DIMResults"
"400":
description: Invalid supplied parameters
/dump:
get:
tags:
- Misc
summary: Retrieve an image's meta-data (perform an information dump)
operationId: dumpMetadata
parameters:
- in: query
name: uid
description: the SOP instance UID
required: true
schema:
type: string
- in: query
name: provider
description: a list of provider plugins
required: false
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Result"
"400":
description: Invalid supplied parameters
/management/settings/index/path:
get:
tags:
- Management
summary: Get the current Dicoogle watcher directory
operationId: getWatchingDir
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
post:
tags:
- Management
summary: Set the current Dicoogle watcher directory
operationId: setWatchDir
parameters:
- in: query
name: path
description: the Dicoogle watcher directory
required: true
schema:
type: string
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/settings/index/effort:
get:
tags:
- Management
summary: Get the indexation effort
operationId: getIndexEffort
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
post:
tags:
- Management
summary: Set the indexation effort
operationId: setIndexEffort
parameters:
- in: query
name: effort
description: the indexation effort
required: true
schema:
type: integer
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/settings/index/thumbnail:
get:
tags:
- Management
summary: Check thumbnail indexation
operationId: getThumbnailIndex
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
post:
tags:
- Management
summary: Set thumbnail indexation
operationId: setThumbnailIndex
parameters:
- in: query
name: saveThumbnail
description: save thumbnail
required: true
schema:
type: boolean
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/settings/index/watcher:
get:
tags:
- Management
summary: Check if Dicoogle watcher directory is enabled
operationId: getWatchDirEnabled
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
post:
tags:
- Management
summary: Set if the watcher directory is enabled
operationId: setWatchDirEnabled
parameters:
- in: query
name: watcher
description: enable the Dicoogle watcher directory
required: true
schema:
type: boolean
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/settings/index/thumbnail/size:
get:
tags:
- Management
summary: Get the thumbnail size
operationId: getThumbnailSize
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
post:
tags:
- Management
summary: Set the thumbnail size
operationId: setThumbnailSize
parameters:
- in: query
name: thumbnailSize
description: the thumbnail size
required: true
schema:
type: integer
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/settings/index:
get:
tags:
- Management
summary: Get all of the current Indexer settings
operationId: getIndexSettings
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/IndexSettings"
post:
tags:
- Management
summary: Set all the Indexer settings
operationId: setIndexSettings
parameters:
- in: query
name: path
description: the Dicoogle watcher directory
required: true
schema:
type: string
- in: query
name: watcher
description: enable the Dicoogle watcher directory
required: true
schema:
type: boolean
- in: query
name: zip
description: index zip files
required: true
schema:
type: boolean
- in: query
name: saveThumbnail
description: save thumbnail
required: true
schema:
type: boolean
- in: query
name: effort
description: the indexation effort
required: true
schema:
type: integer
- in: query
name: thumbnailSize
description: the thumbnail size
required: true
schema:
type: integer
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/settings/transfer:
get:
tags:
- Management
summary: Get the list of current transfer syntax settings available
operationId: getAvailableTS
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/TransferSyntaxSettingsList"
post:
tags:
- Management
summary: Set (or reset) an option of a particular transfer syntax
operationId: setOptionTS
parameters:
- in: query
name: uid
description: the unique identifier of the transfer syntax
required: true
schema:
type: string
- in: query
name: option
description: the name of the option to modify
required: true
schema:
type: string
- in: query
name: value
description: whether to set (true) or reset (false) the option
required: true
schema:
type: boolean
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
/wado:
get:
tags:
- Misc
summary: ""
operationId: wado
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
/providers:
get:
tags:
- Index
summary: Retrieve a list of index provider plugins
operationId: getIndexPlugins
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ListOfStrings"
/management/settings/dicom/query:
get:
tags:
- Management
summary: Get all of the current DICOM Query-Retrieve settings
operationId: getQueryRetrieveSettings
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/QuerySettings"
post:
tags:
- Management
summary: Set a group of DICOM Query/Retrieve settings
operationId: setQueryRetrieveSettings
parameters:
- in: query
name: acceptTimeout
description: ""
required: false
schema:
type: integer
- in: query
name: connectionTimeout
description: ""
required: false
schema:
type: integer
- in: query
name: idleTimeout
description: ""
required: false
schema:
type: integer
- in: query
name: maxAssociations
description: ""
required: false
schema:
type: integer
- in: query
name: maxPduReceive
description: ""
required: false
schema:
type: integer
- in: query
name: maxPduSend
description: ""
required: false
schema:
type: integer
- in: query
name: responseTimeout
description: ""
required: false
schema:
type: integer
responses:
"200":
description: Successful operation
/management/tasks/index:
post:
tags:
- Index
summary: Request a new indexing task over a given URI (recursively)
operationId: addIndexTaskURI
parameters:
- in: query
name: uri
description:
a URI or array of URIs representing the root resource of the files
to be indexed
required: true
schema:
type: string
- in: query
name: plugin
description: a list of provider plugins
required: false
schema:
type: string
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
properties:
tasks:
$ref: "#/components/schemas/Tasks"
"400":
description: Invalid supplied parameters
/management/tasks/unindex:
post:
tags:
- Index
summary:
Request that a list of entries is unindexed in the specified indexers,
or all of them if left unspecified. Exactly one of the fields `uri`,
`SOPInstanceUID` and `SeriesInstanceUID` must be given.
operationId: addUnindexTaskList
parameters:
- in: query
name: uri
description:
a URI or array of URIs representing the root resource of the files
to be unindexed
required: false
schema:
type: string
- in: query
name: SOPInstanceUID
description:
a UID or list of UIDs representing the DICOM instances to be
unindexed
required: false
schema:
type: string
- in: query
name: SeriesInstanceUID
description: a UID or list of UIDs representing the DICOM series to be unindexed
required: false
schema:
type: string
- in: query
name: StudyInstanceUID
description: a UID or list of UIDs representing the DICOM studies to be unindexed
required: false
schema:
type: string
- in: query
name: provider
description: a list of provider plugins
required: false
schema:
type: string
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/tasks/remove:
post:
tags:
- Index
summary: Request that the file at the given URI is permanently removed
operationId: addUnindexTaskURI
parameters:
- in: query
name: uri
description:
a URI or array of URIs representing the root resource of the files
to be indexed
required: true
schema:
type: string
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/management/dicom/storage:
get:
tags:
- Management
summary: Check the storage's service status
operationId: getStorageStatus
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
properties:
tasks:
$ref: "#/components/schemas/ServiceStatus"
post:
tags:
- Management
summary: Change the storage's service status
operationId: setStorageStatus
parameters:
- in: query
name: isRunning
description: whether the service runs or not
required: false
schema:
type: boolean
- in: query
name: port
description: the port where the service is running
required: false
schema:
type: integer
- in: query
name: autostart
description: whether the service autostarts or not
required: false
schema:
type: boolean
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
/management/dicom/query:
get:
tags:
- Management
summary: Check the query's service status
operationId: getQueryStatus
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
properties:
tasks:
$ref: "#/components/schemas/ServiceStatus"
post:
tags:
- Management
summary: Change the query's service status
operationId: setQueryStatus
parameters:
- in: query
name: isRunning
description: whether the service runs or not
required: false
schema:
type: boolean
- in: query
name: port
description: the port where the service is running
required: false
schema:
type: integer
- in: query
name: autostart
description: whether the service autostarts or not
required: false
schema:
type: boolean
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
/management/settings/dicom:
get:
tags:
- Management
summary: Retrieve the AE title of the Dicoogle archive
operationId: getAETitle
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
properties:
tasks:
$ref: "#/components/schemas/AETitle"
put:
tags:
- Management
summary: Redefine the AE title of the Dicoogle archive
operationId: setAETitle
parameters:
- in: query
name: aetitle
description: a valid AE title for the PACS archive
required: true
schema:
type: boolean
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
"400":
description: Invalid supplied parameter
/plugins:
get:
tags:
- Management
summary: Retrieve the list of existing plugins
operationId: getPluginList
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
properties:
plugins:
$ref: "#/components/schemas/Plugins"
/logger:
get:
tags:
- Misc
summary: Retrieve the Dicoogle server's log text
operationId: getLogText
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
"400":
description: Invalid supplied parameters
/index/task:
get:
tags:
- Index
summary: Get indexing tasks
operationId: getIndexTasks
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/TaskResults"
"400":
description: Invalid supplied parameters
post:
tags:
- Index
summary: Change an indexing task
operationId: setIndexTask
parameters:
- in: query
name: type
description: the type of action to change the task
required: true
schema:
type: string
- in: query
name: uid
description: ""
required: true
schema:
type: string
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameters
/export/cvs:
get:
tags:
- Misc
summary: Request a CSV file export of the results
operationId: exportCSV
parameters:
- in: query
name: query
description: the query to perform
required: true
schema:
type: string
- in: query
name: fields
description:
a set of field names to be passed to the query providers when
requesting the query
required: true
schema:
type: string
- in: query
name: providers
description: a set of query provider names
required: false
schema:
type: string
- in: query
name: keyword
description: force whether the query is keyword-based
required: false
schema:
type: boolean
responses:
"200":
description: Successful operation
"400":
description: Invalid supplied parameter
/export/list:
get:
tags:
- Misc
summary: Get a list of known valid DICOM fields
operationId: getValidDicomFields
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
type: string
/management/settings/storage/dicom:
get:
tags:
- Management
summary: Get the currently associated remote servers
operationId: getAssociatedServers
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/RemoteServers"
"400":
description: Invalid supplied parameters
post:
tags:
- Management
summary: Associate or remove a remote server
operationId: setAssociatedServer
parameters:
- in: query
name: type
description: whether the server is being associated or removed
required: true
schema:
type: boolean
- in: query
name: ip
description: ""
required: true
schema:
type: string