orthanc-book: OpenAPI/orthanc-openapi.yaml annotate

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

separators in yaml files

author	Alain Mazy <alain@mazy.be>
date	Tue, 24 Sep 2019 10:15:55 +0200
parents	45ed5ab7f92a
children	eeb2c72dd5df

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

Mercurial > hg > orthanc-book

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