annotate OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp @ 5640:f7adfb22e20e

updated copyright, as Orthanc Team now replaces Osimis
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 30 May 2024 21:19:57 +0200
parents 7043e646fc0d
children a8e9113dc8f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1819
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1165
diff changeset
4 * Department, University Hospital of Liege, Belgium
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5637
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5637
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5442
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * This program is free software: you can redistribute it and/or
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * modify it under the terms of the GNU General Public License as
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * published by the Free Software Foundation, either version 3 of the
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * License, or (at your option) any later version.
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 *
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * General Public License for more details.
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 *
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
831
84513f2ee1f3 pch for unit tests and server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 824
diff changeset
24 #include "../PrecompiledHeadersServer.h"
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "OrthancRestApi.h"
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../../OrthancFramework/Sources/Cache/SharedArchive.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
28 #include "../../../OrthancFramework/Sources/DicomNetworking/DicomAssociation.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
29 #include "../../../OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
30 #include "../../../OrthancFramework/Sources/DicomParsing/FromDcmtkBridge.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
31 #include "../../../OrthancFramework/Sources/Logging.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
32 #include "../../../OrthancFramework/Sources/SerializationToolbox.h"
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
33
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
34 #include "../OrthancConfiguration.h"
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
35 #include "../QueryRetrieveHandler.h"
3097
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3096
diff changeset
36 #include "../ServerContext.h"
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2589
diff changeset
37 #include "../ServerJobs/DicomModalityStoreJob.h"
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
38 #include "../ServerJobs/DicomMoveScuJob.h"
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2589
diff changeset
39 #include "../ServerJobs/OrthancPeerStoreJob.h"
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
40 #include "../ServerToolbox.h"
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
41 #include "../StorageCommitmentReports.h"
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
2573
3372c5255333 StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
43
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 namespace Orthanc
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
46 static const char* const KEY_LEVEL = "Level";
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
47 static const char* const KEY_LOCAL_AET = "LocalAet";
5110
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
48 static const char* const KEY_CALLED_AET = "CalledAet";
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
49 static const char* const KEY_HOST = "Host";
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
50 static const char* const KEY_PORT = "Port";
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
51 static const char* const KEY_NORMALIZE = "Normalize";
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
52 static const char* const KEY_QUERY = "Query";
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
53 static const char* const KEY_RESOURCES = "Resources";
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
54 static const char* const KEY_TARGET_AET = "TargetAet";
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
55 static const char* const KEY_TIMEOUT = "Timeout";
4340
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
56 static const char* const KEY_CHECK_FIND = "CheckFind";
3808
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
57 static const char* const SOP_CLASS_UID = "SOPClassUID";
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
58 static const char* const SOP_INSTANCE_UID = "SOPInstanceUID";
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
59
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
60 static RemoteModalityParameters MyGetModalityUsingSymbolicName(const std::string& name)
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
61 {
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
62 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
63 return lock.GetConfiguration().GetModalityUsingSymbolicName(name);
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
64 }
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
65
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
66
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
67 static void InjectAssociationTimeout(DicomAssociationParameters& params,
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
68 const Json::Value& body)
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
69 {
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
70 if (body.type() == Json::objectValue &&
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
71 body.isMember(KEY_TIMEOUT))
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
72 {
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
73 // New in Orthanc 1.7.0
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
74 params.SetTimeout(SerializationToolbox::ReadUnsignedInteger(body, KEY_TIMEOUT));
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
75 }
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
76 }
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
77
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
78 static DicomAssociationParameters GetAssociationParameters(RestApiPostCall& call,
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
79 const Json::Value& body)
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
80 {
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
81 const std::string& localAet =
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
82 OrthancRestApi::GetContext(call).GetDefaultLocalApplicationEntityTitle();
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
83 const RemoteModalityParameters remote =
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
84 MyGetModalityUsingSymbolicName(call.GetUriComponent("id", ""));
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
85
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
86 DicomAssociationParameters params(localAet, remote);
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
87 InjectAssociationTimeout(params, body);
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
88
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
89 return params;
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
90 }
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
91
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
92
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
93 static DicomAssociationParameters GetAssociationParameters(RestApiPostCall& call)
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
94 {
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
95 Json::Value body;
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
96
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
97 if (!call.ParseJsonRequest(body))
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
98 {
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
99 throw OrthancException(ErrorCode_BadFileFormat, "Cannot parse the JSON body");
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
100 }
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
101
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
102 return GetAssociationParameters(call, body);
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
103 }
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
104
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
105
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
106 static void DocumentModalityParametersShared(RestApiCall& call,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
107 bool includePermissions)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
108 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
109 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
110 .SetRequestField("AET", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
111 "AET of the remote DICOM modality", true)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
112 .SetRequestField("Host", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
113 "Host address of the remote DICOM modality (typically, an IP address)", true)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
114 .SetRequestField("Port", RestApiCallDocumentation::Type_Number,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
115 "TCP port of the remote DICOM modality", true)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
116 .SetRequestField("Manufacturer", RestApiCallDocumentation::Type_String, "Manufacturer of the remote DICOM "
4438
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
117 "modality (check configuration option `DicomModalities` for possible values", false)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
118 .SetRequestField("UseDicomTls", RestApiCallDocumentation::Type_Boolean, "Whether to use DICOM TLS "
5636
6ad8e2afd4fb added missing LocalAet & Timeout documentation
Alain Mazy <am@orthanc.team>
parents: 5485
diff changeset
119 "in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)", false)
5637
7043e646fc0d fix: reuse constant
Alain Mazy <am@orthanc.team>
parents: 5636
diff changeset
120 .SetRequestField(KEY_LOCAL_AET, RestApiCallDocumentation::Type_String, "Whether to override the default DicomAet "
5636
6ad8e2afd4fb added missing LocalAet & Timeout documentation
Alain Mazy <am@orthanc.team>
parents: 5485
diff changeset
121 "in the SCU connection initiated by Orthanc to this modality", false)
5637
7043e646fc0d fix: reuse constant
Alain Mazy <am@orthanc.team>
parents: 5636
diff changeset
122 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, "Whether to override the default DicomScuTimeout "
5636
6ad8e2afd4fb added missing LocalAet & Timeout documentation
Alain Mazy <am@orthanc.team>
parents: 5485
diff changeset
123 "in the SCU connection initiated by Orthanc to this modality", false);
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
124
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
125 if (includePermissions)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
126 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
127 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
128 .SetRequestField("AllowEcho", RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
129 "Whether to accept C-ECHO SCU commands issued by the remote modality", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
130 .SetRequestField("AllowStore", RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
131 "Whether to accept C-STORE SCU commands issued by the remote modality", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
132 .SetRequestField("AllowFind", RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
133 "Whether to accept C-FIND SCU commands issued by the remote modality", false)
4888
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
134 .SetRequestField("AllowFindWorklist", RestApiCallDocumentation::Type_Boolean,
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
135 "Whether to accept C-FIND SCU commands for worklists issued by the remote modality", false)
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
136 .SetRequestField("AllowMove", RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
137 "Whether to accept C-MOVE SCU commands issued by the remote modality", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
138 .SetRequestField("AllowGet", RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
139 "Whether to accept C-GET SCU commands issued by the remote modality", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
140 .SetRequestField("AllowStorageCommitment", RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
141 "Whether to accept storage commitment requests issued by the remote modality", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
142 .SetRequestField("AllowTranscoding", RestApiCallDocumentation::Type_Boolean,
4480
d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4463
diff changeset
143 "Whether to allow transcoding for operations initiated by this modality. "
d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4463
diff changeset
144 "This option applies to Orthanc C-GET SCP and to Orthanc C-STORE SCU. "
d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4463
diff changeset
145 "It only has an effect if the global option `EnableTranscoding` is set to `true`.", false);
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
146 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
147 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
148
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
149
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
150 /***************************************************************************
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
151 * DICOM C-Echo SCU
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
152 ***************************************************************************/
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
153
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
154 static void ExecuteEcho(RestApiOutput& output,
4340
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
155 const DicomAssociationParameters& parameters,
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
156 const Json::Value& body)
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
157 {
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
158 DicomControlUserConnection connection(parameters);
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
159
3894
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3876
diff changeset
160 if (connection.Echo())
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3876
diff changeset
161 {
4340
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
162 bool find = false;
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
163
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
164 if (body.type() == Json::objectValue &&
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
165 body.isMember(KEY_CHECK_FIND))
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
166 {
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
167 find = SerializationToolbox::ReadBoolean(body, KEY_CHECK_FIND);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
168 }
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
169 else
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
170 {
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
171 OrthancConfiguration::ReaderLock lock;
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
172 find = lock.GetConfiguration().GetBooleanParameter("DicomEchoChecksFind", false);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
173 }
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
174
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
175 if (find)
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
176 {
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
177 // Issue a C-FIND request at the study level about a random Study Instance UID
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
178 const std::string studyInstanceUid = FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Study);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
179
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
180 DicomMap query;
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
181 query.SetValue(DICOM_TAG_STUDY_INSTANCE_UID, studyInstanceUid, false);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
182
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
183 DicomFindAnswers answers(false /* not a worklist */);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
184
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
185 // The following line throws an exception if the remote modality doesn't support C-FIND
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
186 connection.Find(answers, ResourceType_Study, query, false /* normalize */);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
187 }
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
188
3894
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3876
diff changeset
189 // Echo has succeeded
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
190 output.AnswerBuffer("{}", MimeType_Json);
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
191 }
3894
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3876
diff changeset
192 else
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
193 {
3894
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3876
diff changeset
194 // Echo has failed
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
195 output.SignalError(HttpStatus_500_InternalServerError);
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
196 }
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
197 }
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
198
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
199
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
200 static void DocumentEchoShared(RestApiPostCall& call)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
201 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
202 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
203 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
204 "Timeout for the C-ECHO command, in seconds", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
205 .SetRequestField(KEY_CHECK_FIND, RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
206 "Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
207 "modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
208 "configuration option. New in Orthanc 1.8.1.", false);
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
209 }
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
210
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
211
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
212 static void DicomEcho(RestApiPostCall& call)
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
213 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
214 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
215 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
216 DocumentEchoShared(call);
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
217 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
218 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
219 .SetSummary("Trigger C-ECHO SCU")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
220 .SetDescription("Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
221 "https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo")
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
222 .SetUriArgument("id", "Identifier of the modality of interest");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
223 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
224 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
225
4367
189e48f4a92a Allow empty request body in "/modalities/{id}/echo"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4340
diff changeset
226 Json::Value body = Json::objectValue;
189e48f4a92a Allow empty request body in "/modalities/{id}/echo"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4340
diff changeset
227
189e48f4a92a Allow empty request body in "/modalities/{id}/echo"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4340
diff changeset
228 if (call.GetBodySize() == 0 /* allow empty body, was disallowed in Orthanc 1.7.0->1.8.1 */ ||
189e48f4a92a Allow empty request body in "/modalities/{id}/echo"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4340
diff changeset
229 call.ParseJsonRequest(body))
4340
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
230 {
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
231 const DicomAssociationParameters parameters = GetAssociationParameters(call, body);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
232 ExecuteEcho(call.GetOutput(), parameters, body);
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
233 }
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
234 else
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
235 {
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
236 throw OrthancException(ErrorCode_BadFileFormat, "Cannot parse the JSON body");
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
237 }
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
238 }
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
239
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
240
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
241 static void DicomEchoTool(RestApiPostCall& call)
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
242 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
243 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
244 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
245 DocumentEchoShared(call);
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
246 DocumentModalityParametersShared(call, false);
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
247 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
248 .SetTag("System")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
249 .SetSummary("Trigger C-ECHO SCU")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
250 .SetDescription("Trigger C-ECHO SCU command against a DICOM modality described in the POST body, "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
251 "without having to register the modality in some `/modalities/{id}` (new in Orthanc 1.8.1)");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
252 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
253 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
254
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
255 Json::Value body;
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
256 if (call.ParseJsonRequest(body))
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
257 {
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
258 RemoteModalityParameters modality;
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
259 modality.Unserialize(body);
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
260
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
261 const std::string& localAet =
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
262 OrthancRestApi::GetContext(call).GetDefaultLocalApplicationEntityTitle();
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
263
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
264 DicomAssociationParameters params(localAet, modality);
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
265 InjectAssociationTimeout(params, body);
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
266
4340
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4339
diff changeset
267 ExecuteEcho(call.GetOutput(), params, body);
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
268 }
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
269 else
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
270 {
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
271 throw OrthancException(ErrorCode_BadFileFormat, "Cannot parse the JSON body");
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
272 }
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
273 }
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
274
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
275
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
276 /***************************************************************************
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
277 * DICOM C-Find SCU => DEPRECATED!
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
278 ***************************************************************************/
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
279
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
280 static bool MergeQueryAndTemplate(DicomMap& result,
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
281 const RestApiCall& call)
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
282 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
283 Json::Value query;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
284
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
285 if (!call.ParseJsonRequest(query) ||
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
286 query.type() != Json::objectValue)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
287 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
288 return false;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
289 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
290
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
291 Json::Value::Members members = query.getMemberNames();
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
292 for (size_t i = 0; i < members.size(); i++)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
293 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
294 DicomTag t = FromDcmtkBridge::ParseTag(members[i]);
2007
655489d9165d DicomMap::ParseDicomMetaInformation()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1998
diff changeset
295 result.SetValue(t, query[members[i]].asString(), false);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
296 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
297
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
298 return true;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
299 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
300
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
301
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
302 static void FindPatient(DicomFindAnswers& result,
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
303 DicomControlUserConnection& connection,
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
304 const DicomMap& fields)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
305 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
306 // Only keep the filters from "fields" that are related to the patient
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
307 DicomMap s;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
308 fields.ExtractPatientInformation(s);
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
309 connection.Find(result, ResourceType_Patient, s, true /* normalize */);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
310 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
311
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
312
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
313 static void FindStudy(DicomFindAnswers& result,
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
314 DicomControlUserConnection& connection,
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
315 const DicomMap& fields)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
316 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
317 // Only keep the filters from "fields" that are related to the study
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
318 DicomMap s;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
319 fields.ExtractStudyInformation(s);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
320
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
321 s.CopyTagIfExists(fields, DICOM_TAG_PATIENT_ID);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
322 s.CopyTagIfExists(fields, DICOM_TAG_ACCESSION_NUMBER);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
323 s.CopyTagIfExists(fields, DICOM_TAG_MODALITIES_IN_STUDY);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
324
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
325 connection.Find(result, ResourceType_Study, s, true /* normalize */);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
326 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
327
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
328 static void FindSeries(DicomFindAnswers& result,
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
329 DicomControlUserConnection& connection,
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
330 const DicomMap& fields)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
331 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
332 // Only keep the filters from "fields" that are related to the series
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
333 DicomMap s;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
334 fields.ExtractSeriesInformation(s);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
335
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
336 s.CopyTagIfExists(fields, DICOM_TAG_PATIENT_ID);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
337 s.CopyTagIfExists(fields, DICOM_TAG_ACCESSION_NUMBER);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
338 s.CopyTagIfExists(fields, DICOM_TAG_STUDY_INSTANCE_UID);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
339
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
340 connection.Find(result, ResourceType_Series, s, true /* normalize */);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
341 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
342
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
343 static void FindInstance(DicomFindAnswers& result,
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
344 DicomControlUserConnection& connection,
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
345 const DicomMap& fields)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
346 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
347 // Only keep the filters from "fields" that are related to the instance
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
348 DicomMap s;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
349 fields.ExtractInstanceInformation(s);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
350
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
351 s.CopyTagIfExists(fields, DICOM_TAG_PATIENT_ID);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
352 s.CopyTagIfExists(fields, DICOM_TAG_ACCESSION_NUMBER);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
353 s.CopyTagIfExists(fields, DICOM_TAG_STUDY_INSTANCE_UID);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
354 s.CopyTagIfExists(fields, DICOM_TAG_SERIES_INSTANCE_UID);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
355
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
356 connection.Find(result, ResourceType_Instance, s, true /* normalize */);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
357 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
358
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
359
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
360 static void DicomFindPatient(RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
361 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
362 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
363 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
364 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
365 .SetDeprecated()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
366 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
367 .SetSummary("C-FIND SCU for patients")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
368 .SetDescription("Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
369 "in order to find a patient. Deprecated in favor of `/modalities/{id}/query`.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
370 .AddRequestType(MimeType_Json, "Associative array containing the query on the values of the DICOM tags")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
371 .AddAnswerType(MimeType_Json, "JSON array describing the DICOM tags of the matching patients")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
372 .SetUriArgument("id", "Identifier of the modality of interest");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
373 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
374 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
375
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
376 LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri();
773
3bd0589af992 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 751
diff changeset
377
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
378 DicomMap fields;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
379 DicomMap::SetupFindPatientTemplate(fields);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
380 if (!MergeQueryAndTemplate(fields, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
381 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
382 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
383 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
384
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
385 DicomFindAnswers answers(false);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
386
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
387 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
388 DicomControlUserConnection connection(GetAssociationParameters(call));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
389 FindPatient(answers, connection, fields);
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
390 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
391
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
392 Json::Value result;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
393 answers.ToJson(result, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
394 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
395 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
396
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
397 static void DicomFindStudy(RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
398 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
399 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
400 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
401 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
402 .SetDeprecated()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
403 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
404 .SetSummary("C-FIND SCU for studies")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
405 .SetDescription("Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
406 "in order to find a study. Deprecated in favor of `/modalities/{id}/query`.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
407 .AddRequestType(MimeType_Json, "Associative array containing the query on the values of the DICOM tags")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
408 .AddAnswerType(MimeType_Json, "JSON array describing the DICOM tags of the matching studies")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
409 .SetUriArgument("id", "Identifier of the modality of interest");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
410 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
411 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
412
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
413 LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri();
773
3bd0589af992 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 751
diff changeset
414
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
415 DicomMap fields;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
416 DicomMap::SetupFindStudyTemplate(fields);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
417 if (!MergeQueryAndTemplate(fields, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
418 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
419 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
420 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
421
1737
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
422 if (fields.GetValue(DICOM_TAG_ACCESSION_NUMBER).GetContent().size() <= 2 &&
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
423 fields.GetValue(DICOM_TAG_PATIENT_ID).GetContent().size() <= 2)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
424 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
425 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
426 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
427
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
428 DicomFindAnswers answers(false);
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
429
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
430 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
431 DicomControlUserConnection connection(GetAssociationParameters(call));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
432 FindStudy(answers, connection, fields);
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
433 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
434
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
435 Json::Value result;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
436 answers.ToJson(result, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
437 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
438 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
439
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
440 static void DicomFindSeries(RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
441 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
442 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
443 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
444 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
445 .SetDeprecated()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
446 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
447 .SetSummary("C-FIND SCU for series")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
448 .SetDescription("Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
449 "in order to find a series. Deprecated in favor of `/modalities/{id}/query`.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
450 .AddRequestType(MimeType_Json, "Associative array containing the query on the values of the DICOM tags")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
451 .AddAnswerType(MimeType_Json, "JSON array describing the DICOM tags of the matching series")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
452 .SetUriArgument("id", "Identifier of the modality of interest");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
453 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
454 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
455
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
456 LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri();
773
3bd0589af992 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 751
diff changeset
457
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
458 DicomMap fields;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
459 DicomMap::SetupFindSeriesTemplate(fields);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
460 if (!MergeQueryAndTemplate(fields, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
461 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
462 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
463 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
464
1737
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
465 if ((fields.GetValue(DICOM_TAG_ACCESSION_NUMBER).GetContent().size() <= 2 &&
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
466 fields.GetValue(DICOM_TAG_PATIENT_ID).GetContent().size() <= 2) ||
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
467 fields.GetValue(DICOM_TAG_STUDY_INSTANCE_UID).GetContent().size() <= 2)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
468 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
469 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
470 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
471
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
472 DicomFindAnswers answers(false);
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
473
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
474 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
475 DicomControlUserConnection connection(GetAssociationParameters(call));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
476 FindSeries(answers, connection, fields);
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
477 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
478
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
479 Json::Value result;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
480 answers.ToJson(result, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
481 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
482 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
483
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
484 static void DicomFindInstance(RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
485 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
486 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
487 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
488 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
489 .SetDeprecated()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
490 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
491 .SetSummary("C-FIND SCU for instances")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
492 .SetDescription("Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
493 "in order to find an instance. Deprecated in favor of `/modalities/{id}/query`.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
494 .AddRequestType(MimeType_Json, "Associative array containing the query on the values of the DICOM tags")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
495 .AddAnswerType(MimeType_Json, "JSON array describing the DICOM tags of the matching instances")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
496 .SetUriArgument("id", "Identifier of the modality of interest");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
497 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
498 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
499
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
500 LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri();
773
3bd0589af992 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 751
diff changeset
501
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
502 DicomMap fields;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
503 DicomMap::SetupFindInstanceTemplate(fields);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
504 if (!MergeQueryAndTemplate(fields, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
505 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
506 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
507 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
508
1737
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
509 if ((fields.GetValue(DICOM_TAG_ACCESSION_NUMBER).GetContent().size() <= 2 &&
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
510 fields.GetValue(DICOM_TAG_PATIENT_ID).GetContent().size() <= 2) ||
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
511 fields.GetValue(DICOM_TAG_STUDY_INSTANCE_UID).GetContent().size() <= 2 ||
ec66a16aa398 removal of DicomStringValue and DicomNullValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
512 fields.GetValue(DICOM_TAG_SERIES_INSTANCE_UID).GetContent().size() <= 2)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
513 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
514 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
515 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
516
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
517 DicomFindAnswers answers(false);
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
518
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
519 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
520 DicomControlUserConnection connection(GetAssociationParameters(call));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
521 FindInstance(answers, connection, fields);
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
522 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
523
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
524 Json::Value result;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
525 answers.ToJson(result, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
526 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
527 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
528
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
529
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
530 static void CopyTagIfExists(DicomMap& target,
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4153
diff changeset
531 const ParsedDicomFile& source,
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
532 const DicomTag& tag)
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
533 {
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
534 std::string tmp;
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
535 if (source.GetTagValue(tmp, tag))
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
536 {
2007
655489d9165d DicomMap::ParseDicomMetaInformation()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1998
diff changeset
537 target.SetValue(tag, tmp, false);
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
538 }
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
539 }
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
540
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
541
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
542 static void DicomFind(RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
543 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
544 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
545 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
546 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
547 .SetDeprecated()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
548 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
549 .SetSummary("Hierarchical C-FIND SCU")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
550 .SetDescription("Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
551 "in order to discover a hierarchy of matching patients/studies/series. "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
552 "Deprecated in favor of `/modalities/{id}/query`.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
553 .AddRequestType(MimeType_Json, "Associative array containing the query on the values of the DICOM tags")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
554 .AddAnswerType(MimeType_Json, "JSON array describing the DICOM tags of the matching patients, embedding the "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
555 "matching studies, then the matching series.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
556 .SetUriArgument("id", "Identifier of the modality of interest");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
557 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
558 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
559
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
560 LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri();
773
3bd0589af992 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 751
diff changeset
561
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
562 DicomMap m;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
563 DicomMap::SetupFindPatientTemplate(m);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
564 if (!MergeQueryAndTemplate(m, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
565 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
566 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
567 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
568
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
569 DicomControlUserConnection connection(GetAssociationParameters(call));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
570
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
571 DicomFindAnswers patients(false);
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
572 FindPatient(patients, connection, m);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
573
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
574 // Loop over the found patients
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
575 Json::Value result = Json::arrayValue;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
576 for (size_t i = 0; i < patients.GetSize(); i++)
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
577 {
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
578 Json::Value patient;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
579 patients.ToJson(patient, i, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
580
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
581 DicomMap::SetupFindStudyTemplate(m);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
582 if (!MergeQueryAndTemplate(m, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
583 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
584 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
585 }
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
586
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
587 CopyTagIfExists(m, patients.GetAnswer(i), DICOM_TAG_PATIENT_ID);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
588
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
589 DicomFindAnswers studies(false);
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
590 FindStudy(studies, connection, m);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
591
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
592 patient["Studies"] = Json::arrayValue;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
593
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
594 // Loop over the found studies
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
595 for (size_t j = 0; j < studies.GetSize(); j++)
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
596 {
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
597 Json::Value study;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
598 studies.ToJson(study, j, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
599
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
600 DicomMap::SetupFindSeriesTemplate(m);
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
601 if (!MergeQueryAndTemplate(m, call))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
602 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
603 return;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
604 }
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
605
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
606 CopyTagIfExists(m, studies.GetAnswer(j), DICOM_TAG_PATIENT_ID);
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
607 CopyTagIfExists(m, studies.GetAnswer(j), DICOM_TAG_STUDY_INSTANCE_UID);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
608
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
609 DicomFindAnswers series(false);
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
610 FindSeries(series, connection, m);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
611
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
612 // Loop over the found series
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
613 study["Series"] = Json::arrayValue;
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
614 for (size_t k = 0; k < series.GetSize(); k++)
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
615 {
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
616 Json::Value series2;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
617 series.ToJson(series2, k, DicomToJsonFormat_Human);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
618 study["Series"].append(series2);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
619 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
620
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
621 patient["Studies"].append(study);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
622 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
623
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
624 result.append(patient);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
625 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
626
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
627 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
628 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
629
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
630
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
631
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
632 /***************************************************************************
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
633 * DICOM C-Find and C-Move SCU => Recommended since Orthanc 0.9.0
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
634 ***************************************************************************/
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
635
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
636 static void AnswerQueryHandler(RestApiPostCall& call,
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3691
diff changeset
637 std::unique_ptr<QueryRetrieveHandler>& handler)
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
638 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
639 ServerContext& context = OrthancRestApi::GetContext(call);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
640
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
641 if (handler.get() == NULL)
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
642 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
643 throw OrthancException(ErrorCode_NullPointer);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
644 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
645
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
646 handler->Run();
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
647
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
648 std::string s = context.GetQueryRetrieveArchive().Add(handler.release());
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
649 Json::Value result = Json::objectValue;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
650 result["ID"] = s;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
651 result["Path"] = "/queries/" + s;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
652
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
653 call.GetOutput().AnswerJson(result);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
654 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
655
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
656
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
657 static void DicomQuery(RestApiPostCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
658 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
659 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
660 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
661 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
662 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
663 .SetSummary("Trigger C-FIND SCU")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
664 .SetDescription("Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
665 "https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest")
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
666 .SetUriArgument("id", "Identifier of the modality of interest")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
667 .SetRequestField(KEY_QUERY, RestApiCallDocumentation::Type_JsonObject,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
668 "Associative array containing the filter on the values of the DICOM tags", true)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
669 .SetRequestField(KEY_LEVEL, RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
670 "Level of the query (`Patient`, `Study`, `Series` or `Instance`)", true)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
671 .SetRequestField(KEY_NORMALIZE, RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
672 "Whether to normalize the query, i.e. whether to wipe out from the query, the DICOM tags "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
673 "that are not applicable for the query-retrieve level of interest", false)
4462
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
674 .SetRequestField(KEY_LOCAL_AET, RestApiCallDocumentation::Type_String,
4463
522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4462
diff changeset
675 "Local AET that is used for this commands, defaults to `DicomAet` configuration option. "
522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4462
diff changeset
676 "Ignored if `DicomModalities` already sets `LocalAet` for this modality.", false)
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
677 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
678 "Timeout for the C-FIND command and subsequent C-MOVE retrievals, in seconds (new in Orthanc 1.9.1)", false)
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
679 .SetAnswerField("ID", RestApiCallDocumentation::Type_JsonObject,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
680 "Identifier of the query, to be used with `/queries/{id}`")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
681 .SetAnswerField("Path", RestApiCallDocumentation::Type_JsonObject,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
682 "Root path to the query in the REST API");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
683 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
684 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
685
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
686 ServerContext& context = OrthancRestApi::GetContext(call);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
687 Json::Value request;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
688
3345
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
689 if (!call.ParseJsonRequest(request) ||
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
690 request.type() != Json::objectValue)
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
691 {
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
692 throw OrthancException(ErrorCode_BadFileFormat, "Must provide a JSON object");
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
693 }
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
694 else if (!request.isMember(KEY_LEVEL) ||
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
695 request[KEY_LEVEL].type() != Json::stringValue)
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
696 {
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
697 throw OrthancException(ErrorCode_BadFileFormat,
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
698 "The JSON body must contain field " + std::string(KEY_LEVEL));
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
699 }
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
700 else if (request.isMember(KEY_NORMALIZE) &&
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
701 request[KEY_NORMALIZE].type() != Json::booleanValue)
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
702 {
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
703 throw OrthancException(ErrorCode_BadFileFormat,
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
704 "The field " + std::string(KEY_NORMALIZE) + " must contain a Boolean");
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
705 }
3345
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
706 else if (request.isMember(KEY_QUERY) &&
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
707 request[KEY_QUERY].type() != Json::objectValue)
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
708 {
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
709 throw OrthancException(ErrorCode_BadFileFormat,
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
710 "The field " + std::string(KEY_QUERY) + " must contain a JSON object");
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
711 }
4462
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
712 else if (request.isMember(KEY_LOCAL_AET) &&
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
713 request[KEY_LOCAL_AET].type() != Json::stringValue)
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
714 {
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
715 throw OrthancException(ErrorCode_BadFileFormat,
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
716 "The field " + std::string(KEY_LOCAL_AET) + " must contain a string");
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
717 }
3345
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
718 else
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
719 {
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3691
diff changeset
720 std::unique_ptr<QueryRetrieveHandler> handler(new QueryRetrieveHandler(context));
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
721
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
722 handler->SetModality(call.GetUriComponent("id", ""));
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
723 handler->SetLevel(StringToResourceType(request[KEY_LEVEL].asCString()));
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
724
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
725 if (request.isMember(KEY_QUERY))
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
726 {
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
727 std::map<DicomTag, std::string> query;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
728 SerializationToolbox::ReadMapOfTags(query, request, KEY_QUERY);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
729
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
730 for (std::map<DicomTag, std::string>::const_iterator
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
731 it = query.begin(); it != query.end(); ++it)
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
732 {
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
733 handler->SetQuery(it->first, it->second);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
734 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
735 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
736
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
737 if (request.isMember(KEY_NORMALIZE))
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
738 {
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
739 handler->SetFindNormalized(request[KEY_NORMALIZE].asBool());
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
740 }
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
741
4462
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
742 if (request.isMember(KEY_LOCAL_AET))
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
743 {
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
744 handler->SetLocalAet(request[KEY_LOCAL_AET].asString());
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
745 }
da460bef88f8 "/modalities/{...}/query": New string argument "LocalAet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4460
diff changeset
746
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
747 if (request.isMember(KEY_TIMEOUT))
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
748 {
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
749 // New in Orthanc 1.9.1
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
750 handler->SetTimeout(SerializationToolbox::ReadUnsignedInteger(request, KEY_TIMEOUT));
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
751 }
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
752
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
753 AnswerQueryHandler(call, handler);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
754 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
755 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
756
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
757
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
758 static void ListQueries(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
759 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
760 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
761 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
762 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
763 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
764 .SetSummary("List query/retrieve operations")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
765 .SetDescription("List the identifiers of all the query/retrieve operations on DICOM modalities, "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
766 "as initiated by calls to `/modalities/{id}/query`. The length of this list is bounded "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
767 "by the `QueryRetrieveSize` configuration option of Orthanc. "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
768 "https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
769 .AddAnswerType(MimeType_Json, "JSON array containing the identifiers");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
770 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
771 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
772
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
773 ServerContext& context = OrthancRestApi::GetContext(call);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
774
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
775 std::list<std::string> queries;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
776 context.GetQueryRetrieveArchive().List(queries);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
777
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
778 Json::Value result = Json::arrayValue;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
779 for (std::list<std::string>::const_iterator
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
780 it = queries.begin(); it != queries.end(); ++it)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
781 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
782 result.append(*it);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
783 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
784
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
785 call.GetOutput().AnswerJson(result);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
786 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
787
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
788
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
789 namespace
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
790 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
791 class QueryAccessor
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
792 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
793 private:
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
794 ServerContext& context_;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
795 SharedArchive::Accessor accessor_;
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
796 QueryRetrieveHandler* handler_;
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
797
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
798 public:
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4153
diff changeset
799 explicit QueryAccessor(RestApiCall& call) :
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
800 context_(OrthancRestApi::GetContext(call)),
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
801 accessor_(context_.GetQueryRetrieveArchive(), call.GetUriComponent("id", "")),
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
802 handler_(NULL)
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
803 {
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
804 if (accessor_.IsValid())
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
805 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
806 handler_ = &dynamic_cast<QueryRetrieveHandler&>(accessor_.GetItem());
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
807 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
808 else
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
809 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
810 throw OrthancException(ErrorCode_UnknownResource);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
811 }
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
812 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
813
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
814 QueryRetrieveHandler& GetHandler() const
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
815 {
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
816 assert(handler_ != NULL);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
817 return *handler_;
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
818 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
819 };
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
820
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
821 static void AnswerDicomMap(RestApiGetCall& call,
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
822 const DicomMap& value,
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
823 DicomToJsonFormat format)
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
824 {
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
825 Json::Value full = Json::objectValue;
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
826 FromDcmtkBridge::ToJson(full, value, format);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
827 call.GetOutput().AnswerJson(full);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
828 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
829 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
830
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
831
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
832 static void ListQueryAnswers(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
833 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
834 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
835 {
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
836 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
837
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
838 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
839 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
840 .SetSummary("List answers to a query")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
841 .SetDescription("List the indices of all the available answers resulting from a query/retrieve operation "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
842 "on some DICOM modality, whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
843 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
844 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
845 "If present, retrieve detailed information about the individual answers", false)
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
846 .AddAnswerType(MimeType_Json, "JSON array containing the indices of the answers, or detailed information "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
847 "about the reported answers (if `expand` argument is provided)");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
848 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
849 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
850
5405
62bb63346185 All 'expand' GET arguments now accepts expand=true and expand=false values + /studies/../instances now supports expand=false
Alain Mazy <am@osimis.io>
parents: 5256
diff changeset
851 const bool expand = call.HasArgument("expand") && call.GetBooleanArgument("expand", true);
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
852 const DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full);
2948
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
853
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
854 QueryAccessor query(call);
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
855 size_t count = query.GetHandler().GetAnswersCount();
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
856
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
857 Json::Value result = Json::arrayValue;
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
858 for (size_t i = 0; i < count; i++)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
859 {
2948
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
860 if (expand)
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
861 {
2988
9cc3d40e389b Orthanc 1.4.3 is now known as 1.5.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2986
diff changeset
862 // New in Orthanc 1.5.0
2948
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
863 DicomMap value;
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
864 query.GetHandler().GetAnswer(value, i);
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
865
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
866 Json::Value json = Json::objectValue;
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
867 FromDcmtkBridge::ToJson(json, value, format);
2948
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
868
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
869 result.append(json);
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
870 }
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
871 else
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
872 {
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
873 result.append(boost::lexical_cast<std::string>(i));
d2e548e643af New options to URI "/queries/.../answers": "?expand" and "?limit"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2944
diff changeset
874 }
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
875 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
876
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
877 call.GetOutput().AnswerJson(result);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
878 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
879
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
880
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
881 static void GetQueryOneAnswer(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
882 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
883 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
884 {
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
885 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
886
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
887 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
888 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
889 .SetSummary("Get one answer")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
890 .SetDescription("Get the content (DICOM tags) of one answer associated with the "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
891 "query/retrieve operation whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
892 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
893 .SetUriArgument("index", "Index of the answer")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
894 .AddAnswerType(MimeType_Json, "JSON object containing the DICOM tags of the answer");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
895 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
896 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
897
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
898 size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", ""));
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
899
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
900 QueryAccessor query(call);
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
901
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
902 DicomMap map;
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
903 query.GetHandler().GetAnswer(map, index);
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
904
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
905 AnswerDicomMap(call, map, OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full));
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
906 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
907
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
908
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
909 static void SubmitRetrieveJob(RestApiPostCall& call,
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
910 bool allAnswers,
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
911 size_t index)
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
912 {
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
913 ServerContext& context = OrthancRestApi::GetContext(call);
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
914
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
915 std::string targetAet;
3870
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
916 int timeout = -1;
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
917
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
918 Json::Value body;
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
919 if (call.ParseJsonRequest(body))
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
920 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
921 targetAet = Toolbox::GetJsonStringField(body, KEY_TARGET_AET, context.GetDefaultLocalApplicationEntityTitle());
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
922 timeout = Toolbox::GetJsonIntegerField(body, KEY_TIMEOUT, -1);
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
923 }
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
924 else
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
925 {
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
926 body = Json::objectValue;
3870
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
927 if (call.GetBodySize() > 0)
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
928 {
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
929 call.BodyToString(targetAet);
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
930 }
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
931 else
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
932 {
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
933 targetAet = context.GetDefaultLocalApplicationEntityTitle();
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
934 }
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
935 }
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
936
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3691
diff changeset
937 std::unique_ptr<DicomMoveScuJob> job(new DicomMoveScuJob(context));
4730
7826ac059c31 Added Short/Simplify/Full options to format "/modalities/{id}/find-worklist" and "/queries/{id}/retrieve"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4729
diff changeset
938 job->SetQueryFormat(OrthancRestApi::GetDicomFormat(body, DicomToJsonFormat_Short));
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
939
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
940 {
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
941 QueryAccessor query(call);
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
942 job->SetTargetAet(targetAet);
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
943 job->SetLocalAet(query.GetHandler().GetLocalAet());
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
944 job->SetRemoteModality(query.GetHandler().GetRemoteModality());
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
945
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
946 if (timeout >= 0)
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
947 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
948 // New in Orthanc 1.7.0
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
949 job->SetTimeout(static_cast<uint32_t>(timeout));
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
950 }
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
951 else if (query.GetHandler().HasTimeout())
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
952 {
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
953 // New in Orthanc 1.9.1
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
954 job->SetTimeout(query.GetHandler().GetTimeout());
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
955 }
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
956
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
957 LOG(WARNING) << "Driving C-Move SCU on remote modality "
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
958 << query.GetHandler().GetRemoteModality().GetApplicationEntityTitle()
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
959 << " to target modality " << targetAet;
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
960
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
961 if (allAnswers)
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
962 {
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
963 for (size_t i = 0; i < query.GetHandler().GetAnswersCount(); i++)
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
964 {
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
965 job->AddFindAnswer(query.GetHandler(), i);
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
966 }
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
967 }
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
968 else
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
969 {
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
970 job->AddFindAnswer(query.GetHandler(), index);
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
971 }
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
972 }
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
973
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
974 OrthancRestApi::GetApi(call).SubmitCommandsJob
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
975 (call, job.release(), true /* synchronous by default */, body);
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
976 }
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
977
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
978
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
979 static void DocumentRetrieveShared(RestApiPostCall& call)
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
980 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
981 OrthancRestApi::DocumentSubmitCommandsJob(call);
4730
7826ac059c31 Added Short/Simplify/Full options to format "/modalities/{id}/find-worklist" and "/queries/{id}/retrieve"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4729
diff changeset
982 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Short);
7826ac059c31 Added Short/Simplify/Full options to format "/modalities/{id}/find-worklist" and "/queries/{id}/retrieve"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4729
diff changeset
983
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
984 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
985 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
986 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
987 .SetRequestField(KEY_TARGET_AET, RestApiCallDocumentation::Type_String,
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
988 "AET of the target modality. By default, the AET of Orthanc is used, as defined in the "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
989 "`DicomAet` configuration option.", false)
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
990 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
991 "Timeout for the C-MOVE command, in seconds", false)
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
992 .AddRequestType(MimeType_PlainText, "AET of the target modality");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
993 }
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
994
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
995
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
996 static void RetrieveOneAnswer(RestApiPostCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
997 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
998 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
999 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1000 DocumentRetrieveShared(call);
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1001 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1002 .SetSummary("Retrieve one answer")
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1003 .SetDescription("Start a C-MOVE SCU command as a job, in order to retrieve one answer associated with the "
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1004 "query/retrieve operation whose identifiers are provided in the URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
1005 "https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1006 .SetUriArgument("index", "Index of the answer");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1007 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1008 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1009
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1010 size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", ""));
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
1011 SubmitRetrieveJob(call, false, index);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1012 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1013
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1014
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1015 static void RetrieveAllAnswers(RestApiPostCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1016 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1017 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1018 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1019 DocumentRetrieveShared(call);
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1020 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1021 .SetSummary("Retrieve all answers")
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1022 .SetDescription("Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the "
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1023 "query/retrieve operation whose identifier is provided in the URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
1024 "https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move");
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1025 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1026 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1027
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
1028 SubmitRetrieveJob(call, true, 0);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1029 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1030
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1031
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1032 static void GetQueryArguments(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1033 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1034 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1035 {
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
1036 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
1037
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1038 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1039 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1040 .SetSummary("Get original query arguments")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1041 .SetDescription("Get the original DICOM filter associated with the query/retrieve operation "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1042 "whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1043 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1044 .AddAnswerType(MimeType_Json, "Content of the original query");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1045 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1046 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1047
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1048 QueryAccessor query(call);
4697
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4650
diff changeset
1049 AnswerDicomMap(call, query.GetHandler().GetQuery(), OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full));
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1050 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1051
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1052
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1053 static void GetQueryLevel(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1054 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1055 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1056 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1057 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1058 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1059 .SetSummary("Get level of original query")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1060 .SetDescription("Get the query level (value of the `QueryRetrieveLevel` tag) of the query/retrieve operation "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1061 "whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1062 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1063 .AddAnswerType(MimeType_PlainText, "The level");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1064 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1065 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1066
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1067 QueryAccessor query(call);
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
1068 call.GetOutput().AnswerBuffer(EnumerationToString(query.GetHandler().GetLevel()), MimeType_PlainText);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1069 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1070
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1071
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1072 static void GetQueryModality(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1073 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1074 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1075 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1076 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1077 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1078 .SetSummary("Get modality of original query")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1079 .SetDescription("Get the identifier of the DICOM modality that was targeted by the query/retrieve operation "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1080 "whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1081 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1082 .AddAnswerType(MimeType_PlainText, "The identifier of the DICOM modality");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1083 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1084 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1085
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1086 QueryAccessor query(call);
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
1087 call.GetOutput().AnswerBuffer(query.GetHandler().GetModalitySymbolicName(), MimeType_PlainText);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1088 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1089
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1090
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1091 static void DeleteQuery(RestApiDeleteCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1092 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1093 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1094 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1095 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1096 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1097 .SetSummary("Delete a query")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1098 .SetDescription("Delete the query/retrieve operation whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1099 .SetUriArgument("id", "Identifier of the query of interest");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1100 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1101 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1102
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1103 ServerContext& context = OrthancRestApi::GetContext(call);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1104 context.GetQueryRetrieveArchive().Remove(call.GetUriComponent("id", ""));
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
1105 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1106 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1107
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1108
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1109 static void ListQueryOperations(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1110 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1111 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1112 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1113 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1114 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1115 .SetSummary("List operations on a query")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1116 .SetDescription("List the available operations for the query/retrieve operation whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1117 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1118 .AddAnswerType(MimeType_Json, "JSON array containing the list of operations");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1119 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1120 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1121
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1122 // Ensure that the query of interest does exist
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1123 QueryAccessor query(call);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1124
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1125 RestApi::AutoListChildren(call);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1126 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1127
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1128
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1129 static void ListQueryAnswerOperations(RestApiGetCall& call)
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1130 {
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1131 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1132 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1133 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1134 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1135 .SetSummary("List operations on an answer")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1136 .SetDescription("List the available operations on an answer associated with the "
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1137 "query/retrieve operation whose identifier is provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1138 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1139 .SetUriArgument("index", "Index of the answer")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1140 .AddAnswerType(MimeType_Json, "JSON array containing the list of operations");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1141 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1142 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1143
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1144 // Ensure that the query of interest does exist
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1145 QueryAccessor query(call);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1146
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1147 // Ensure that the answer of interest does exist
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1148 size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", ""));
1787
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
1149
1b1d5470233f refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
1150 DicomMap map;
2867
251614c2edac DicomMoveScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2843
diff changeset
1151 query.GetHandler().GetAnswer(map, index);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1152
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1153 Json::Value answer = Json::arrayValue;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1154 answer.append("content");
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1155 answer.append("retrieve");
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1156
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1157 switch (query.GetHandler().GetLevel())
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1158 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1159 case ResourceType_Patient:
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1160 answer.append("query-study");
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1161
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1162 case ResourceType_Study:
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1163 answer.append("query-series");
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1164
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1165 case ResourceType_Series:
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1166 answer.append("query-instances");
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1167 break;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1168
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1169 default:
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1170 break;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1171 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1172
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1173 call.GetOutput().AnswerJson(answer);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1174 }
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1175
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1176
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1177 template <ResourceType CHILDREN_LEVEL>
2986
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1178 static void QueryAnswerChildren(RestApiPostCall& call)
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1179 {
2988
9cc3d40e389b Orthanc 1.4.3 is now known as 1.5.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2986
diff changeset
1180 // New in Orthanc 1.5.0
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1181 assert(CHILDREN_LEVEL == ResourceType_Study ||
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1182 CHILDREN_LEVEL == ResourceType_Series ||
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1183 CHILDREN_LEVEL == ResourceType_Instance);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1184
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1185 if (call.IsDocumentation())
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1186 {
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1187 const std::string resources = GetResourceTypeText(CHILDREN_LEVEL, true /* plural */, false /* lower case */);
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1188 call.GetDocumentation()
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1189 .SetTag("Networking")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1190 .SetSummary("Query the child " + resources + " of an answer")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1191 .SetDescription("Issue a second DICOM C-FIND operation, in order to query the child " + resources +
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1192 " associated with one answer to some query/retrieve operation whose identifiers are provided in the URL")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1193 .SetUriArgument("id", "Identifier of the query of interest")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1194 .SetUriArgument("index", "Index of the answer")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1195 .SetRequestField(KEY_QUERY, RestApiCallDocumentation::Type_JsonObject,
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1196 "Associative array containing the filter on the values of the DICOM tags", true)
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1197 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1198 "Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)", false)
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1199 .SetAnswerField("ID", RestApiCallDocumentation::Type_JsonObject,
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1200 "Identifier of the query, to be used with `/queries/{id}`")
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1201 .SetAnswerField("Path", RestApiCallDocumentation::Type_JsonObject,
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1202 "Root path to the query in the REST API");
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1203 return;
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1204 }
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1205
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1206 ServerContext& context = OrthancRestApi::GetContext(call);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1207
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3691
diff changeset
1208 std::unique_ptr<QueryRetrieveHandler> handler(new QueryRetrieveHandler(context));
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1209
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1210 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1211 const QueryAccessor parent(call);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1212 const ResourceType level = parent.GetHandler().GetLevel();
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1213
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1214 const size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", ""));
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1215
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1216 Json::Value request;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1217
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1218 if (index >= parent.GetHandler().GetAnswersCount())
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1219 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1220 throw OrthancException(ErrorCode_ParameterOutOfRange);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1221 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1222 else if (CHILDREN_LEVEL == ResourceType_Study &&
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1223 level != ResourceType_Patient)
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1224 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1225 throw OrthancException(ErrorCode_UnknownResource);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1226 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1227 else if (CHILDREN_LEVEL == ResourceType_Series &&
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1228 level != ResourceType_Patient &&
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1229 level != ResourceType_Study)
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1230 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1231 throw OrthancException(ErrorCode_UnknownResource);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1232 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1233 else if (CHILDREN_LEVEL == ResourceType_Instance &&
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1234 level != ResourceType_Patient &&
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1235 level != ResourceType_Study &&
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1236 level != ResourceType_Series)
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1237 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1238 throw OrthancException(ErrorCode_UnknownResource);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1239 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1240 else if (!call.ParseJsonRequest(request))
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1241 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1242 throw OrthancException(ErrorCode_BadFileFormat, "Must provide a JSON object");
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1243 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1244 else
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1245 {
3370
872bd3b6ec72 "/modalities/{id}/query": New argument "Normalize"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3345
diff changeset
1246 handler->SetFindNormalized(parent.GetHandler().IsFindNormalized());
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1247 handler->SetModality(parent.GetHandler().GetModalitySymbolicName());
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1248 handler->SetLevel(CHILDREN_LEVEL);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1249
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1250 // New in Orthanc 1.9.1
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1251 if (request.isMember(KEY_TIMEOUT))
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1252 {
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1253 handler->SetTimeout(SerializationToolbox::ReadUnsignedInteger(request, KEY_TIMEOUT));
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1254 }
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1255 else if (parent.GetHandler().HasTimeout())
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1256 {
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1257 handler->SetTimeout(parent.GetHandler().GetTimeout());
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1258 }
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
1259
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1260 if (request.isMember(KEY_QUERY))
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1261 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1262 std::map<DicomTag, std::string> query;
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1263 SerializationToolbox::ReadMapOfTags(query, request, KEY_QUERY);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1264
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1265 for (std::map<DicomTag, std::string>::const_iterator
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1266 it = query.begin(); it != query.end(); ++it)
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1267 {
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1268 handler->SetQuery(it->first, it->second);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1269 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1270 }
2986
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1271
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1272 DicomMap answer;
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1273 parent.GetHandler().GetAnswer(answer, index);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1274
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
1275 // This switch-case mimics "DicomControlUserConnection::Move()"
2986
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1276 switch (parent.GetHandler().GetLevel())
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1277 {
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1278 case ResourceType_Patient:
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1279 handler->CopyStringTag(answer, DICOM_TAG_PATIENT_ID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1280 break;
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1281
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1282 case ResourceType_Study:
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1283 handler->CopyStringTag(answer, DICOM_TAG_STUDY_INSTANCE_UID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1284 break;
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1285
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1286 case ResourceType_Series:
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1287 handler->CopyStringTag(answer, DICOM_TAG_STUDY_INSTANCE_UID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1288 handler->CopyStringTag(answer, DICOM_TAG_SERIES_INSTANCE_UID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1289 break;
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1290
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1291 case ResourceType_Instance:
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1292 handler->CopyStringTag(answer, DICOM_TAG_STUDY_INSTANCE_UID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1293 handler->CopyStringTag(answer, DICOM_TAG_SERIES_INSTANCE_UID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1294 handler->CopyStringTag(answer, DICOM_TAG_SOP_INSTANCE_UID);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1295 break;
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1296
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1297 default:
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1298 throw OrthancException(ErrorCode_InternalError);
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
1299 }
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1300 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1301 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1302
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1303 AnswerQueryHandler(call, handler);
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1304 }
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1305
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1306
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1307
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1308 /***************************************************************************
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1309 * DICOM C-Store SCU
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1310 ***************************************************************************/
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1311
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1312 static void GetInstancesToExport(Json::Value& otherArguments,
2626
e09021ddc00d cleanup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2624
diff changeset
1313 SetOfInstancesJob& job,
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1314 const std::string& remote,
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1315 RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1316 {
1428
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1317 otherArguments = Json::objectValue;
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1318 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1319
1428
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1320 Json::Value request;
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1428
diff changeset
1321 if (Toolbox::IsSHA1(call.GetBodyData(), call.GetBodySize()))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1322 {
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1428
diff changeset
1323 std::string s;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1428
diff changeset
1324 call.BodyToString(s);
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1428
diff changeset
1325
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1326 // This is for compatibility with Orthanc <= 0.5.1.
1428
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1327 request = Json::arrayValue;
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1428
diff changeset
1328 request.append(Toolbox::StripSpaces(s));
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1329 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1330 else if (!call.ParseJsonRequest(request))
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1331 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1332 // Bad JSON request
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1333 throw OrthancException(ErrorCode_BadFileFormat, "Must provide a JSON value");
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1334 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1335
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1336 if (request.isString())
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1337 {
1428
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1338 std::string item = request.asString();
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1339 request = Json::arrayValue;
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1340 request.append(item);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1341 }
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1342 else if (!request.isArray() &&
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1343 !request.isObject())
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1344 {
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1345 throw OrthancException(ErrorCode_BadFileFormat, "Must provide a JSON object, or a JSON array of strings");
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1346 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1347
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1348 const Json::Value* resources;
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1349 if (request.isArray())
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1350 {
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1351 resources = &request;
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1352 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1353 else
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1354 {
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1355 if (request.type() != Json::objectValue ||
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1356 !request.isMember(KEY_RESOURCES))
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1357 {
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1358 throw OrthancException(ErrorCode_BadFileFormat,
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1359 "Missing field in JSON: \"" + std::string(KEY_RESOURCES) + "\"");
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1360 }
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1361
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1362 resources = &request[KEY_RESOURCES];
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1363 if (!resources->isArray())
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1364 {
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1365 throw OrthancException(ErrorCode_BadFileFormat,
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1366 "JSON field \"" + std::string(KEY_RESOURCES) + "\" must contain an array");
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1367 }
1428
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1368
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1369 // Copy the remaining arguments
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1370 Json::Value::Members members = request.getMemberNames();
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1371 for (Json::Value::ArrayIndex i = 0; i < members.size(); i++)
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1372 {
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1373 otherArguments[members[i]] = request[members[i]];
0a355eeeb351 optimization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1427
diff changeset
1374 }
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1375 }
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1376
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1377 bool logExportedResources;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1378
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1379 {
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1380 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1381 logExportedResources = lock.GetConfiguration().GetBooleanParameter("LogExportedResources", false);
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1382 }
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1383
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1384 for (Json::Value::ArrayIndex i = 0; i < resources->size(); i++)
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1385 {
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1386 if (!(*resources) [i].isString())
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1387 {
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1388 throw OrthancException(ErrorCode_BadFileFormat,
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1389 "Resources to be exported must be specified as a JSON array of strings");
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1390 }
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1391
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1392 std::string stripped = Toolbox::StripSpaces((*resources) [i].asString());
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1393 if (!Toolbox::IsSHA1(stripped))
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1394 {
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1395 throw OrthancException(ErrorCode_BadFileFormat,
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1396 "This string is not a valid Orthanc identifier: " + stripped);
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1397 }
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1398
3374
d0d6bd633e4c Reporting of "ParentResources" in "DicomModalityStore" and "DicomModalityStore" jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3370
diff changeset
1399 job.AddParentResource(stripped); // New in Orthanc 1.5.7
d0d6bd633e4c Reporting of "ParentResources" in "DicomModalityStore" and "DicomModalityStore" jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3370
diff changeset
1400
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1401 context.AddChildInstances(job, stripped);
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1402
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1403 if (logExportedResources)
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1404 {
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1405 context.GetIndex().LogExportedResource(stripped, remote);
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1406 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1407 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1408 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1409
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1410
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1411 static void DicomStore(RestApiPostCall& call)
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1412 {
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1413 static const char* KEY_MOVE_ORIGINATOR_AET = "MoveOriginatorAet";
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1414 static const char* KEY_MOVE_ORIGINATOR_ID = "MoveOriginatorID";
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1415 static const char* KEY_STORAGE_COMMITMENT = "StorageCommitment";
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1416
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1417 if (call.IsDocumentation())
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1418 {
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1419 OrthancRestApi::DocumentSubmitCommandsJob(call);
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1420 call.GetDocumentation()
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1421 .SetTag("Networking")
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1422 .SetSummary("Trigger C-STORE SCU")
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1423 .SetDescription("Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally "
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1424 "to some remote DICOM modality whose identifier is provided in the URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
1425 "https://orthanc.uclouvain.be/book/users/rest.html#rest-store-scu")
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1426 .AddRequestType(MimeType_PlainText, "The Orthanc identifier of one resource to be sent")
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1427 .SetRequestField(KEY_RESOURCES, RestApiCallDocumentation::Type_JsonListOfStrings,
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1428 "List of the Orthanc identifiers of all the DICOM resources to be sent", true)
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1429 .SetRequestField(KEY_LOCAL_AET, RestApiCallDocumentation::Type_String,
4463
522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4462
diff changeset
1430 "Local AET that is used for this commands, defaults to `DicomAet` configuration option. "
522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4462
diff changeset
1431 "Ignored if `DicomModalities` already sets `LocalAet` for this modality.", false)
5110
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1432 .SetRequestField(KEY_CALLED_AET, RestApiCallDocumentation::Type_String,
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1433 "Called AET that is used for this commands, defaults to `AET` configuration option. "
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1434 "Allows you to overwrite the destination AET for a specific operation.", false)
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1435 .SetRequestField(KEY_HOST, RestApiCallDocumentation::Type_String,
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1436 "Host that is used for this commands, defaults to `Host` configuration option. "
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1437 "Allows you to overwrite the destination host for a specific operation.", false)
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1438 .SetRequestField(KEY_PORT, RestApiCallDocumentation::Type_Number,
5256
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
1439 "Port that is used for this command, defaults to `Port` configuration option. "
5110
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1440 "Allows you to overwrite the destination port for a specific operation.", false)
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1441 .SetRequestField(KEY_MOVE_ORIGINATOR_AET, RestApiCallDocumentation::Type_String,
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1442 "Move originator AET that is used for this commands, in order to fake a C-MOVE SCU", false)
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1443 .SetRequestField(KEY_MOVE_ORIGINATOR_ID, RestApiCallDocumentation::Type_Number,
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1444 "Move originator ID that is used for this commands, in order to fake a C-MOVE SCU", false)
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1445 .SetRequestField(KEY_STORAGE_COMMITMENT, RestApiCallDocumentation::Type_Boolean,
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1446 "Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
1447 "https://orthanc.uclouvain.be/book/users/storage-commitment.html#chaining-c-store-with-storage-commitment", false)
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1448 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1449 "Timeout for the C-STORE command, in seconds", false)
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1450 .SetUriArgument("id", "Identifier of the modality of interest");
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1451 return;
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1452 }
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1453
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1454 ServerContext& context = OrthancRestApi::GetContext(call);
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1455
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1456 std::string remote = call.GetUriComponent("id", "");
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1457
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1458 Json::Value request;
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3691
diff changeset
1459 std::unique_ptr<DicomModalityStoreJob> job(new DicomModalityStoreJob(context));
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1460
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1461 GetInstancesToExport(request, *job, remote, call);
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1462
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1463 std::string localAet = Toolbox::GetJsonStringField
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1464 (request, KEY_LOCAL_AET, context.GetDefaultLocalApplicationEntityTitle());
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1465 std::string moveOriginatorAET = Toolbox::GetJsonStringField
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1466 (request, KEY_MOVE_ORIGINATOR_AET, context.GetDefaultLocalApplicationEntityTitle());
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1467 int moveOriginatorID = Toolbox::GetJsonIntegerField
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1468 (request, KEY_MOVE_ORIGINATOR_ID, 0 /* By default, not a C-MOVE */);
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1469
5110
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1470 RemoteModalityParameters remoteModality = MyGetModalityUsingSymbolicName(remote);
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1471
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1472 remoteModality.SetApplicationEntityTitle(Toolbox::GetJsonStringField
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1473 (request, KEY_CALLED_AET, remoteModality.GetApplicationEntityTitle()));
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1474 remoteModality.SetHost(Toolbox::GetJsonStringField
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1475 (request, KEY_HOST, remoteModality.GetHost()));
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1476 remoteModality.SetPortNumber(static_cast<uint16_t>(Toolbox::GetJsonUnsignedIntegerField
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1477 (request, KEY_PORT, remoteModality.GetPortNumber())));
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1478
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1479 job->SetLocalAet(localAet);
5110
98da039474b1 /store: allows overriding CalledAet, Host, Port
Alain Mazy <am@osimis.io>
parents: 5025
diff changeset
1480 job->SetRemoteModality(remoteModality);
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1481
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1482 if (moveOriginatorID != 0)
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1483 {
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1484 job->SetMoveOriginator(moveOriginatorAET, moveOriginatorID);
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1485 }
2626
e09021ddc00d cleanup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2624
diff changeset
1486
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
1487 // New in Orthanc 1.6.0
4422
48303e493135 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4421
diff changeset
1488 if (Toolbox::GetJsonBooleanField(request, KEY_STORAGE_COMMITMENT, false))
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
1489 {
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
1490 job->EnableStorageCommitment(true);
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
1491 }
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
1492
3870
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
1493 // New in Orthanc 1.7.0
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1494 if (request.isMember(KEY_TIMEOUT))
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
1495 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1496 job->SetTimeout(SerializationToolbox::ReadUnsignedInteger(request, KEY_TIMEOUT));
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
1497 }
3870
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
1498
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1499 OrthancRestApi::GetApi(call).SubmitCommandsJob
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1500 (call, job.release(), true /* synchronous by default */, request);
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1501 }
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1502
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1503
3808
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1504 static void DicomStoreStraight(RestApiPostCall& call)
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1505 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1506 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1507 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1508 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1509 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1510 .SetSummary("Straight C-STORE SCU")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1511 .SetDescription("Synchronously send the DICOM instance in the POST body to the remote DICOM modality "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1512 "whose identifier is provided in URL, without having to first store it locally within Orthanc. "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1513 "This is an alternative to command-line tools such as `storescu` from DCMTK or dcm4che.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1514 .SetUriArgument("id", "Identifier of the modality of interest")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1515 .AddRequestType(MimeType_Dicom, "DICOM instance to be sent")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1516 .SetAnswerField(SOP_CLASS_UID, RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1517 "SOP class UID of the DICOM instance, if the C-STORE SCU has succeeded")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1518 .SetAnswerField(SOP_INSTANCE_UID, RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1519 "SOP instance UID of the DICOM instance, if the C-STORE SCU has succeeded");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1520 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1521 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1522
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1523 Json::Value body = Json::objectValue; // No body
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1524 DicomStoreUserConnection connection(GetAssociationParameters(call, body));
3808
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1525
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1526 std::string sopClassUid, sopInstanceUid;
3894
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3876
diff changeset
1527 connection.Store(sopClassUid, sopInstanceUid, call.GetBodyData(),
5438
7a20ee948676 Added a new 'Telemis' manufacturer for DicomModalities
Alain Mazy <am@osimis.io>
parents: 5432
diff changeset
1528 call.GetBodySize(),
7a20ee948676 Added a new 'Telemis' manufacturer for DicomModalities
Alain Mazy <am@osimis.io>
parents: 5432
diff changeset
1529 false /* Not a C-MOVE */,
5442
ac68a4383e51 improved C-Store negotiation and logging
Alain Mazy <am@osimis.io>
parents: 5438
diff changeset
1530 "", 0);
3808
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1531
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1532 Json::Value answer = Json::objectValue;
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1533 answer[SOP_CLASS_UID] = sopClassUid;
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1534 answer[SOP_INSTANCE_UID] = sopInstanceUid;
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1535
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1536 call.GetOutput().AnswerJson(answer);
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1537 }
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1538
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
1539
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1540 /***************************************************************************
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1541 * DICOM C-Move SCU
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1542 ***************************************************************************/
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1543
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1544 static void DicomMove(RestApiPostCall& call)
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1545 {
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1546 if (call.IsDocumentation())
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1547 {
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1548 OrthancRestApi::DocumentSubmitCommandsJob(call);
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1549 call.GetDocumentation()
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1550 .SetTag("Networking")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1551 .SetSummary("Trigger C-MOVE SCU")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1552 .SetDescription("Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1553 "C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
1554 "https://orthanc.uclouvain.be/book/users/rest.html#performing-c-move")
5011
c014ab79fca5 fixed /move documentation + improved error reporting
Alain Mazy <am@osimis.io>
parents: 4892
diff changeset
1555 .SetRequestField(KEY_RESOURCES, RestApiCallDocumentation::Type_JsonListOfObjects,
c014ab79fca5 fixed /move documentation + improved error reporting
Alain Mazy <am@osimis.io>
parents: 4892
diff changeset
1556 "List of queries identifying all the DICOM resources to be sent", true)
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1557 .SetRequestField(KEY_LEVEL, RestApiCallDocumentation::Type_String,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1558 "Level of the query (`Patient`, `Study`, `Series` or `Instance`)", true)
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1559 .SetRequestField(KEY_LOCAL_AET, RestApiCallDocumentation::Type_String,
4463
522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4462
diff changeset
1560 "Local AET that is used for this commands, defaults to `DicomAet` configuration option. "
522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4462
diff changeset
1561 "Ignored if `DicomModalities` already sets `LocalAet` for this modality.", false)
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1562 .SetRequestField(KEY_TARGET_AET, RestApiCallDocumentation::Type_String,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1563 "Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1564 "commands, defaults to `DicomAet` configuration option in order to do a simple query/retrieve", false)
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1565 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1566 "Timeout for the C-MOVE command, in seconds", false)
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1567 .SetUriArgument("id", "Identifier of the modality of interest");
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1568 return;
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1569 }
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1570
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1571 ServerContext& context = OrthancRestApi::GetContext(call);
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1572
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1573 Json::Value request;
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1574
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1575 if (!call.ParseJsonRequest(request) ||
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1576 request.type() != Json::objectValue ||
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1577 !request.isMember(KEY_RESOURCES) ||
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1578 !request.isMember(KEY_LEVEL) ||
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1579 request[KEY_RESOURCES].type() != Json::arrayValue ||
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1580 request[KEY_LEVEL].type() != Json::stringValue)
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1581 {
3345
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
1582 throw OrthancException(ErrorCode_BadFileFormat, "Must provide a JSON body containing fields " +
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
1583 std::string(KEY_RESOURCES) + " and " + std::string(KEY_LEVEL));
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1584 }
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1585
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1586 ResourceType level = StringToResourceType(request[KEY_LEVEL].asCString());
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1587
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1588 std::string localAet = Toolbox::GetJsonStringField
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1589 (request, KEY_LOCAL_AET, context.GetDefaultLocalApplicationEntityTitle());
2584
38b5045f2bff refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2583
diff changeset
1590 std::string targetAet = Toolbox::GetJsonStringField
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
1591 (request, KEY_TARGET_AET, context.GetDefaultLocalApplicationEntityTitle());
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1592
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
1593 const RemoteModalityParameters source =
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1594 MyGetModalityUsingSymbolicName(call.GetUriComponent("id", ""));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
1595
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1596 std::unique_ptr<DicomMoveScuJob> job(new DicomMoveScuJob(context));
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3874
diff changeset
1597
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1598 job->SetQueryFormat(DicomToJsonFormat_Short);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1599
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1600 // QueryAccessor query(call);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1601 job->SetTargetAet(targetAet);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1602 job->SetLocalAet(localAet);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1603 job->SetRemoteModality(source);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1604
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1605 if (request.isMember(KEY_TIMEOUT))
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1606 {
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1607 job->SetTimeout(SerializationToolbox::ReadUnsignedInteger(request, KEY_TIMEOUT));
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1608 }
3870
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3863
diff changeset
1609
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
1610 for (Json::Value::ArrayIndex i = 0; i < request[KEY_RESOURCES].size(); i++)
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1611 {
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1612 DicomMap resource;
5011
c014ab79fca5 fixed /move documentation + improved error reporting
Alain Mazy <am@osimis.io>
parents: 4892
diff changeset
1613 FromDcmtkBridge::FromJson(resource, request[KEY_RESOURCES][i], "Resources elements");
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1614
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1615 resource.SetValue(DICOM_TAG_QUERY_RETRIEVE_LEVEL, std::string(ResourceTypeToDicomQueryRetrieveLevel(level)), false);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1616
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1617 job->AddQuery(resource);
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1618 }
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1619
5025
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1620 OrthancRestApi::GetApi(call).SubmitCommandsJob
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1621 (call, job.release(), true /* synchronous by default */, request);
afa427f65444 Added an Asynchronous mode to /modalities/../move
Alain Mazy <am@osimis.io>
parents: 5011
diff changeset
1622 return;
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1623 }
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1624
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1625
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1626
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
1627 /***************************************************************************
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1628 * Orthanc Peers => Store client
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
1629 ***************************************************************************/
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1630
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1631 static bool IsExistingPeer(const OrthancRestApi::SetOfStrings& peers,
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1632 const std::string& id)
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1633 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1634 return peers.find(id) != peers.end();
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1635 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1636
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1637 static void ListPeers(RestApiGetCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1638 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1639 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1640 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1641 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1642 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1643 .SetSummary("List Orthanc peers")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1644 .SetDescription("List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1645 "`OrthancPeers` configuration option, or to the information stored in the database if "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1646 "`OrthancPeersInDatabase` is `true`.")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1647 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1648 "If present, retrieve detailed information about the individual Orthanc peers", false)
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1649 .AddAnswerType(MimeType_Json, "JSON array containing either the identifiers of the peers, or detailed information "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1650 "about the peers (if `expand` argument is provided)");
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1651 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1652 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1653
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1654 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1655
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1656 OrthancRestApi::SetOfStrings peers;
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1657 lock.GetConfiguration().GetListOfOrthancPeers(peers);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1658
5405
62bb63346185 All 'expand' GET arguments now accepts expand=true and expand=false values + /studies/../instances now supports expand=false
Alain Mazy <am@osimis.io>
parents: 5256
diff changeset
1659 if (call.HasArgument("expand") && call.GetBooleanArgument("expand", true))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1660 {
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1661 Json::Value result = Json::objectValue;
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1662 for (OrthancRestApi::SetOfStrings::const_iterator
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1663 it = peers.begin(); it != peers.end(); ++it)
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1664 {
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1665 WebServiceParameters peer;
2799
6e3a60b85da6 New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2685
diff changeset
1666
2944
f395460af74d simplifying OrthancConfiguration for modalities/peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2940
diff changeset
1667 if (lock.GetConfiguration().LookupOrthancPeer(peer, *it))
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1668 {
3192
595bfee4391a URI "/peers?expand" provides more information
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3167
diff changeset
1669 Json::Value info;
595bfee4391a URI "/peers?expand" provides more information
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3167
diff changeset
1670 peer.FormatPublic(info);
595bfee4391a URI "/peers?expand" provides more information
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3167
diff changeset
1671 result[*it] = info;
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1672 }
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1673 }
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1674 call.GetOutput().AnswerJson(result);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1675 }
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1676 else // if expand is not present, keep backward compatibility and return an array of peers
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1677 {
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1678 Json::Value result = Json::arrayValue;
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1679 for (OrthancRestApi::SetOfStrings::const_iterator
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1680 it = peers.begin(); it != peers.end(); ++it)
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1681 {
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1682 result.append(*it);
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1683 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1684
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1685 call.GetOutput().AnswerJson(result);
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1686 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1687 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1688
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1689 static void ListPeerOperations(RestApiGetCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1690 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1691 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1692 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1693 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1694 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1695 .SetSummary("List operations on peer")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1696 .SetDescription("List the operations that are available for an Orthanc peer.")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1697 .SetUriArgument("id", "Identifier of the peer of interest")
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1698 .AddAnswerType(MimeType_Json, "List of the available operations");
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1699 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1700 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1701
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1702 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1703
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1704 OrthancRestApi::SetOfStrings peers;
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1705 lock.GetConfiguration().GetListOfOrthancPeers(peers);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1706
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1707 std::string id = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1708 if (IsExistingPeer(peers, id))
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1709 {
1063
0332e6e8c679 Fix automated generation of the list of resource children in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1049
diff changeset
1710 RestApi::AutoListChildren(call);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1711 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1712 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1713
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1714 static void PeerStore(RestApiPostCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1715 {
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1716 static const char* KEY_TRANSCODE = "Transcode";
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1717 static const char* KEY_COMPRESS = "Compress";
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1718
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1719 if (call.IsDocumentation())
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1720 {
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1721 OrthancRestApi::DocumentSubmitCommandsJob(call);
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1722 call.GetDocumentation()
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1723 .SetTag("Networking")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1724 .SetSummary("Send to Orthanc peer")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1725 .SetDescription("Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
1726 "https://orthanc.uclouvain.be/book/users/rest.html#sending-one-resource")
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1727 .AddRequestType(MimeType_PlainText, "The Orthanc identifier of one resource to be sent")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1728 .SetRequestField(KEY_RESOURCES, RestApiCallDocumentation::Type_JsonListOfStrings,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1729 "List of the Orthanc identifiers of all the DICOM resources to be sent", true)
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1730 .SetRequestField(KEY_TRANSCODE, RestApiCallDocumentation::Type_String,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1731 "Transcode to the provided DICOM transfer syntax before the actual sending", false)
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1732 .SetRequestField(KEY_COMPRESS, RestApiCallDocumentation::Type_Boolean,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1733 "Whether to compress the DICOM instances using gzip before the actual sending", false)
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1734 .SetUriArgument("id", "Identifier of the modality of interest");
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1735 return;
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1736 }
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1737
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1738 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1739
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1740 std::string remote = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1741
1427
d710ea64f0fd Custom setting of the local AET during C-Store SCU (both in Lua and in the REST API)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368
diff changeset
1742 Json::Value request;
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3691
diff changeset
1743 std::unique_ptr<OrthancPeerStoreJob> job(new OrthancPeerStoreJob(context));
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1744
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1745 GetInstancesToExport(request, *job, remote, call);
3950
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1746
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1747 if (request.type() == Json::objectValue &&
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1748 request.isMember(KEY_TRANSCODE))
3950
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1749 {
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1750 job->SetTranscode(SerializationToolbox::ReadString(request, KEY_TRANSCODE));
3950
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1751 }
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
1752
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
1753 if (request.type() == Json::objectValue &&
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1754 request.isMember(KEY_COMPRESS))
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
1755 {
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
1756 job->SetCompress(SerializationToolbox::ReadBoolean(request, KEY_COMPRESS));
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
1757 }
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1758
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1759 {
3950
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1760 OrthancConfiguration::ReaderLock lock;
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1761
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1762 WebServiceParameters peer;
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1763 if (lock.GetConfiguration().LookupOrthancPeer(peer, remote))
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1764 {
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1765 job->SetPeer(peer);
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1766 }
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1767 else
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1768 {
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1769 throw OrthancException(ErrorCode_UnknownResource,
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1770 "No peer with symbolic name: " + remote);
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1771 }
3167
860aed8258c3 Fix issue #73 (/modalities/{modalityId}/store raises 500 errors instead of 404)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3097
diff changeset
1772 }
3950
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1773
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1774 OrthancRestApi::GetApi(call).SubmitCommandsJob
5797ca4f3b8d "/peers/{id}/store": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3894
diff changeset
1775 (call, job.release(), true /* synchronous by default */, request);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1776 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1777
3592
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1778 static void PeerSystem(RestApiGetCall& call)
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1779 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1780 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1781 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1782 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1783 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1784 .SetSummary("Get peer system information")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1785 .SetDescription("Get system information about some Orthanc peer. This corresponds to doing a `GET` request "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1786 "against the `/system` URI of the remote peer. This route can be used to test connectivity.")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1787 .SetUriArgument("id", "Identifier of the peer of interest")
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1788 .AddAnswerType(MimeType_Json, "System information about the peer");
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1789 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1790 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1791
3592
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1792 std::string remote = call.GetUriComponent("id", "");
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1793
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1794 OrthancConfiguration::ReaderLock lock;
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1795
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1796 WebServiceParameters peer;
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1797 if (lock.GetConfiguration().LookupOrthancPeer(peer, remote))
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1798 {
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1799 HttpClient client(peer, "system");
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1800 std::string answer;
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1801
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1802 client.SetMethod(HttpMethod_Get);
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1803
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1804 if (!client.Apply(answer))
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1805 {
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1806 LOG(ERROR) << "Unable to get the system info from remote Orthanc peer: " << peer.GetUrl();
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1807 call.GetOutput().SignalError(client.GetLastStatus());
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1808 return;
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1809 }
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1810
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1811 call.GetOutput().AnswerBuffer(answer, MimeType_Json);
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1812 }
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1813 else
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1814 {
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1815 throw OrthancException(ErrorCode_UnknownResource,
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1816 "No peer with symbolic name: " + remote);
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1817 }
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
1818 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1819
4338
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1820 static void GetPeerConfiguration(RestApiGetCall& call)
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1821 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1822 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1823 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1824 Json::Value sample;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1825 sample["HttpHeaders"] = Json::objectValue;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1826 sample["Password"] = Json::nullValue;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1827 sample["Pkcs11"] = false;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1828 sample["Url"] = "http://127.0.1.1:5000/";
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1829 sample["Username"] = "alice";
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1830 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1831 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1832 .SetSummary("Get peer configuration")
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1833 .SetDescription("Get detailed information about the configuration of some Orthanc peer")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1834 .SetUriArgument("id", "Identifier of the peer of interest")
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1835 .AddAnswerType(MimeType_Json, "Configuration of the peer")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1836 .SetSample(sample);
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1837 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1838 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1839
4338
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1840 OrthancConfiguration::ReaderLock lock;
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1841 const std::string peer = call.GetUriComponent("id", "");
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1842
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1843 WebServiceParameters info;
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1844 if (lock.GetConfiguration().LookupOrthancPeer(info, peer))
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1845 {
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1846 Json::Value answer;
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1847 info.FormatPublic(answer);
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1848 call.GetOutput().AnswerJson(answer);
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1849 }
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1850 else
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1851 {
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1852 throw OrthancException(ErrorCode_UnknownResource,
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1853 "No peer with symbolic name: " + peer);
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1854 }
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1855 }
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
1856
4524
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1857 static void PeerStoreStraight(RestApiPostCall& call)
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1858 {
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1859 if (call.IsDocumentation())
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1860 {
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1861 call.GetDocumentation()
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1862 .SetTag("Networking")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1863 .SetSummary("Straight store to peer")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1864 .SetDescription("Synchronously send the DICOM instance in the POST body to the Orthanc peer "
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1865 "whose identifier is provided in URL, without having to first store it locally within Orthanc. "
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1866 "This is an alternative to command-line tools such as `curl`.")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1867 .SetUriArgument("id", "Identifier of the modality of interest")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1868 .AddRequestType(MimeType_Dicom, "DICOM instance to be sent")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1869 .SetAnswerField("ID", RestApiCallDocumentation::Type_String,
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1870 "Orthanc identifier of the DICOM instance in the remote Orthanc peer")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1871 .SetAnswerField("ParentPatient", RestApiCallDocumentation::Type_String,
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1872 "Orthanc identifier of the parent patient in the remote Orthanc peer")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1873 .SetAnswerField("ParentStudy", RestApiCallDocumentation::Type_String,
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1874 "Orthanc identifier of the parent study in the remote Orthanc peer")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1875 .SetAnswerField("ParentSeries", RestApiCallDocumentation::Type_String,
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1876 "Orthanc identifier of the parent series in the remote Orthanc peer")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1877 .SetAnswerField("Path", RestApiCallDocumentation::Type_String,
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1878 "Path to the DICOM instance in the remote Orthanc server")
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1879 .SetAnswerField("Status", RestApiCallDocumentation::Type_String,
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1880 "Status of the store operation");
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1881 return;
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1882 }
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1883
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1884 const std::string peer = call.GetUriComponent("id", "");
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1885
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1886 WebServiceParameters info;
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1887
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1888 {
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1889 OrthancConfiguration::ReaderLock lock;
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1890 if (!lock.GetConfiguration().LookupOrthancPeer(info, peer))
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1891 {
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1892 throw OrthancException(ErrorCode_UnknownResource, "No peer with symbolic name: " + peer);
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1893 }
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1894 }
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1895
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1896 HttpClient client(info, "instances");
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1897 client.SetMethod(HttpMethod_Post);
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1898 client.AddHeader("Expect", "");
4650
9804d6490872 Reduced memory consumption of HTTP/REST plugins calls on POST/PUT if chunked transfer is disabled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4524
diff changeset
1899 client.SetExternalBody(call.GetBodyData(), call.GetBodySize());
4524
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1900
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1901 Json::Value answer;
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1902 if (client.Apply(answer))
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1903 {
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1904 call.GetOutput().AnswerJson(answer);
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1905 }
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1906 else
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1907 {
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1908 throw OrthancException(ErrorCode_NetworkProtocol, "Cannot send DICOM to remote peer: " + peer);
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1909 }
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1910 }
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1911
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
1912
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1913 // DICOM bridge -------------------------------------------------------------
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1914
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1915 static bool IsExistingModality(const OrthancRestApi::SetOfStrings& modalities,
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1916 const std::string& id)
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1917 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1918 return modalities.find(id) != modalities.end();
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1919 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1920
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1921 static void ListModalities(RestApiGetCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1922 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1923 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1924 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1925 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1926 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1927 .SetSummary("List DICOM modalities")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1928 .SetDescription("List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1929 "`DicomModalities` configuration option, or to the information stored in the database if "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1930 "`DicomModalitiesInDatabase` is `true`.")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1931 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1932 "If present, retrieve detailed information about the individual DICOM modalities", false)
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1933 .AddAnswerType(MimeType_Json, "JSON array containing either the identifiers of the modalities, or detailed information "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1934 "about the modalities (if `expand` argument is provided)");
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1935 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1936 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1937
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1938 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1939
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1940 OrthancRestApi::SetOfStrings modalities;
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1941 lock.GetConfiguration().GetListOfDicomModalities(modalities);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1942
5405
62bb63346185 All 'expand' GET arguments now accepts expand=true and expand=false values + /studies/../instances now supports expand=false
Alain Mazy <am@osimis.io>
parents: 5256
diff changeset
1943 if (call.HasArgument("expand") && call.GetBooleanArgument("expand", true))
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1944 {
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1945 Json::Value result = Json::objectValue;
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1946 for (OrthancRestApi::SetOfStrings::const_iterator
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1947 it = modalities.begin(); it != modalities.end(); ++it)
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1948 {
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1949 const RemoteModalityParameters& remote = lock.GetConfiguration().GetModalityUsingSymbolicName(*it);
2871
6eebc2eb3168 refactoring serialization of RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2868
diff changeset
1950
6eebc2eb3168 refactoring serialization of RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2868
diff changeset
1951 Json::Value info;
6eebc2eb3168 refactoring serialization of RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2868
diff changeset
1952 remote.Serialize(info, true /* force advanced format */);
6eebc2eb3168 refactoring serialization of RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2868
diff changeset
1953 result[*it] = info;
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1954 }
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1955 call.GetOutput().AnswerJson(result);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1956 }
2441
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1957 else // if expand is not present, keep backward compatibility and return an array of modalities ids
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1958 {
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1959 Json::Value result = Json::arrayValue;
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1960 for (OrthancRestApi::SetOfStrings::const_iterator
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1961 it = modalities.begin(); it != modalities.end(); ++it)
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1962 {
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1963 result.append(*it);
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1964 }
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1965 call.GetOutput().AnswerJson(result);
67c01a6f151e added ?expand argument to /peers and /modalities routes
amazy
parents: 2382
diff changeset
1966 }
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1967 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1968
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1969
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1970 static void ListModalityOperations(RestApiGetCall& call)
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1971 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1972 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1973 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1974 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1975 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1976 .SetSummary("List operations on modality")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1977 .SetDescription("List the operations that are available for a DICOM modality.")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
1978 .SetUriArgument("id", "Identifier of the DICOM modality of interest")
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1979 .AddAnswerType(MimeType_Json, "List of the available operations");
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1980 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1981 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
1982
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1983 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1984
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1985 OrthancRestApi::SetOfStrings modalities;
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
1986 lock.GetConfiguration().GetListOfDicomModalities(modalities);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1987
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1988 std::string id = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1989 if (IsExistingModality(modalities, id))
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1990 {
1063
0332e6e8c679 Fix automated generation of the list of resource children in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1049
diff changeset
1991 RestApi::AutoListChildren(call);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1992 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1993 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1994
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1995
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
1996 static void UpdateModality(RestApiPutCall& call)
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
1997 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1998 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
1999 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2000 DocumentModalityParametersShared(call, true);
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2001 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2002 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2003 .SetSummary("Update DICOM modality")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2004 .SetDescription("Define a new DICOM modality, or update an existing one. This change is permanent iff. "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2005 "`DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2006 .SetUriArgument("id", "Identifier of the new/updated DICOM modality");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2007 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2008 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2009
2801
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2010 ServerContext& context = OrthancRestApi::GetContext(call);
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2011
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2012 Json::Value json;
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
2013 if (call.ParseJsonRequest(json))
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2014 {
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2015 RemoteModalityParameters modality;
2871
6eebc2eb3168 refactoring serialization of RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2868
diff changeset
2016 modality.Unserialize(json);
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2017
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2018 {
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2019 OrthancConfiguration::WriterLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2020 lock.GetConfiguration().UpdateModality(call.GetUriComponent("id", ""), modality);
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2021 }
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2022
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2023 context.SignalUpdatedModalities();
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2024
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
2025 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2026 }
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
2027 else
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
2028 {
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
2029 throw OrthancException(ErrorCode_BadFileFormat);
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
2030 }
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2031 }
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2032
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2033
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
2034 static void DeleteModality(RestApiDeleteCall& call)
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2035 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2036 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2037 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2038 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2039 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2040 .SetSummary("Delete DICOM modality")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2041 .SetDescription("Delete one DICOM modality. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2042 "otherwise it is lost at the next restart of Orthanc.")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
2043 .SetUriArgument("id", "Identifier of the DICOM modality of interest");
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2044 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2045 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2046
2801
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2047 ServerContext& context = OrthancRestApi::GetContext(call);
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2048
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2049 {
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2050 OrthancConfiguration::WriterLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2051 lock.GetConfiguration().RemoveModality(call.GetUriComponent("id", ""));
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2052 }
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2053
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2054 context.SignalUpdatedModalities();
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2055
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
2056 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2057 }
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2058
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2059
4338
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2060 static void GetModalityConfiguration(RestApiGetCall& call)
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2061 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2062 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2063 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2064 Json::Value sample;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2065 sample["AET"] = "ORTHANCTEST";
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2066 sample["AllowEcho"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2067 sample["AllowEventReport"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2068 sample["AllowFind"] = true;
4888
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
2069 sample["AllowFindWorklist"] = true;
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2070 sample["AllowGet"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2071 sample["AllowMove"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2072 sample["AllowNAction"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2073 sample["AllowStore"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2074 sample["AllowTranscoding"] = true;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2075 sample["Host"] = "127.0.1.1";
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2076 sample["Manufacturer"] = "Generic";
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2077 sample["Port"] = 5001;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2078 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2079 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2080 .SetSummary("Get modality configuration")
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2081 .SetDescription("Get detailed information about the configuration of some DICOM modality")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
2082 .SetUriArgument("id", "Identifier of the modality of interest")
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2083 .AddAnswerType(MimeType_Json, "Configuration of the modality")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2084 .SetSample(sample);
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2085 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2086 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2087
4338
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2088 const std::string modality = call.GetUriComponent("id", "");
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2089
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2090 Json::Value answer;
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2091
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2092 {
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2093 OrthancConfiguration::ReaderLock lock;
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2094 lock.GetConfiguration().GetModalityUsingSymbolicName(modality).Serialize(answer, true /* force advanced format */);
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2095 }
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2096
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2097 call.GetOutput().AnswerJson(answer);
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2098 }
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2099
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2100
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
2101 static void UpdatePeer(RestApiPutCall& call)
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2102 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2103 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2104 {
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2105 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2106 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2107 .SetSummary("Update Orthanc peer")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2108 .SetDescription("Define a new Orthanc peer, or update an existing one. This change is permanent iff. "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2109 "`OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2110 .SetUriArgument("id", "Identifier of the new/updated Orthanc peer")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2111 .SetRequestField("URL", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2112 "URL of the root of the REST API of the remote Orthanc peer, for instance `http://localhost:8042/`", true)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2113 .SetRequestField("Username", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2114 "Username for the credentials", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2115 .SetRequestField("Password", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2116 "Password for the credentials", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2117 .SetRequestField("CertificateFile", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2118 "SSL certificate for the HTTPS connections", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2119 .SetRequestField("CertificateKeyFile", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2120 "Key file for the SSL certificate for the HTTPS connections", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2121 .SetRequestField("CertificateKeyPassword", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2122 "Key password for the SSL certificate for the HTTPS connections", false)
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2123 .SetRequestField("HttpHeaders", RestApiCallDocumentation::Type_JsonObject,
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2124 "HTTP headers to be used for the connections to the remote peer", false);
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2125 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2126 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2127
2801
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2128 ServerContext& context = OrthancRestApi::GetContext(call);
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2129
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2130 Json::Value json;
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3374
diff changeset
2131 if (call.ParseJsonRequest(json))
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2132 {
2020
a0bd8cd55da7 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2007
diff changeset
2133 WebServiceParameters peer;
2800
dc7330089736 "OrthancPeers" configuration option now allows to specify HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2799
diff changeset
2134 peer.Unserialize(json);
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2135
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2136 {
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2137 OrthancConfiguration::WriterLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2138 lock.GetConfiguration().UpdatePeer(call.GetUriComponent("id", ""), peer);
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2139 }
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2140
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2141 context.SignalUpdatedPeers();
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2142
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
2143 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2144 }
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2145 }
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2146
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2147
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 831
diff changeset
2148 static void DeletePeer(RestApiDeleteCall& call)
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2149 {
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2150 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2151 {
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2152 call.GetDocumentation()
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2153 .SetTag("Networking")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2154 .SetSummary("Delete Orthanc peer")
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2155 .SetDescription("Delete one Orthanc peer. This change is permanent iff. `OrthancPeersInDatabase` is `true`, "
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2156 "otherwise it is lost at the next restart of Orthanc.")
4419
cd96c807ca3d cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4418
diff changeset
2157 .SetUriArgument("id", "Identifier of the Orthanc peer of interest");
4418
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2158 return;
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2159 }
9d6fa3da8f00 cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4367
diff changeset
2160
2801
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2161 ServerContext& context = OrthancRestApi::GetContext(call);
3ee82c7313e7 New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
2162
2940
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2163 {
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2164 OrthancConfiguration::WriterLock lock;
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2165 lock.GetConfiguration().RemovePeer(call.GetUriComponent("id", ""));
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2166 }
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2167
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2168 context.SignalUpdatedPeers();
4767d36679ed refactoring access to Orthanc configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2908
diff changeset
2169
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2905
diff changeset
2170 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2171 }
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2172
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2173
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2174 static void DicomFindWorklist(RestApiPostCall& call)
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2175 {
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2176 if (call.IsDocumentation())
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2177 {
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2178 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2179
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2180 call.GetDocumentation()
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2181 .SetTag("Networking")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2182 .SetSummary("C-FIND SCU for worklist")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2183 .SetDescription("Trigger C-FIND SCU command against the remote worklists of the DICOM modality "
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2184 "whose identifier is provided in URL")
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2185 .SetUriArgument("id", "Identifier of the modality of interest")
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2186 .SetRequestField(KEY_QUERY, RestApiCallDocumentation::Type_JsonObject,
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2187 "Associative array containing the filter on the values of the DICOM tags", true)
4421
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2188 .AddAnswerType(MimeType_Json, "JSON array describing the DICOM tags of the matching worklists");
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2189 return;
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2190 }
a7d72378e1cb cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4419
diff changeset
2191
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2192 Json::Value json;
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2193 if (call.ParseJsonRequest(json))
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2194 {
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2195 std::unique_ptr<ParsedDicomFile> query;
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2196 DicomToJsonFormat format;
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2197
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2198 if (json.isMember(KEY_QUERY))
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2199 {
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2200 // New in Orthanc 1.9.5
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2201 query.reset(ParsedDicomFile::CreateFromJson(json[KEY_QUERY], static_cast<DicomFromJsonFlags>(0),
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2202 "" /* no private creator */));
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2203 format = OrthancRestApi::GetDicomFormat(json, DicomToJsonFormat_Human);
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2204 }
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2205 else
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2206 {
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2207 // Compatibility with Orthanc <= 1.9.4
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2208 query.reset(ParsedDicomFile::CreateFromJson(json, static_cast<DicomFromJsonFlags>(0),
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2209 "" /* no private creator */));
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2210 format = DicomToJsonFormat_Human;
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2211 }
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2212
2059
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2020
diff changeset
2213 DicomFindAnswers answers(true);
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2214
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2215 {
3876
92ecaf877baf improved code reuse in OrthancRestModalities, added missing timeout params
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
2216 DicomControlUserConnection connection(GetAssociationParameters(call, json));
2589
a3fdfb6979ed getting rid of ReusableDicomConnection in REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2587
diff changeset
2217 connection.FindWorklist(answers, *query);
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2218 }
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2219
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2220 Json::Value result;
4729
4e2247df6327 Added "Short" and "Full" options in /modalities/id/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4718
diff changeset
2221 answers.ToJson(result, format);
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2222 call.GetOutput().AnswerJson(result);
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2223 }
3345
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
2224 else
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
2225 {
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
2226 throw OrthancException(ErrorCode_BadFileFormat, "Must provide a JSON object");
f687e11aeb13 more explicit HTTP errors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3192
diff changeset
2227 }
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2228 }
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2229
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2230
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2231 // Storage commitment SCU ---------------------------------------------------
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2232
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2233 static void StorageCommitmentScu(RestApiPostCall& call)
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2234 {
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2235 static const char* const ORTHANC_RESOURCES = "Resources";
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2236 static const char* const DICOM_INSTANCES = "DicomInstances";
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2237
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2238 if (call.IsDocumentation())
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2239 {
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2240 call.GetDocumentation()
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2241 .SetTag("Networking")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2242 .SetSummary("Trigger storage commitment request")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2243 .SetDescription("Trigger a storage commitment request to some remote DICOM modality whose identifier is provided "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
2244 "in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu")
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2245 .SetRequestField(ORTHANC_RESOURCES, RestApiCallDocumentation::Type_JsonListOfStrings,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2246 "List of the Orthanc identifiers of the DICOM resources to be checked by storage commitment", true)
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2247 .SetRequestField(DICOM_INSTANCES, RestApiCallDocumentation::Type_JsonListOfObjects,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2248 "List of DICOM resources that are not necessarily stored within Orthanc, but that must "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2249 "be checked by storage commitment. This is a list of JSON objects that must contain the "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2250 "`SOPClassUID` and `SOPInstanceUID` fields.", true)
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
2251 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
2252 "Timeout for the storage commitment command (new in Orthanc 1.9.1)", false)
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2253 .SetAnswerField("ID", RestApiCallDocumentation::Type_JsonObject,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2254 "Identifier of the storage commitment report, to be used with `/storage-commitment/{id}`")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2255 .SetAnswerField("Path", RestApiCallDocumentation::Type_JsonObject,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2256 "Root path to the storage commitment report in the REST API")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2257 .SetUriArgument("id", "Identifier of the modality of interest");
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2258 return;
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2259 }
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2260
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2261 ServerContext& context = OrthancRestApi::GetContext(call);
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2262
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2263 Json::Value json;
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2264 if (!call.ParseJsonRequest(json) ||
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2265 json.type() != Json::objectValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2266 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2267 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2268 "Must provide a JSON object with a list of resources");
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2269 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2270 else if (!json.isMember(ORTHANC_RESOURCES) &&
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2271 !json.isMember(DICOM_INSTANCES))
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2272 {
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2273 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2274 "Empty storage commitment request, one of these fields is mandatory: \"" +
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2275 std::string(ORTHANC_RESOURCES) + "\" or \"" + std::string(DICOM_INSTANCES) + "\"");
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2276 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2277 else
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2278 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2279 std::list<std::string> sopClassUids, sopInstanceUids;
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2280
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2281 if (json.isMember(ORTHANC_RESOURCES))
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2282 {
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2283 const Json::Value& resources = json[ORTHANC_RESOURCES];
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2284
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2285 if (resources.type() != Json::arrayValue)
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2286 {
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2287 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2288 "The \"" + std::string(ORTHANC_RESOURCES) +
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2289 "\" field must provide an array of Orthanc resources");
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2290 }
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2291 else
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2292 {
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2293 for (Json::Value::ArrayIndex i = 0; i < resources.size(); i++)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2294 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2295 if (resources[i].type() != Json::stringValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2296 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2297 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2298 "The \"" + std::string(ORTHANC_RESOURCES) +
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2299 "\" field must provide an array of strings, found: " + resources[i].toStyledString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2300 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2301
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2302 std::list<std::string> instances;
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2303 context.GetIndex().GetChildInstances(instances, resources[i].asString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2304
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2305 for (std::list<std::string>::const_iterator
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2306 it = instances.begin(); it != instances.end(); ++it)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2307 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2308 std::string sopClassUid, sopInstanceUid;
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2309 DicomMap tags;
4460
6831de40acd9 New metadata automatically computed at the series level: "RemoteAET"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4438
diff changeset
2310 if (context.LookupOrReconstructMetadata(sopClassUid, *it, ResourceType_Instance, MetadataType_Instance_SopClassUid) &&
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2311 context.GetIndex().GetAllMainDicomTags(tags, *it) &&
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2312 tags.LookupStringValue(sopInstanceUid, DICOM_TAG_SOP_INSTANCE_UID, false))
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2313 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2314 sopClassUids.push_back(sopClassUid);
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2315 sopInstanceUids.push_back(sopInstanceUid);
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2316 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2317 else
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2318 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2319 throw OrthancException(ErrorCode_InternalError,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2320 "Cannot retrieve SOP Class/Instance UID of Orthanc instance: " + *it);
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2321 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2322 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2323 }
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2324 }
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2325 }
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2326
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2327 if (json.isMember(DICOM_INSTANCES))
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2328 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2329 const Json::Value& instances = json[DICOM_INSTANCES];
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2330
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2331 if (instances.type() != Json::arrayValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2332 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2333 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2334 "The \"" + std::string(DICOM_INSTANCES) +
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2335 "\" field must provide an array of DICOM instances");
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2336 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2337 else
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2338 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2339 for (Json::Value::ArrayIndex i = 0; i < instances.size(); i++)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2340 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2341 if (instances[i].type() == Json::arrayValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2342 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2343 if (instances[i].size() != 2 ||
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2344 instances[i][0].type() != Json::stringValue ||
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2345 instances[i][1].type() != Json::stringValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2346 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2347 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2348 "An instance entry must provide an array with 2 strings: "
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2349 "SOP Class UID and SOP Instance UID");
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2350 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2351 else
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2352 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2353 sopClassUids.push_back(instances[i][0].asString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2354 sopInstanceUids.push_back(instances[i][1].asString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2355 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2356 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2357 else if (instances[i].type() == Json::objectValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2358 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2359 if (!instances[i].isMember(SOP_CLASS_UID) ||
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2360 !instances[i].isMember(SOP_INSTANCE_UID) ||
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2361 instances[i][SOP_CLASS_UID].type() != Json::stringValue ||
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2362 instances[i][SOP_INSTANCE_UID].type() != Json::stringValue)
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2363 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2364 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2365 "An instance entry must provide an object with 2 string fiels: "
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2366 "\"" + std::string(SOP_CLASS_UID) + "\" and \"" +
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2367 std::string(SOP_INSTANCE_UID));
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2368 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2369 else
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2370 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2371 sopClassUids.push_back(instances[i][SOP_CLASS_UID].asString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2372 sopInstanceUids.push_back(instances[i][SOP_INSTANCE_UID].asString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2373 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2374 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2375 else
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2376 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2377 throw OrthancException(ErrorCode_BadFileFormat,
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2378 "JSON array or object is expected to specify one "
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2379 "instance to be queried, found: " + instances[i].toStyledString());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2380 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2381 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2382 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2383 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2384
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2385 if (sopClassUids.size() != sopInstanceUids.size())
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2386 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2387 throw OrthancException(ErrorCode_InternalError);
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2388 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2389
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2390 const std::string transactionUid = Toolbox::GenerateDicomPrivateUniqueIdentifier();
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2391
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2392 if (sopClassUids.empty())
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2393 {
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2394 LOG(WARNING) << "Issuing an outgoing storage commitment request that is empty: " << transactionUid;
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2395 }
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2396
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2397 {
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2398 const RemoteModalityParameters remote =
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2399 MyGetModalityUsingSymbolicName(call.GetUriComponent("id", ""));
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2400
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2401 const std::string& remoteAet = remote.GetApplicationEntityTitle();
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2402 const std::string& localAet = context.GetDefaultLocalApplicationEntityTitle();
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2403
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2404 // Create a "pending" storage commitment report BEFORE the
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2405 // actual SCU call in order to avoid race conditions
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2406 context.GetStorageCommitmentReports().Store(
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2407 transactionUid, new StorageCommitmentReports::Report(remoteAet));
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2408
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
2409 DicomAssociationParameters parameters(localAet, remote);
4517
c494ee5d0101 Added "Timeout" parameter everywhere in "/modalities/.../"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
2410 InjectAssociationTimeout(parameters, json);
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
2411
3740
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2412 std::vector<std::string> a(sopClassUids.begin(), sopClassUids.end());
e69c556f1913 storage commitment SCU against a list of Orthanc IDs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3738
diff changeset
2413 std::vector<std::string> b(sopInstanceUids.begin(), sopInstanceUids.end());
3830
447880856ce8 removing deprecated DicomUserControl from OrthancRestModalities.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3808
diff changeset
2414 DicomAssociation::RequestStorageCommitment(parameters, transactionUid, a, b);
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2415 }
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2416
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
2417 Json::Value result = Json::objectValue;
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2418 result["ID"] = transactionUid;
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2419 result["Path"] = "/storage-commitment/" + transactionUid;
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2420 call.GetOutput().AnswerJson(result);
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2421 }
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2422 }
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2423
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2424
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2425 static void GetStorageCommitmentReport(RestApiGetCall& call)
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2426 {
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2427 if (call.IsDocumentation())
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2428 {
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2429 call.GetDocumentation()
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2430 .SetTag("Networking")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2431 .SetSummary("Get storage commitment report")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2432 .SetDescription("Get the storage commitment report whose identifier is provided in the URL: "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
2433 "https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu")
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2434 .SetAnswerField("Status", RestApiCallDocumentation::Type_String,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2435 "Can be `Success`, `Failure`, or `Pending` (the latter means that no report has been received yet)")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2436 .SetAnswerField("RemoteAET", RestApiCallDocumentation::Type_String,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2437 "AET of the remote DICOM modality")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2438 .SetAnswerField("Failures", RestApiCallDocumentation::Type_JsonListOfObjects,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2439 "List of failures that have been encountered during the storage commitment request")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2440 .SetAnswerField("Success", RestApiCallDocumentation::Type_JsonListOfObjects,
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2441 "List of DICOM instances that have been acknowledged by the remote modality, "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2442 "each one is reported as a JSON object containing the `SOPClassUID` and "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2443 "`SOPInstanceUID` DICOM tags")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2444 .SetUriArgument("id", "Identifier of the storage commitment report");
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2445 return;
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2446 }
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2447
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2448 ServerContext& context = OrthancRestApi::GetContext(call);
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2449
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2450 const std::string& transactionUid = call.GetUriComponent("id", "");
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2451
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2452 {
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2453 StorageCommitmentReports::Accessor accessor(
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2454 context.GetStorageCommitmentReports(), transactionUid);
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2455
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2456 if (accessor.IsValid())
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2457 {
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2458 Json::Value json;
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2459 accessor.GetReport().Format(json);
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2460 call.GetOutput().AnswerJson(json);
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2461 }
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2462 else
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2463 {
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2464 throw OrthancException(ErrorCode_InexistentItem,
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2465 "No storage commitment transaction with UID: " + transactionUid);
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2466 }
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2467 }
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2468 }
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2469
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2470
3738
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2471 static void RemoveAfterStorageCommitment(RestApiPostCall& call)
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2472 {
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2473 if (call.IsDocumentation())
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2474 {
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2475 call.GetDocumentation()
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2476 .SetTag("Networking")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2477 .SetSummary("Remove after storage commitment")
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2478 .SetDescription("Remove out of Orthanc, the DICOM instances that have been reported to have been properly "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2479 "received the storage commitment report whose identifier is provided in the URL. This is "
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2480 "only possible if the `Status` of the storage commitment report is `Success`. "
5432
59e3b6f8c5be migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5405
diff changeset
2481 "https://orthanc.uclouvain.be/book/users/storage-commitment.html#removing-the-instances")
4423
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2482 .SetUriArgument("id", "Identifier of the storage commitment report");
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2483 return;
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2484 }
2a69b58ff3ac cont openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4422
diff changeset
2485
3738
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2486 ServerContext& context = OrthancRestApi::GetContext(call);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2487
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2488 const std::string& transactionUid = call.GetUriComponent("id", "");
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2489
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2490 {
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2491 StorageCommitmentReports::Accessor accessor(
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2492 context.GetStorageCommitmentReports(), transactionUid);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2493
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2494 if (!accessor.IsValid())
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2495 {
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2496 throw OrthancException(ErrorCode_InexistentItem,
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2497 "No storage commitment transaction with UID: " + transactionUid);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2498 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2499 else if (accessor.GetReport().GetStatus() != StorageCommitmentReports::Report::Status_Success)
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2500 {
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2501 throw OrthancException(ErrorCode_BadSequenceOfCalls,
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2502 "Cannot remove DICOM instances after failure "
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2503 "in storage commitment transaction: " + transactionUid);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2504 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2505 else
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2506 {
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2507 std::vector<std::string> sopInstanceUids;
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2508 accessor.GetReport().GetSuccessSopInstanceUids(sopInstanceUids);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2509
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2510 for (size_t i = 0; i < sopInstanceUids.size(); i++)
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2511 {
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2512 std::vector<std::string> orthancId;
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2513 context.GetIndex().LookupIdentifierExact(
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2514 orthancId, ResourceType_Instance, DICOM_TAG_SOP_INSTANCE_UID, sopInstanceUids[i]);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2515
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2516 for (size_t j = 0; j < orthancId.size(); j++)
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2517 {
4294
0923247e69f6 log categories: rest -> http + added lua & jobs
Alain Mazy <alain@mazy.be>
parents: 4272
diff changeset
2518 CLOG(INFO, HTTP) << "Storage commitment - Removing SOP instance UID / Orthanc ID: "
4272
1661544ea94d LogCategory_REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4205
diff changeset
2519 << sopInstanceUids[i] << " / " << orthancId[j];
3738
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2520
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2521 Json::Value tmp;
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2522 context.GetIndex().DeleteResource(tmp, orthancId[j], ResourceType_Instance);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2523 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2524 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2525
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2526 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2527 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2528 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2529 }
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2530
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2531
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2532 void OrthancRestApi::RegisterModalities()
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2533 {
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2534 Register("/modalities", ListModalities);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2535 Register("/modalities/{id}", ListModalityOperations);
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2536 Register("/modalities/{id}", UpdateModality);
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
2537 Register("/modalities/{id}", DeleteModality);
1049
bd2cb95003da C-Echo SCU in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1007
diff changeset
2538 Register("/modalities/{id}/echo", DicomEcho);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2539 Register("/modalities/{id}/find-patient", DicomFindPatient);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2540 Register("/modalities/{id}/find-study", DicomFindStudy);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2541 Register("/modalities/{id}/find-series", DicomFindSeries);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2542 Register("/modalities/{id}/find-instance", DicomFindInstance);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2543 Register("/modalities/{id}/find", DicomFind);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2544 Register("/modalities/{id}/store", DicomStore);
3808
7f083dfae62b new REST route: /modalities/{id}/store-straight
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3740
diff changeset
2545 Register("/modalities/{id}/store-straight", DicomStoreStraight); // New in 1.6.1
1998
9b61701c35f2 New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1997
diff changeset
2546 Register("/modalities/{id}/move", DicomMove);
4338
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2547 Register("/modalities/{id}/configuration", GetModalityConfiguration); // New in 1.8.1
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2548
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2549 // For Query/Retrieve
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2550 Register("/modalities/{id}/query", DicomQuery);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2551 Register("/queries", ListQueries);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2552 Register("/queries/{id}", DeleteQuery);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2553 Register("/queries/{id}", ListQueryOperations);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2554 Register("/queries/{id}/answers", ListQueryAnswers);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2555 Register("/queries/{id}/answers/{index}", ListQueryAnswerOperations);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2556 Register("/queries/{id}/answers/{index}/content", GetQueryOneAnswer);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2557 Register("/queries/{id}/answers/{index}/retrieve", RetrieveOneAnswer);
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
2558 Register("/queries/{id}/answers/{index}/query-instances",
2986
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
2559 QueryAnswerChildren<ResourceType_Instance>);
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
2560 Register("/queries/{id}/answers/{index}/query-series",
2986
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
2561 QueryAnswerChildren<ResourceType_Series>);
2982
94c8222c52b7 New URIs to launch new C-FIND to explore the hierarchy of a C-FIND answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2955
diff changeset
2562 Register("/queries/{id}/answers/{index}/query-studies",
2986
b1ba0a8311b5 exploring hierarchy of C-FIND answers finished
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2982
diff changeset
2563 QueryAnswerChildren<ResourceType_Study>);
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2564 Register("/queries/{id}/level", GetQueryLevel);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2565 Register("/queries/{id}/modality", GetQueryModality);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2566 Register("/queries/{id}/query", GetQueryArguments);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2567 Register("/queries/{id}/retrieve", RetrieveAllAnswers);
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
2568
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2569 Register("/peers", ListPeers);
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2570 Register("/peers/{id}", ListPeerOperations);
808
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2571 Register("/peers/{id}", UpdatePeer);
2d9a000aa3a6 update/delete peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 807
diff changeset
2572 Register("/peers/{id}", DeletePeer);
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2573 Register("/peers/{id}/store", PeerStore);
3592
de1665e7b341 added '/peers/{id}/system' route to test the connectivity with a remote peer
Alain Mazy <alain@mazy.be>
parents: 3401
diff changeset
2574 Register("/peers/{id}/system", PeerSystem);
4338
1263e727d048 give access to the configuration of one single peer or modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
2575 Register("/peers/{id}/configuration", GetPeerConfiguration); // New in 1.8.1
4524
f8660649ae96 added "/peers/{id}/store-straight": Synchronously send the DICOM instance in POST body to the peer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4517
diff changeset
2576 Register("/peers/{id}/store-straight", PeerStoreStraight); // New in 1.9.1
1819
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2577
84f0a118a72c new URI: /modalities/{id}/find-worklist
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1787
diff changeset
2578 Register("/modalities/{id}/find-worklist", DicomFindWorklist);
3611
0ce9c1c6474f test route in REST API for storage commitment
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3602
diff changeset
2579
3738
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2580 // Storage commitment
3737
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2581 Register("/modalities/{id}/storage-commitment", StorageCommitmentScu);
f29843323daf accessing storage commitment reports from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
2582 Register("/storage-commitment/{id}", GetStorageCommitmentReport);
3738
bff4da769f6f new route: "/storage-commitment/{...}/remove"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3737
diff changeset
2583 Register("/storage-commitment/{id}/remove", RemoveAfterStorageCommitment);
4339
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
2584
fc5caed6f940 "/tools/dicom-echo": Execute C-Echo SCU to a modality that is not registered in "/modalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4338
diff changeset
2585 Register("/tools/dicom-echo", DicomEchoTool); // New in 1.8.1
751
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2586 }
5197fd35333c refactoring of OrthancRestApi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2587 }