Mercurial > hg > orthanc-book

comparison OpenAPI/orthanc-openapi.yaml @ 286:833d4ec1c1e8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
separators in yaml files
author Alain Mazy <alain@mazy.be>
date Tue, 24 Sep 2019 10:15:55 +0200
parents 45ed5ab7f92a
children eeb2c72dd5df
comparison
equal deleted inserted replaced
285:45ed5ab7f92a 286:833d4ec1c1e8
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> 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>
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/ 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/
8 servers: 8 servers:
9 - url: 'https://demo.orthanc-server.com' 9 - url: 'https://demo.orthanc-server.com'
10 components: 10 components:
11
12 ####################################################################################
13 ## SCHEMAS / MODELS
14 ####################################################################################
15
11 schemas: 16 schemas:
12 patient: 17 patient:
13 properties: 18 properties:
14 ID: 19 ID:
15 type: string 20 type: string
202 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748" 207 "SOPInstanceUID" : "1.3.12.2.1107.5.1.4.36085.2.0.3752288429331748"
203 }, 208 },
204 "ParentSeries" : "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb", 209 "ParentSeries" : "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb",
205 "Type" : "Instance" 210 "Type" : "Instance"
206 } 211 }
212
213
207 jobId: 214 jobId:
208 properties: 215 properties:
209 ID: 216 ID:
210 type: string 217 type: string
211 Path: 218 Path:
212 type: string 219 type: string
213 example: { 220 example: {
214 "ID": "11541b16-e368-41cf-a8e9-3acf4061d238", 221 "ID": "11541b16-e368-41cf-a8e9-3acf4061d238",
215 "Path": "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238" 222 "Path": "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238"
216 } 223 }
224
225
217 jobCStore: 226 jobCStore:
218 properties: 227 properties:
219 Description: 228 Description:
220 type: string 229 type: string
221 FailedInstancesCount: 230 FailedInstancesCount:
249 "InstancesCount": 1, 258 "InstancesCount": 1,
250 "Peer": [ 259 "Peer": [
251 "http://127.0.0.1:8543/" 260 "http://127.0.0.1:8543/"
252 ] 261 ]
253 } 262 }
263
264
254 listOfResourcesWithAsynchOption: 265 listOfResourcesWithAsynchOption:
255 properties: 266 properties:
256 Resources: 267 Resources:
257 description: A list of resources IDs (Patient, Studies, Series or Instances) 268 description: A list of resources IDs (Patient, Studies, Series or Instances)
258 type: array 269 type: array
263 type: boolean 274 type: boolean
264 example: { 275 example: {
265 "Resources" : ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"], 276 "Resources" : ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"],
266 "Asynchronous" : true 277 "Asynchronous" : true
267 } 278 }
279
280
268 listOfResources: 281 listOfResources:
269 description: A list of resources IDs (Patient, Studies, Series or Instances) 282 description: A list of resources IDs (Patient, Studies, Series or Instances)
270 schema: 283 schema:
271 type: array 284 type: array
272 items: 285 items:
273 type: string 286 type: string
274 example: ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"] 287 example: ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"]
288
289
275 singleResource: 290 singleResource:
276 description: A resource ID (Patient, Studies, Series or Instances) 291 description: A resource ID (Patient, Studies, Series or Instances)
277 type: string 292 type: string
278 example: "62cdfbea-07c71f0c-cd643b19-841a306a-01221339" 293 example: "62cdfbea-07c71f0c-cd643b19-841a306a-01221339"
294
295 ####################################################################################
296 ## ROUTES / PATHS
297 ####################################################################################
298
279 paths: 299 paths:
280 /instances: 300 /instances:
281 post: 301 post:
282 tags: [Instances] 302 tags: [Instances]
283 description: The upload of DICOM files is possible by querying the REST API using the following syntax. 303 description: The upload of DICOM files is possible by querying the REST API using the following syntax.
1007 content: 1027 content:
1008 application/json: 1028 application/json:
1009 schema: 1029 schema:
1010 oneOf: 1030 oneOf:
1011 - $ref: "#/components/schemas/listOfResourcesWithAsynchOption" 1031 - $ref: "#/components/schemas/listOfResourcesWithAsynchOption"
1012 - $ref: "#/components/schemas/listOfResources" 1032 - $ref: "#/components/schemas/listOfResources"
1013 text/plain: 1033 text/plain:
1014 schema: 1034 schema:
1015 $ref: "#/components/schemas/singleResource" 1035 $ref: "#/components/schemas/singleResource"
1016 responses: 1036 responses:
1017 200: 1037 200: