Mercurial > hg > orthanc-book

annotate OpenAPI/orthanc-openapi.yaml @ 267:0a97b61ae021

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