Mercurial > hg > orthanc-book

annotate OpenAPI/orthanc-openapi.yaml @ 273:869d6efbb54c

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