Mercurial > hg > orthanc-book

annotate OpenAPI/2019-08-orthanc-openapi.yaml @ 978:e7a3b3d76f1c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation of new options in Python plugin 4.1
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 31 Aug 2023 19:35:02 +0200
parents 7d27154e70f9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 267
diff changeset
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
2946fcd2e7fa transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 273
diff changeset
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
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
11
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
12 ####################################################################################
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
13 ## SCHEMAS / MODELS
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
14 ####################################################################################
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
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
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
212
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
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
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
224
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
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 }
288
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
245
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
246
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
247 jobPeerStore:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
248 properties:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
249 Description:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
250 type: string
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
251 FailedInstancesCount:
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 InstancesCount:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
254 type: number
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
255 Peer:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
256 type: string
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
257 example: {
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
258 "Description": "REST API",
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
259 "FailedInstancesCount": 0,
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
260 "InstancesCount": 1,
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
261 "Peer": [
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
262 "http://127.0.0.1:8543/"
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
263 ]
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
264 }
286
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
265
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
266
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
267 listOfResourcesWithAsynchOption:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
268 properties:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
269 Resources:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
270 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
271 type: array
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
272 items:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
273 type: string
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
274 Asynchronous:
287
eeb2c72dd5df api doc: asynchronous
Alain Mazy <alain@mazy.be>
parents: 286
diff changeset
275 description: true to create a job and return immediately, false to wait for job completion.
eeb2c72dd5df api doc: asynchronous
Alain Mazy <alain@mazy.be>
parents: 286
diff changeset
276 The response will vary according to this parameter. If the call is synchronous, you'll receive
eeb2c72dd5df api doc: asynchronous
Alain Mazy <alain@mazy.be>
parents: 286
diff changeset
277 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
278 type: boolean
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
279 example: {
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
280 "Resources" : ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"],
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
281 "Asynchronous" : true
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
282 }
286
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
283
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
284
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
285 listOfResources:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
286 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
287 schema:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
288 type: array
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
289 items:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
290 type: string
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
291 example: ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"]
286
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
292
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
293
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
294 singleResource:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
295 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
296 type: string
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
297 example: "62cdfbea-07c71f0c-cd643b19-841a306a-01221339"
286
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
298
288
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
299 peer:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
300 required:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
301 - Url
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
302 properties:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
303 Url:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
304 type: string
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
305 description: the root url of the Orthanc Rest API of the other peer
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
306 Username:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
307 type: string
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
308 Password:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
309 type: string
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
310 HttpHeaders:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
311 description: HTTP headers to add to every request sent to that peer
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
312 type: object
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
313 CertificateFile:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
314 type: string
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
315 CertificateKeyFile:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
316 type: string
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
317 CertificateKeyPassword:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
318 type: string
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
319 example: {
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
320 "Url" : "http://localhost:8044",
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
321 "Username" : "alice",
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
322 "Password" : "alicePassword",
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
323 "HttpHeaders" : { "Token" : "Hello world" },
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
324 "CertificateFile" : "client.crt",
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
325 "CertificateKeyFile" : "client.key",
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
326 "CertificateKeyPassword" : "certpass"
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
327 }
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
328
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
329
286
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
330 ####################################################################################
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
331 ## ROUTES / PATHS
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
332 ####################################################################################
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
333
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
334 paths:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
335 /instances:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
336 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
337 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
338 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
339 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
340 description: DICOM file
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
341 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
342 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
343 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
344 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
345 description: New instance successfully posted
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
346 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
347 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
348 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
349 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
350 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
351 description: New Orthanc instance ID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
352 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
353 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
354 description: URL path for the instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
355 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
356 Status:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
357 description: Status
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
358 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
359 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
360 - Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
361 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
362 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
363 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
364 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
365 - name: limit
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
366 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
367 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
368 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
369 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
370 - name: since
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
371 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
372 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
373 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
374 description: Show only the resources since the index provided.
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
375 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
376 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
377 description: Array of all instances ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
378 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
379 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
380 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
381 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
382 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
383 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
384 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
385 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
386 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
387 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
388 /instances/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
389 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
390 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
391 description: Get an instance from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
392 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
393 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
394 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
395 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
396 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
397 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
398 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
399 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
400 description: Orthanc instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
401 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
402 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
403 schema:
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
404 $ref: "#/components/schemas/instance"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
405 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
406 tags : [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
407 description: Delete an instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
408 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
409 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
410 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
411 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
412 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
413 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
414 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
415 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
416 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
417 /instances/{Id}/simplified-tags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
418 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
419 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
420 description: Get the human readable tags for the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
421 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
422 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
423 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
424 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
425 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
426 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
427 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
428 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
429 description: DICOM tags and values
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
430 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
431 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
432 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
433 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
434 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
435 "ACR_NEMA_2C_VariablePixelDataGroupLength" : "57130",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
436 "AccessionNumber" : null,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
437 "AcquisitionDate" : "20120716",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
438 "AcquisitionDateTime" : "20120716171219",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
439 "AcquisitionTime" : "171219",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
440 "ActualFrameDuration" : "3597793",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
441 "AttenuationCorrectionMethod" : "CTAC-SG",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
442 "PatientID" : "000000185",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
443 "PatientName" : "Anonymous^Unknown",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
444 "PatientOrientationCodeSequence" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
445 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
446 "CodeMeaning" : "recumbent",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
447 "CodeValue" : "F-10450",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
448 "CodingSchemeDesignator" : "99SDM",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
449 "PatientOrientationModifierCodeSequence" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
450 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
451 "CodeMeaning" : "supine",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
452 "CodeValue" : "F-10340",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
453 "CodingSchemeDesignator" : "99SDM"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
454 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
455 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
456 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
457 ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
458 "StudyDescription" : "TestSUVce-TF",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
459 "StudyID" : "23848",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
460 "StudyInstanceUID" : "1.2.840.113704.1.111.7016.1342451220.40",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
461 "StudyTime" : "171117",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
462 "TypeOfDetectorMotion" : "NONE",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
463 "Units" : "BQML",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
464 "Unknown" : null,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
465 "WindowCenter" : "1.496995e+04",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
466 "WindowWidth" : "2.993990e+04"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
467 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
468 /instances/{Id}/tags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
469 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
470 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
471 description: Get the detailed tags for the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
472 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
473 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
474 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
475 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
476 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
477 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
478 - name: simplify
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
479 required: false
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
480 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
481 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
482 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
483 type: boolean
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
484 - name: short
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
485 required: false
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
486 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
487 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
488 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
489 type: boolean
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
490 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
491 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
492 description: DICOM tags and values
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
493 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
494 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
495 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
496 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
497 example:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
498 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
499 "0008,0005" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
500 "Name" : "SpecificCharacterSet",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
501 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
502 "Value" : "ISO_IR 100"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
503 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
504 "0008,0008" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
505 "Name" : "ImageType",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
506 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
507 "Value" : "ORIGINAL\\PRIMARY\\HEADER_CORRECTED"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
508 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
509 "0008,0016" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
510 "Name" : "SOPClassUID",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
511 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
512 "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
513 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
514 "0008,0018" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
515 "Name" : "SOPInstanceUID",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
516 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
517 "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
518 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
519 "0008,0020" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
520 "Name" : "StudyDate",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
521 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
522 "Value" : "20040304"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
523 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
524 "0008,0021" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
525 "Name" : "SeriesDate",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
526 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
527 "Value" : "20040304"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
528 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
529 "0008,0022" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
530 "Name" : "AcquisitionDate",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
531 "Type" : "String",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
532 "Value" : "20040304"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
533 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
534 }
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
535 /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
536 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
537 tags: [Instances]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
538 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
539 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
540 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
541 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
542 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
543 schema:
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 - name: simplify
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
546 required: false
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
547 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
548 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
549 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
550 type: boolean
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
551 - name: short
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
552 required: false
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
553 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
554 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
555 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
556 type: boolean
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
557 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
558 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
559 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
560 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
561 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
562 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
563 type: object
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
564 example: {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
565 "0002,0000" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
566 "Name" : "FileMetaInformationGroupLength",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
567 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
568 "Value" : "222"
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
569 },
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
570 "0002,0002" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
571 "Name" : "MediaStorageSOPClassUID",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
572 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
573 "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
574 },
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
575 "0002,0003" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
576 "Name" : "MediaStorageSOPInstanceUID",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
577 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
578 "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
579 },
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
580 "0002,0010" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
581 "Name" : "TransferSyntaxUID",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
582 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
583 "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
584 },
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
585 "0002,0012" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
586 "Name" : "ImplementationClassUID",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
587 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
588 "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
589 },
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
590 "0002,0013" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
591 "Name" : "ImplementationVersionName",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
592 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
593 "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
594 },
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
595 "0002,0016" : {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
596 "Name" : "SourceApplicationEntityTitle",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
597 "Type" : "String",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
598 "Value" : "gdcmconv"
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
599 }
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
600 }
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
601 /instances/{Id}/content/{Tag}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
602 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
603 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
604 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
605 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
606 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
607 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
608 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
609 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
610 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
611 - name: Tag
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
612 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
613 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
614 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
615 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
616 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
617 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
618 description: Returns the DICOM tag value or value sub-structure.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
619 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
620 application/json:
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: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
623 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
624 example: Anonymous^Unknown
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
625 /instances/{Id}/file:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
626 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
627 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
628 description: Download the DICOM instance file in DCM format.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
629 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
630 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
631 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
632 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
633 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
634 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
635 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
636 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
637 description: DICOM file contents
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
638 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
639 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
640 /instances/{Id}/preview:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
641 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
642 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
643 description: Download a preview image of the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
644 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
645 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
646 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
647 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
648 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
649 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
650 - name: Accept
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
651 description: Default is image/png
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
652 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
653 in: header
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
654 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
655 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
656 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
657 - image/png
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
658 - image/jpeg
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
659 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
660 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
661 description: DICOM preview
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
662 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
663 image/png: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
664 image/jpg: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
665 /instances/{Id}/{PixelFormat}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
666 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
667 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
668 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
669 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
670 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
671 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
672 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
673 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
674 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
675 - name: PixelFormat
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
676 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
677 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
678 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
679 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
680 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
681 - image-uint8
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
682 - image-uint16
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
683 - 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
684 - matlab
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
685 - raw
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
686 - raw.gz
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
687 - name: Accept
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
688 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
689 in: header
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
690 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
691 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
692 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
693 - image/png
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
694 - image/jpeg
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
695 - image/x-portable-arbitrarymap
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
696 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
697 200:
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
698 description: Image
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
699 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
700 image/png: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
701 image/jpg: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
702 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
703 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
704 text/plain: {}
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
705 /instances/{Id}/pdf:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
706 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
707 tags: [Instances]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
708 description: Download the embedded PDF of the DICOM instance.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
709 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
710 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
711 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
712 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
713 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
714 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
715 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
716 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
717 description: The raw PDF bytes are returned.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
718 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
719 application/pdf: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
720 404:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
721 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
722 /series:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
723 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
724 tags: [Series]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
725 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
726 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
727 - name: limit
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
728 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
729 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
730 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
731 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
732 - name: since
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
733 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
734 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
735 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
736 description: Show only the resources since the index provided.
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
737 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
738 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
739 description: Array of all series ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
740 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
741 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
742 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
743 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
744 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
745 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
746 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
747 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
748 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
749 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
750 /series/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
751 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
752 tags: [Series]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
753 description: Get a series from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
754 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
755 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
756 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
757 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
758 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
759 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
760 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
761 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
762 description: Orthanc series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
763 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
764 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
765 schema:
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
766 $ref: "#/components/schemas/series"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
767 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
768 tags : [Series]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
769 description: Delete a series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
770 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
771 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
772 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
773 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
774 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
775 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
776 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
777 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
778 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
779 /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
780 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
781 tags: [Series]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
782 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
783 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
784 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
785 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
786 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
787 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
788 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
789 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
790 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
791 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
792 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
793 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
794 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
795 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
796 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
797 $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
798
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
799 /studies:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
800 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
801 tags: [Studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
802 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
803 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
804 - name: limit
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
805 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
806 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
807 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
808 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
809 - name: since
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
810 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
811 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
812 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
813 description: Show only the resources since the index provided.
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
814 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
815 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
816 description: Array of all study ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
817 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
818 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
819 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
820 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
821 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
822 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
823 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
824 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
825 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
826 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
827 /studies/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
828 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
829 tags: [Studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
830 description: Get a study from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
831 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
832 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
833 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
834 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
835 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
836 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
837 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
838 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
839 description: Orthanc study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
840 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
841 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
842 schema:
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
843 $ref: "#/components/schemas/study"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
844 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
845 tags : [Studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
846 description: Delete a study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
847 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
848 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
849 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
850 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
851 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
852 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
853 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
854 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
855 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
856 /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
857 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
858 tags: [Studies]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
859 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
860 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
861 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
862 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
863 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
864 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
865 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
866 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
867 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
868 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
869 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
870 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
871 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
872 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
873 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
874 $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
875 /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
876 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
877 tags: [Studies]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
878 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
879 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
880 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
881 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
882 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
883 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
884 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
885 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
886 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
887 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
888 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
889 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
890 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
891 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
892 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
893 $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
894
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
895 /patients:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
896 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
897 tags: [Patients]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
898 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
899 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
900 - name: limit
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
901 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
902 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
903 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
904 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
905 - name: since
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
906 in: query
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
907 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
908 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
909 description: Show only the resources since the index provided.
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
910 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
911 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
912 description: Array of all patient ID's
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
913 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
914 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
915 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
916 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
917 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
918 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
919 example: [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
920 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
921 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
922 ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
923 /patients/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
924 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
925 tags: [Patients]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
926 description: Get a patient from Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
927 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
928 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
929 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
930 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
931 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
932 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
933 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
934 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
935 description: Orthanc patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
936 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
937 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
938 schema:
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
939 $ref: "#/components/schemas/patient"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
940 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
941 tags : [Patients]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
942 description: Delete a patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
943 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
944 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
945 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
946 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
947 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
948 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
949 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
950 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
951 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
952 /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
953 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
954 tags: [Patients]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
955 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
956 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
957 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
958 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
959 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
960 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
961 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
962 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
963 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
964 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
965 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
966 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
967 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
968 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
969 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
970 $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
971 /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
972 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
973 tags: [Patients]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
974 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
975 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
976 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
977 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
978 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
979 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
980 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
981 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
982 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
983 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
984 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
985 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
986 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
987 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
988 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
989 $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
990 /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
991 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
992 tags: [Patients]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
993 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
994 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
995 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
996 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
997 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
998 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
999 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1000 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1001 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1002 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
1003 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1004 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1005 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1006 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1007 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1008 $ref: "#/components/schemas/instance"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1009
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1010 /peers:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1011 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1012 tags: [Orthanc Peers]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1013 description: Get a list of Orthanc peers.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1014 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1015 - name: expand
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1016 in: query
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1017 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1018 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1019 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1020 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1021 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1022 description: List of Orthanc peers
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1023 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1024 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1025 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1026 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1027 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1028 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1029 /peers/{Peer}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1030 put:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1031 tags: [Orthanc Peers]
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1032 summary: Add a new Orthanc peer.
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1033 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
1034 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1035 - name: Peer
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1036 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1037 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1038 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1039 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1040 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1041 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1042 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1043 schema:
288
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
1044 type: array
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
1045 items:
2e71e7cc0ec5 API: add peers
Alain Mazy <alain@mazy.be>
parents: 287
diff changeset
1046 $ref: "#/components/schemas/peer"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1047 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1048 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1049 description: Peer created
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1050 /peers/{Peer}/store:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1051 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1052 tags: [Orthanc Peers]
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1053 summary: Send resources to an Orthanc peer.
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1054 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1055 - name: Peer
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1056 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1057 required: true
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1058 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
1059 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1060 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1061 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1062 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1063 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1064 schema:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1065 oneOf:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1066 - $ref: "#/components/schemas/listOfResourcesWithAsynchOption"
286
833d4ec1c1e8 separators in yaml files
Alain Mazy <alain@mazy.be>
parents: 285
diff changeset
1067 - $ref: "#/components/schemas/listOfResources"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1068 text/plain:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1069 schema:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1070 $ref: "#/components/schemas/singleResource"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1071 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1072 200:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1073 description: Jobs that have been created
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1074 content:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1075 application/json:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1076 schema:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1077 oneOf:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1078 - $ref: "#/components/schemas/jobId"
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1079 - $ref: "#/components/schemas/jobPeerStore"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1080
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1081 /modalities/{Modality}/store:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1082 post:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1083 tags: [Remote Modalities]
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1084 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
1085 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1086 - name: Modality
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1087 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1088 required: true
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1089 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
1090 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1091 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1092 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1093 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1094 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1095 schema:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1096 oneOf:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1097 - $ref: "#/components/schemas/listOfResourcesWithAsynchOption"
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1098 - $ref: "#/components/schemas/listOfResources"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1099 text/plain:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1100 schema:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1101 $ref: "#/components/schemas/singleResource"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1102 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1103 200:
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1104 description: Jobs that have been created
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1105 content:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1106 application/json:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1107 schema:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1108 oneOf:
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1109 - $ref: "#/components/schemas/jobId"
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1110 - $ref: "#/components/schemas/jobCStore"
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1111
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 275
diff changeset
1112
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1113 /modalities/{Modality}/query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1114 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1115 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1116 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
1117 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1118 - name: Modality
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1119 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1120 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1121 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
1122 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1123 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1124 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1125 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1126 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1127 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1128 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1129 Level:
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 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1132 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1133 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1134 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1135 - Instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1136 Query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1137 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1138 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1139 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1140 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1141 StudyDescription:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1142 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1143 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
1144 PatientName:
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 StudyDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1147 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1148 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
1149 StudyTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1150 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1151 required: [Level, Query]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1152 example: {"Level":"Study","Query": {"PatientID":"","StudyDescription":"*Chest*","PatientName":""}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1153 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1154 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1155 description: Query successful
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1156 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1157 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1158 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1159 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1160 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1161 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1162 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1163 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1164 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1165 "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1166 "Path": "/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1167 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1168 /queries/{QueryID}/level:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1169 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1170 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1171 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
1172 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1173 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1174 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
1175 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1176 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1177 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1178 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1179 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1180 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1181 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
1182 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1183 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1184 example: Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1185 /queries/{QueryID}/modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1186 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1187 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1188 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
1189 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1190 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1191 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
1192 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1193 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1194 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1195 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1196 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1197 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1198 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
1199 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1200 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1201 example: SomeModalityName
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1202 /queries/{QueryID}/query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1203 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1204 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1205 description: Review the query that was posted.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1206 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1207 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1208 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
1209 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1210 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1211 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1212 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1213 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1214 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1215 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
1216 /queries/{QueryID}/answers:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1217 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1218 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1219 description: Review the query answers.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1220 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1221 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1222 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
1223 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1224 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1225 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1226 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1227 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1228 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1229 description: Return the query answers.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1230 /queries/{QueryID}/answers/{Idx}/content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1231 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1232 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1233 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
1234 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1235 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1236 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
1237 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1238 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1239 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1240 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1241 - name: Idx
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1242 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
1243 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1244 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1245 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1246 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1247 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1248 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1249 description: Return a single query answer
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1250 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1251 application/json: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1252 /queries/{QueryID}/retrieve:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1253 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1254 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1255 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
1256 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1257 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1258 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
1259 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1260 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1261 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1262 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1263 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1264 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
1265 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1266 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1267 example: Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1268 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1269 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1270 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1271 TargetAet:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1272 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1273 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1274 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1275 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1276 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
1277 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1278 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1279 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1280 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
1281 example: {"TargetAet":"Orthanc","Synchronous":false}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1282 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1283 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1284 description: Success
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 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1287 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1288 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1289 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1290 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1291 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
1292 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1293 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1294 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
1295 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1296 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1297 "Path" : "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1298 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1299 /queries/{QueryID}/answers/{Idx}/retrieve:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1300 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1301 tags: [Remote Modalities]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1302 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
1303 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1304 - name: QueryID
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1305 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
1306 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1307 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1308 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1309 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1310 - name: Idx
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1311 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
1312 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1313 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1314 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1315 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1316 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1317 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
1318 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1319 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1320 example: Orthanc
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1321 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1322 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1323 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1324 /tools/find:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1325 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1326 tags: [Find]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1327 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
1328 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1329 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
1330 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1331 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1332 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1333 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1334 Level:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1335 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1336 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1337 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1338 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1339 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1340 - Instance
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1341 Expand:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1342 type: boolean
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1343 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
1344 Limit:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1345 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1346 Query:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1347 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1348 Modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1349 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1350 StudyDate:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1351 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1352 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1353 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1354 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
1355 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1356 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1357 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1358 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1359 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1360 schema:
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1361 oneOf:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1362 - type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1363 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1364 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1365 - type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1366 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1367 $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
1368 - type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1369 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1370 $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
1371 - type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1372 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1373 $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
1374 - type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1375 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
1376 $ref: "#/components/schemas/patient"
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1377 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
1378 /changes:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1379 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1380 tags: [Tracking Changes]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1381 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1382 - name: limit
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1383 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
1384 in: query
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1385 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1386 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1387 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1388 - name: since
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1389 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
1390 in: query
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1391 required: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1392 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1393 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1394 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
1395 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1396 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1397 description: The list of recent changes
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1398 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1399 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1400 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1401 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1402 Changes:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1403 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1404 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1405 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1406 ChangeType:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1407 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1408 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1409 - NewPatient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1410 - NewStudy
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1411 - NewSeries
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1412 - NewInstance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1413 - StablePatient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1414 - StableStudy
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1415 - StableSeries
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1416 - StableInstance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1417 Date:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1418 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1419 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1420 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1421 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1422 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1423 ResourceType:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1424 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1425 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1426 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1427 - Study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1428 - Series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1429 - Instance
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1430 Seq:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1431 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1432 Done:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1433 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1434 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
1435 Last:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1436 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1437 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
1438 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1439 "Changes" : [
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1440 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1441 "ChangeType" : "NewInstance",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1442 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1443 "ID" : "8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1444 "Path" : "/instances/8e289db9-0e1437e1-3ecf395f-d8aae463-f4bb49fe",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1445 "ResourceType" : "Instance",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1446 "Seq" : 921
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1447 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1448 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1449 "ChangeType" : "NewSeries",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1450 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1451 "ID" : "cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1452 "Path" : "/series/cceb768f-e0f8df71-511b0277-07e55743-9ef8890d",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1453 "ResourceType" : "Series",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1454 "Seq" : 922
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1455 },
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 "ChangeType" : "NewStudy",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1458 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1459 "ID" : "c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1460 "Path" : "/studies/c4ec7f68-9b162055-2c8c5888-5bf5752f-155ab19f",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1461 "ResourceType" : "Study",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1462 "Seq" : 923
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1463 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1464 {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1465 "ChangeType" : "NewPatient",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1466 "Date" : "20130507T143902",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1467 "ID" : "dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1468 "Path" : "/patients/dc65762c-f476e8b9-898834f4-2f8a5014-2599bc94",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1469 "ResourceType" : "Patient",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1470 "Seq" : 924
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1471 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1472 ],
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1473 "Done" : true,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1474 "Last" : 924
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1475 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1476 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1477 tags : [Tracking Changes]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1478 description: Clear the content of the changes log
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1479 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1480 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1481 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1482
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1483 /exports:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1484 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1485 tags: [Exported Resources]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1486 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
1487 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1488 200: {description: Success}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1489
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1490 delete:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1491 tags: [Exported Resources]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1492 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
1493 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1494 200: {description: Success}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1495
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1496 /instances/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1497 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1498 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1499 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
1500 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1501 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1502 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1503 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1504 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1505 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1506 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1507 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1508 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1509 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1510 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1511 DicomVersion:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1512 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1513 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
1514 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1515 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1516 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1517 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1518 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1519 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
1520 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1521 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1522 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1523 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1524 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
1525 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1526 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1527 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
1528 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
1529 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1530 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1531 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
1532 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1533 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1534
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1535 /patients/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1536 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1537 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1538 description: Anonymize the patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1539 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1540 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1541 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1542 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1543 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1544 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1545 requestBody:
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 DicomVersion:
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: 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
1553 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1554 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1555 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1556 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1557 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1558 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
1559 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1560 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1561 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1562 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1563 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
1564 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1565 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1566 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
1567 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1568 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1569 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1570 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
1571 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1572 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1573 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1574 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
1575 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
1576 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1577 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1578 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1579 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1580 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1581 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1582 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1583 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1584 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1585 description: The ID of the new anonymized patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1586 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1587 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1588 description: The URL of the new anonymized patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1589 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1590 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1591 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1592 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1593 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1594 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1595 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1596 "ID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1597 "Path" : "/patients/f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1598 "PatientID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1599 "Type" : "Patient"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1600 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1601
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1602 /studies/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1603 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1604 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1605 description: Anonymize the study
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1606 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1607 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1608 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1609 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1610 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1611 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1612 requestBody:
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 DicomVersion:
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: 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
1620 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1621 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1622 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1623 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1624 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1625 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
1626 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1627 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1628 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1629 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1630 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
1631 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1632 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1633 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
1634 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1635 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1636 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1637 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
1638 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1639 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1640 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1641 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
1642 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
1643 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1644 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1645 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1646 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1647 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1648 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1649 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1650 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1651 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1652 description: The ID of the new anonymized study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1653 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1654 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1655 description: The URL of the new anonymized study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1656 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1657 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1658 "Path" : "/studies/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1659 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1660
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1661 /series/{Id}/anonymize:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1662 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1663 tags: [Anonymization]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1664 description: Anonymize the series
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1665 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1666 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1667 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1668 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1669 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1670 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1671 requestBody:
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 DicomVersion:
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: 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
1679 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1680 - 2017c
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1681 - 2008
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1682 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1683 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1684 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
1685 Keep:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1686 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1687 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1688 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1689 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
1690 KeepPrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1691 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1692 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
1693 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1694 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1695 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1696 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
1697 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1698 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1699 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1700 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
1701 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
1702 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1703 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1704 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1705 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1706 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1707 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1708 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1709 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1710 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1711 description: The ID of the new anonymized series.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1712 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1713 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1714 description: The URL of the new anonymized series.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1715 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1716 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1717 "Path" : "/series/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1718 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1719
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1720 /instances/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1721 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1722 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1723 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
1724 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1725 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1726 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1727 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1728 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1729 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1730 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1731 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1732 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1733 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1734 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1735 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1736 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1737 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
1738 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1739 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1740 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1741 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1742 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
1743 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1744 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1745 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
1746 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1747 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1748 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
1749 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1750 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
1751 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1752 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1753 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
1754 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1755 application/dicom: {}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1756
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1757 /studies/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1758 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1759 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1760 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
1761 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1762 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1763 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1764 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1765 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1766 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1767 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1768 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1769 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1770 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1771 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1772 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1773 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1774 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
1775 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1776 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1777 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1778 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1779 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
1780 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1781 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1782 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
1783 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1784 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1785 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
1786 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1787 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1788 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1789 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1790 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
1791 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1792 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1793 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1794 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
1795 example: {"Replace":{"InstitutionName":"My own clinic"}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1796 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1797 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1798 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1799 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1800 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1801 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1802 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1803 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1804 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1805 description: The ID of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1806 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1807 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1808 description: The URL of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1809 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1810 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1811 "Path" : "/studies/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1812 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1813
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1814 /series/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1815 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1816 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1817 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
1818 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1819 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1820 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1821 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1822 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1823 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1824 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1825 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1826 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1827 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1828 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1829 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1830 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1831 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
1832 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1833 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1834 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1835 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1836 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
1837 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1838 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1839 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
1840 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1841 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1842 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
1843 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1844 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1845 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1846 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1847 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
1848 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1849 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1850 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1851 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
1852 example: {"Replace":{"InstitutionName":"My own clinic"}}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1853 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1854 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1855 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1856 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1857 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1858 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1859 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1860 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1861 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1862 description: The ID of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1863 Path:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1864 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1865 description: The URL of the new modified study.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1866 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1867 "ID" : "3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1868 "Path" : "/series/3bd3d343-82879d86-da77321c-1d23fd6b-faa07bce"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1869 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1870
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1871 /patients/{Id}/modify:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1872 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1873 tags: [Modification]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1874 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
1875 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1876 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1877 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1878 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1879 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1880 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1881 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1882 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1883 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1884 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1885 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1886 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1887 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1888 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
1889 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1890 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1891 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1892 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1893 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
1894 RemovePrivateTags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1895 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1896 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
1897 Force:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1898 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1899 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
1900 default: false
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1901 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1902 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1903 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1904 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
1905 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1906 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1907 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1908 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
1909 example: {"Replace":{"PatientID":"Hello","PatientName":"Sample patient name"},"Force":true}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1910 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1911 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1912 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1913 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1914 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1915 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1916 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1917 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1918 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1919 description: The ID of the new modified patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1920 Path:
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: The URL of the new modified patient.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1923 PatientID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1924 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1925 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1926 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1927 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1928 - Patient
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1929 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1930 "ID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1931 "Path" : "/patients/f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1932 "PatientID" : "f7ff9e8b-7bb2e09b-70935a5d-785e0cc5-d9d0abf0",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1933 "Type" : "Patient"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1934 }
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1935
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1936 /studies/{Id}/split:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1937 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1938 tags: [Split/merge DICOM studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1939 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
1940 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1941 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1942 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1943 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1944 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1945 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1946 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1947 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1948 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1949 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1950 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1951 Series:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1952 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1953 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1954 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1955 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
1956 Replace:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1957 type: object
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1958 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
1959 Remove:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1960 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1961 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1962 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1963 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
1964 KeepSource:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1965 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1966 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
1967 Synchronous:
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 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1970 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
1971 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1972 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1973 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1974 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
1975 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
1976 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1977 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1978 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1979
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1980 /studies/{Id}/merge:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1981 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1982 tags: [Split/merge DICOM studies]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1983 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
1984 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1985 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1986 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1987 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1988 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1989 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1990 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1991 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1992 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1993 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1994 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1995 Resources:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1996 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1997 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1998 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1999 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
2000 KeepSource:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2001 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2002 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
2003 Synchronous:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2004 type: boolean
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2005 default: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2006 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
2007 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2008 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2009 default: 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2010 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
2011 example: {"Resources":["ef2ce55f-9342856a-aee23907-2667e859-9f3b734d"]}
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2012 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2013 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2014 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
2015
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2016 /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
2017 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2018 tags: [Frames]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2019 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
2020 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2021 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2022 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2023 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2024 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2025 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2026 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2027 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2028 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2029 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2030 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2031 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2032 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2033 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2034 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2035 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
2036 /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
2037 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2038 tags: [Frames]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2039 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
2040 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2041 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2042 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2043 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2044 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2045 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2046 - name: Idx
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2047 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2048 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2049 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2050 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2051 - name: PixelFormat
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2052 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2053 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2054 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2055 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2056 enum:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2057 - image-uint8
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2058 - image-uint16
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2059 - image-int16
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2060 - matlab
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2061 - raw
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2062 - raw.gz
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 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2065 in: header
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2066 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2067 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2068 enum:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2069 - image/png
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2070 - image/jpeg
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2071 - 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
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: Image
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 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
2079 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
2080 text/plain: {}
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2081 /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
2082 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2083 tags: [Frames]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2084 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
2085 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2086 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2087 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2088 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2089 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2090 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2091 - name: Idx
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2092 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2093 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2094 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2095 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2096 - name: Accept
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2097 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
2098 required: false
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2099 in: header
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2100 schema:
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 - image/png
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2104 - image/jpeg
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2105 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2106 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2107 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
2108 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2109 image/png: {}
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2110 image/jpg: {}
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 /tools/lookup:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2113 post:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2114 tags: [Lookup]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2115 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
2116 requestBody:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2117 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2118 text/plain:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2119 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
2120 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2121 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2122 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2123 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2124 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2125 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2126 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2127 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2128 properties:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2129 ID:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2130 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2131 Path:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2132 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2133 Type:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2134 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2135 enum:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2136 - Patient
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2137 - Study
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2138 - Series
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2139 - Instance
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2140 example: {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2141 "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
2142 "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
2143 "Type" : "Instance"
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2144 }
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2145
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2146 /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
2147 post:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2148 tags: [Archive]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2149 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
2150 requestBody:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2151 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2152 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2153 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2154 oneOf:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2155 - type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2156 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2157 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2158 - properties:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2159 Synchronous:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2160 type: boolean
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2161 default: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2162 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
2163 Resources:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2164 type: array
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2165 items:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2166 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2167 example: [
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2168 '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
2169 '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
2170 '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
2171 ]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2172 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2173 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2174 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2175 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2176 application/zip: {}
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2177 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2178 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2179 properties:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2180 ID:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2181 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2182 Path:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2183 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2184 example: {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2185 "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
2186 "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
2187 }
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2188
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2189 /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
2190 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2191 tags: [I18N]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2192 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
2193 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2194 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2195 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2196 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2197 text/plain:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2198 example: Latin1
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2199 post:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2200 tags: [I18N]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2201 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
2202 requestBody:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2203 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2204 text/plain:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2205 example: "Latin1"
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2206 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2207 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2208 description: Success
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2209
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2210 /jobs:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2211 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2212 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2213 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
2214 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2215 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2216 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2217 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2218 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2219 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2220 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2221 items:
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 example: [ "e0d12aac-47eb-454f-bb7f-9857931e2904" ]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2224
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2225 /jobs/{Id}:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2226 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2227 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2228 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
2229 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2230 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2231 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2232 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2233 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2234 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2235 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2236 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2237 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2238 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2239 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2240 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2241 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2242 CompletionTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2243 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2244 Content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2245 type: array
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2246 items:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2247 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2248 Description:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2249 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2250 InstanceCount:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2251 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2252 UncompressedSizeMB:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2253 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2254 CreationTime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2255 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2256 EffectiveRuntime:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2257 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2258 ErrorCode:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2259 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2260 ErrorDescription:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2261 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2262 ID:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2263 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2264 Priority:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2265 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2266 Progress:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2267 type: number
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2268 State:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2269 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2270 enum:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2271 - Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2272 - Failure
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2273 - Pending
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2274 - Running
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2275 - Paused
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2276 - Retry
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2277 Timestamp:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2278 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2279 Type:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2280 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2281 example: {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2282 "CompletionTime" : "20190306T095223.753851",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2283 "Content" : {
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2284 "Description" : "REST API",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2285 "InstancesCount" : 1,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2286 "UncompressedSizeMB" : 0
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2287 },
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2288 "CreationTime" : "20190306T095223.750666",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2289 "EffectiveRuntime" : 0.001,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2290 "ErrorCode" : 0,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2291 "ErrorDescription" : "Success",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2292 "ID" : "e0d12aac-47eb-454f-bb7f-9857931e2904",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2293 "Priority" : 0,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2294 "Progress" : 100,
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2295 "State" : "Success",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2296 "Timestamp" : "20190306T095408.556082",
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2297 "Type" : "Archive"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2298 }
267
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2299 /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
2300 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2301 tags: [Jobs]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2302 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
2303 parameters:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2304 - name: Id
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2305 required: true
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2306 in: path
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2307 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2308 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2309 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2310 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2311 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2312 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2313 application/zip: {}
265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2314 /jobs/{Id}/cancel:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2315 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2316 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2317 description: Cancel the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2318 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2319 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2320 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2321 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2322 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2323 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2324 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2325 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2326 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2327 /jobs/{Id}/pause:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2328 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2329 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2330 description: Pause the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2331 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2332 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2333 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2334 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2335 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2336 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2337 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2338 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2339 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2340 /jobs/{Id}/resume:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2341 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2342 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2343 description: Resume the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2344 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2345 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2346 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2347 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2348 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2349 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2350 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2351 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2352 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2353 /jobs/{Id}/resubmit:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2354 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2355 tags: [Jobs]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2356 description: Retry the job
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2357 parameters:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2358 - name: Id
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2359 required: true
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2360 in: path
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2361 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2362 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2363 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2364 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2365 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2366
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2367 /tools/create-dicom:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2368 post:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2369 tags: [PDF]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2370 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
2371 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2372 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2373 application/json:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2374 schema:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2375 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2376 Tags:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2377 properties:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2378 PatientName:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2379 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2380 Modality:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2381 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2382 Content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2383 type: string
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2384 pattern: 'data:application/pdf;base64,.*'
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2385 description: Base 64 encoded bytes of the PDF to store.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2386 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
2387 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2388 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2389 description: The ID of the new DICOM instance is returned.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2390 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2391 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2392 example: "e0d12aac-47eb-454f-bb7f-9857931e2904"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2393
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2394 /tools/metrics-prometheus:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2395 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2396 tags: [Prometheus Metrics]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2397 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
2398 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2399 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2400 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2401 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2402 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2403 example: |
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2404 orthanc_count_instances 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2405 orthanc_count_patients 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2406 orthanc_count_series 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2407 orthanc_count_studies 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2408 orthanc_disk_size_mb 0.0135002136 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2409 orthanc_jobs_completed 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2410 orthanc_jobs_failed 0 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2411 orthanc_jobs_pending 0 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2412 orthanc_jobs_running 0 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2413 orthanc_jobs_success 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2414 orthanc_rest_api_active_requests 1 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2415 orthanc_rest_api_duration_ms 0 1551868094265
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2416 orthanc_storage_create_duration_ms 0 1551865919315
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2417 orthanc_storage_read_duration_ms 0 1551865943752
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2418 orthanc_store_dicom_duration_ms 5 1551865919319
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2419 orthanc_uncompressed_size_mb 0.0135002136 1551868380543
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2420
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2421 /tools/metrics:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2422 get:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2423 tags: [Prometheus Metrics]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2424 description: Get the enablement state of the metrics gathering.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2425 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2426 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2427 description: Success
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2428 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2429 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2430 example: "1"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2431 put:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2432 tags: [Prometheus Metrics]
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2433 description: Set the enablement state of the metrics gathering.
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2434 requestBody:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2435 content:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2436 text/plain:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2437 example: "1"
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2438 responses:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2439 200:
4e1a034ace3f initial publication of openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2440 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
2441
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2442 /system:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2443 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2444 tags: [System]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2445 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
2446 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2447 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2448 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2449 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2450 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2451 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2452 properties:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2453 ApiVersion:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2454 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2455 DatabaseBackendPlugin:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2456 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2457 DatabaseVersion:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2458 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2459 DicomAet:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2460 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2461 DicomPort:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2462 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2463 HttpPort:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2464 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2465 Name:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2466 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2467 PluginsEnabled:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2468 type: boolean
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2469 StorageAreaPlugin:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2470 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2471 Version:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2472 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2473 example: {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2474 "ApiVersion" : 3,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2475 "DatabaseBackendPlugin" : null,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2476 "DatabaseVersion" : 6,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2477 "DicomAet" : "ORTHANC",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2478 "DicomPort" : 4242,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2479 "HttpPort" : 8042,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2480 "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
2481 "PluginsEnabled" : true,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2482 "StorageAreaPlugin" : null,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2483 "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
2484 }
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2485
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2486 /statistics:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2487 get:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2488 tags: [Statistics]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2489 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
2490 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2491 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2492 description: Success
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2493 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2494 application/json:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2495 schema:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2496 properties:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2497 CountInstances:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2498 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2499 CountPatients:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2500 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2501 CountSeries:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2502 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2503 CountStudies:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2504 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2505 TotalDiskSize:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2506 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2507 TotalDiskSizeMB:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2508 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2509 TotalUncompressedSize:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2510 type: string
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2511 TotalUncompressedSizeMB:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2512 type: number
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2513 example: {
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2514 "CountInstances" : 2352,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2515 "CountPatients" : 7,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2516 "CountSeries" : 23,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2517 "CountStudies" : 7,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2518 "TotalDiskSize" : "913213057",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2519 "TotalDiskSizeMB" : 870,
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2520 "TotalUncompressedSize" : "913213057",
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2521 "TotalUncompressedSizeMB" : 870
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2522 }
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2523
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2524 /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
2525 post:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2526 tags: [Lua]
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2527 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
2528 requestBody:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2529 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2530 text/plain:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2531 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
2532 responses:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2533 200:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2534 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
2535 content:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2536 text/plain:
0a97b61ae021 updated openapi based on Chris McGee message on 2019-08-18
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 265
diff changeset
2537 example: "42"