diff Sphinx/source/users/rest.rst @ 662:88503c6e549f

list of items in /tools/find
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 29 Apr 2021 12:54:51 +0200
parents 06bea33cb7d0
children be71b56c90ab
line wrap: on
line diff
--- a/Sphinx/source/users/rest.rst	Thu Apr 29 12:50:01 2021 +0200
+++ b/Sphinx/source/users/rest.rst	Thu Apr 29 12:54:51 2021 +0200
@@ -869,12 +869,13 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. highlight:: bash
 
-Performing a find within Orthanc is very similar to using Queries
-against DICOM modalities and the additional options listed above work
-with find also.  When performing a find, you will receive the Orthanc
-ID's of all the matched items within your find. For example if you
-perform a study level find and 5 Studies match you will receive 5
-study level Orthanc ID's in JSON format as a response::
+Performing a find within the local database of Orthanc is very similar
+to using Queries against DICOM modalities and the additional options
+listed above work with find also.  When performing a find, you will
+receive the Orthanc ID's of all the matched items within your
+find. For example if you perform a study level find and 5 Studies
+match you will receive 5 study level Orthanc ID's in JSON format as a
+response::
 
   $ curl --request POST --url http://localhost:8042/tools/find \
     --data '{
@@ -925,6 +926,18 @@
     }
   ]
 
+Here is a sample REST API call to find the Orthanc identifiers of all
+the DICOM series generated by an imaging modality whose "Device Serial
+Number (0018,1000)" DICOM tag is equal to "123"::
+
+  $ curl -X POST http://localhost:8042/tools/find -d '{"Level":"Series","Query":{"DeviceSerialNumber":"123"},"Expand":true}'
+
+If you are interested by a **list of several items** (in this case, in
+a list of serial numbers), just separate them with backslashes as
+would do with DICOM C-FIND::
+
+  $ curl -X POST http://localhost:8042/tools/find -d '{"Level":"Series","Query":{"DeviceSerialNumber":"123\\abc"},"Expand":true}'
+
   
   
 Additional Options