Mercurial > hg > orthanc

comparison OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp @ 5648:a8e9113dc8f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix documentation of /tools/dicom-echo
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 04 Jun 2024 19:15:42 +0200
parents f7adfb22e20e
children
comparison
equal deleted inserted replaced
5647:f048683aa619 5648:a8e9113dc8f1
198 198
199 199
200 static void DocumentEchoShared(RestApiPostCall& call) 200 static void DocumentEchoShared(RestApiPostCall& call)
201 { 201 {
202 call.GetDocumentation() 202 call.GetDocumentation()
203 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
204 "Timeout for the C-ECHO command, in seconds", false)
205 .SetRequestField(KEY_CHECK_FIND, RestApiCallDocumentation::Type_Boolean, 203 .SetRequestField(KEY_CHECK_FIND, RestApiCallDocumentation::Type_Boolean,
206 "Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote " 204 "Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote "
207 "modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` " 205 "modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` "
208 "configuration option. New in Orthanc 1.8.1.", false); 206 "configuration option. New in Orthanc 1.8.1.", false);
209 } 207 }
217 call.GetDocumentation() 215 call.GetDocumentation()
218 .SetTag("Networking") 216 .SetTag("Networking")
219 .SetSummary("Trigger C-ECHO SCU") 217 .SetSummary("Trigger C-ECHO SCU")
220 .SetDescription("Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: " 218 .SetDescription("Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: "
221 "https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo") 219 "https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo")
220 .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number,
221 "Timeout for the C-ECHO command, in seconds", false)
222 .SetUriArgument("id", "Identifier of the modality of interest"); 222 .SetUriArgument("id", "Identifier of the modality of interest");
223 return; 223 return;
224 } 224 }
225 225
226 Json::Value body = Json::objectValue; 226 Json::Value body = Json::objectValue;