Mercurial > hg > orthanc

comparison OrthancServer/Sources/OrthancRestApi/OrthancRestAnonymizeModify.cpp @ 5432:59e3b6f8c5be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
migration to UCLouvain servers
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 21 Nov 2023 18:16:31 +0100
parents 303e930fff0f
children 48b8dae6dc77
comparison
equal deleted inserted replaced
5431:4be5f117aa0d 5432:59e3b6f8c5be
83 { 83 {
84 // Check out "DicomModification::ParseModifyRequest()" 84 // Check out "DicomModification::ParseModifyRequest()"
85 call.GetDocumentation() 85 call.GetDocumentation()
86 .SetRequestField(TRANSCODE, RestApiCallDocumentation::Type_String, 86 .SetRequestField(TRANSCODE, RestApiCallDocumentation::Type_String,
87 "Transcode the DICOM instances to the provided DICOM transfer syntax: " 87 "Transcode the DICOM instances to the provided DICOM transfer syntax: "
88 "https://book.orthanc-server.com/faq/transcoding.html", false) 88 "https://orthanc.uclouvain.be/book/faq/transcoding.html", false)
89 .SetRequestField(FORCE, RestApiCallDocumentation::Type_Boolean, 89 .SetRequestField(FORCE, RestApiCallDocumentation::Type_Boolean,
90 "Allow the modification of tags related to DICOM identifiers, at the risk of " 90 "Allow the modification of tags related to DICOM identifiers, at the risk of "
91 "breaking the DICOM model of the real world", false) 91 "breaking the DICOM model of the real world", false)
92 .SetRequestField("RemovePrivateTags", RestApiCallDocumentation::Type_Boolean, 92 .SetRequestField("RemovePrivateTags", RestApiCallDocumentation::Type_Boolean,
93 "Remove the private tags from the DICOM instances (defaults to `false`)", false) 93 "Remove the private tags from the DICOM instances (defaults to `false`)", false)
111 { 111 {
112 // Check out "DicomModification::ParseAnonymizationRequest()" 112 // Check out "DicomModification::ParseAnonymizationRequest()"
113 call.GetDocumentation() 113 call.GetDocumentation()
114 .SetRequestField(TRANSCODE, RestApiCallDocumentation::Type_String, 114 .SetRequestField(TRANSCODE, RestApiCallDocumentation::Type_String,
115 "Transcode the DICOM instances to the provided DICOM transfer syntax: " 115 "Transcode the DICOM instances to the provided DICOM transfer syntax: "
116 "https://book.orthanc-server.com/faq/transcoding.html", false) 116 "https://orthanc.uclouvain.be/book/faq/transcoding.html", false)
117 .SetRequestField(FORCE, RestApiCallDocumentation::Type_Boolean, 117 .SetRequestField(FORCE, RestApiCallDocumentation::Type_Boolean,
118 "Allow the modification of tags related to DICOM identifiers, at the risk of " 118 "Allow the modification of tags related to DICOM identifiers, at the risk of "
119 "breaking the DICOM model of the real world", false) 119 "breaking the DICOM model of the real world", false)
120 .SetRequestField("DicomVersion", RestApiCallDocumentation::Type_String, 120 .SetRequestField("DicomVersion", RestApiCallDocumentation::Type_String,
121 "Version of the DICOM standard to be used for anonymization. Check out " 121 "Version of the DICOM standard to be used for anonymization. Check out "
263 DocumentModifyOptions(call); 263 DocumentModifyOptions(call);
264 call.GetDocumentation() 264 call.GetDocumentation()
265 .SetTag("Instances") 265 .SetTag("Instances")
266 .SetSummary("Modify instance") 266 .SetSummary("Modify instance")
267 .SetDescription("Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: " 267 .SetDescription("Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: "
268 "https://book.orthanc-server.com/users/anonymization.html#modification-of-a-single-instance") 268 "https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-a-single-instance")
269 .SetUriArgument("id", "Orthanc identifier of the instance of interest") 269 .SetUriArgument("id", "Orthanc identifier of the instance of interest")
270 .AddAnswerType(MimeType_Dicom, "The modified DICOM instance"); 270 .AddAnswerType(MimeType_Dicom, "The modified DICOM instance");
271 return; 271 return;
272 } 272 }
273 273
308 DocumentAnonymizationOptions(call); 308 DocumentAnonymizationOptions(call);
309 call.GetDocumentation() 309 call.GetDocumentation()
310 .SetTag("Instances") 310 .SetTag("Instances")
311 .SetSummary("Anonymize instance") 311 .SetSummary("Anonymize instance")
312 .SetDescription("Download an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL: " 312 .SetDescription("Download an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL: "
313 "https://book.orthanc-server.com/users/anonymization.html#anonymization-of-a-single-instance") 313 "https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-a-single-instance")
314 .SetUriArgument("id", "Orthanc identifier of the instance of interest") 314 .SetUriArgument("id", "Orthanc identifier of the instance of interest")
315 .AddAnswerType(MimeType_Dicom, "The anonymized DICOM instance"); 315 .AddAnswerType(MimeType_Dicom, "The anonymized DICOM instance");
316 return; 316 return;
317 } 317 }
318 318
439 .SetTag(GetResourceTypeText(resourceType, true /* plural */, true /* upper case */)) 439 .SetTag(GetResourceTypeText(resourceType, true /* plural */, true /* upper case */))
440 .SetSummary("Modify " + r) 440 .SetSummary("Modify " + r)
441 .SetDescription("Start a job that will modify all the DICOM instances within the " + r + 441 .SetDescription("Start a job that will modify all the DICOM instances within the " + r +
442 " whose identifier is provided in the URL. The modified DICOM instances will be " 442 " whose identifier is provided in the URL. The modified DICOM instances will be "
443 "stored into a brand new " + r + ", whose Orthanc identifiers will be returned by the job. " 443 "stored into a brand new " + r + ", whose Orthanc identifiers will be returned by the job. "
444 "https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series") 444 "https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series")
445 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest"); 445 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest");
446 return; 446 return;
447 } 447 }
448 448
449 std::unique_ptr<DicomModification> modification(new DicomModification); 449 std::unique_ptr<DicomModification> modification(new DicomModification);
512 .SetTag(GetResourceTypeText(resourceType, true /* plural */, true /* upper case */)) 512 .SetTag(GetResourceTypeText(resourceType, true /* plural */, true /* upper case */))
513 .SetSummary("Anonymize " + r) 513 .SetSummary("Anonymize " + r)
514 .SetDescription("Start a job that will anonymize all the DICOM instances within the " + r + 514 .SetDescription("Start a job that will anonymize all the DICOM instances within the " + r +
515 " whose identifier is provided in the URL. The modified DICOM instances will be " 515 " whose identifier is provided in the URL. The modified DICOM instances will be "
516 "stored into a brand new " + r + ", whose Orthanc identifiers will be returned by the job. " 516 "stored into a brand new " + r + ", whose Orthanc identifiers will be returned by the job. "
517 "https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series") 517 "https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series")
518 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest"); 518 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest");
519 return; 519 return;
520 } 520 }
521 521
522 std::unique_ptr<DicomModification> modification(new DicomModification); 522 std::unique_ptr<DicomModification> modification(new DicomModification);
1057 .SetTag("Studies") 1057 .SetTag("Studies")
1058 .SetSummary("Split study") 1058 .SetSummary("Split study")
1059 .SetDescription("Start a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, " 1059 .SetDescription("Start a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, "
1060 "by taking some of its children series or instances out of it and putting them into a brand new study " 1060 "by taking some of its children series or instances out of it and putting them into a brand new study "
1061 "(this new study is created by setting the `StudyInstanceUID` tag to a random identifier): " 1061 "(this new study is created by setting the `StudyInstanceUID` tag to a random identifier): "
1062 "https://book.orthanc-server.com/users/anonymization.html#splitting") 1062 "https://orthanc.uclouvain.be/book/users/anonymization.html#splitting")
1063 .SetUriArgument("id", "Orthanc identifier of the study of interest") 1063 .SetUriArgument("id", "Orthanc identifier of the study of interest")
1064 .SetRequestField(SERIES, RestApiCallDocumentation::Type_JsonListOfStrings, 1064 .SetRequestField(SERIES, RestApiCallDocumentation::Type_JsonListOfStrings,
1065 "The list of series to be separated from the parent study. " 1065 "The list of series to be separated from the parent study. "
1066 "These series must all be children of the same source study, that is specified in the URI.", false) 1066 "These series must all be children of the same source study, that is specified in the URI.", false)
1067 .SetRequestField(REPLACE, RestApiCallDocumentation::Type_JsonObject, 1067 .SetRequestField(REPLACE, RestApiCallDocumentation::Type_JsonObject,
1183 OrthancRestApi::DocumentSubmitCommandsJob(call); 1183 OrthancRestApi::DocumentSubmitCommandsJob(call);
1184 call.GetDocumentation() 1184 call.GetDocumentation()
1185 .SetTag("Studies") 1185 .SetTag("Studies")
1186 .SetSummary("Merge study") 1186 .SetSummary("Merge study")
1187 .SetDescription("Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier " 1187 .SetDescription("Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier "
1188 "is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#merging") 1188 "is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#merging")
1189 .SetUriArgument("id", "Orthanc identifier of the study of interest") 1189 .SetUriArgument("id", "Orthanc identifier of the study of interest")
1190 .SetRequestField(RESOURCES, RestApiCallDocumentation::Type_JsonListOfStrings, 1190 .SetRequestField(RESOURCES, RestApiCallDocumentation::Type_JsonListOfStrings,
1191 "The list of DICOM resources (studies, series, and/or instances) to be merged " 1191 "The list of DICOM resources (studies, series, and/or instances) to be merged "
1192 "into the study of interest (mandatory option)", true) 1192 "into the study of interest (mandatory option)", true)
1193 .SetRequestField(KEEP_SOURCE, RestApiCallDocumentation::Type_Boolean, 1193 .SetRequestField(KEEP_SOURCE, RestApiCallDocumentation::Type_Boolean,