orthanc-book: Sphinx/source/users/rest.rst comparison

comparison Sphinx/source/users/rest.rst @ 212:7ff807cc5ade

added modalities configuration

author	amazy
date	Fri, 22 Feb 2019 10:02:23 +0100
parents	66295dffbf33
children	dcf6c2e60448

comparison

equal deleted inserted replaced

-:66295dffbf33
+:7ff807cc5ade
 <configuration>`. For instance, here is how to declare a remote
 modality::
 ...
 "DicomModalities" : {
-"sample" : [ "STORESCP", "127.0.0.1", 2000 ]
+"sample" : [ "ORTHANCA", "127.0.0.1", 2000 ], // short version
+"sample2" : {                                 // long version
+"AET" : "ORTHANCB",
+"Port" : 2001,
+"Host" : "127.0.0.1",
+"Manufacturer" : "Generic",
+"AllowEcho" : true,
+"AllowFind" : true,
+"AllowMove" : true,
+"AllowStore" : true
+}
 },
 ...
 .. highlight:: bash
-Such a configuration would enable Orthanc to connect to another DICOM
+Such a configuration would enable Orthanc to connect to two DICOM
-store (for instance, another Orthanc instance) that listens on the
+stores (for instance, other Orthanc instances) that listens on the
-localhost on the port 2000. The modalities that are known to Orthanc
+localhost on the port 2000 & 2001. The modalities that are known to Orthanc
 can be queried::
-$ curl http://localhost:8042/modalities
+$ curl http://localhost:8042/modalities?expand
+The modalities can then be updated through the API too::
+$ curl -v -X PUT http://localhost:8042/modalities/sample -d '{"AET" : "ORTHANCC", "Host": "127.0.0.1", "Port": 2002}'
+Note that, by default, modalities are stored in Orthanc configuration files
+and are updated in Orthanc memory only.  If you want your modifications
+to be persistent, you should configure Orthanc to store its modalities
+in the database.  This is done through this configuration::
+...
+"DicomModalitiesInDatabase" : true,
+...
 Sending One Resource
 ^^^^^^^^^^^^^^^^^^^^
 .. highlight:: bash

Mercurial > hg > orthanc-book

comparison Sphinx/source/users/rest.rst @ 212:7ff807cc5ade