Mercurial > hg > orthanc-book

annotate OpenAPI/orthanc-openapi.yaml @ 285:45ed5ab7f92a

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