diff OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4422:48303e493135

cont openapi
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 29 Dec 2020 16:05:07 +0100
parents a7d72378e1cb
children 83371ccdfe80
line wrap: on
line diff
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Tue Dec 29 15:22:00 2020 +0100
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Tue Dec 29 16:05:07 2020 +0100
@@ -2293,6 +2293,20 @@
 
   static void Lookup(RestApiPostCall& call)
   {
+    if (call.IsDocumentation())
+    {
+      call.GetDocumentation()
+        .SetTag("System")
+        .SetSummary("Look for DICOM identifiers")
+        .SetDescription("This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources")
+        .AddRequestType(MimeType_PlainText, "The DICOM identifier of interest (i.e. the value of `PatientID`, "
+                        "`StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`)")
+        .AddAnswerType(MimeType_Json, "JSON array containing a list of matching Orthanc resources, each item in the "
+                       "list corresponding to a JSON object with the fields `Type`, `ID` and `Path` identifying one "
+                       "DICOM resource that is stored by Orthanc");
+      return;
+    }
+
     std::string tag;
     call.BodyToString(tag);