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

comparison Sphinx/source/users/rest.rst @ 404:7469b6c5618b

DICOM commands: Timeout + improved existing doc

author	Alain Mazy <alain@mazy.be>
date	Wed, 29 Apr 2020 12:59:34 +0200
parents	f9c4c6144fec
children	5119ccd08aec

comparison

equal deleted inserted replaced

-:108f21475b4a
+:7469b6c5618b
 Note that you can send isolated DICOM instances with this command, but
 also entire patients, studies or series. It is possible to send multiple instances with a single POST
 request::
 $ curl -X POST http://localhost:8042/peers/sample/store -d '["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88","d5604121-7d613ce6-c315a5-a77b3cf3-9c253b23","cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e"]'
 Note that the list of resources to be sent can include the
 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients,
 studies or series as well.
 Testing connectivity with a remote peer
 - configure your client Orthanc to use a client certificate to authenticate at the Server.  This is done through the ``CertificateFile``, ``CertificateKeyFile`` and ``CertificateKeyPassword`` entries in the configuration file.
-Sending resources to remote modalities (through DICOM)
+Sending resources to remote modalities (through DICOM C-Store)
-------------------------------------------------------
+--------------------------------------------------------------
 Orthanc can send its DICOM instances to remote DICOM modalities (C-Store SCU). This process
 can be triggered by the REST API.
 Configuration
 the remote modality, as specified above in the configuration file.
 Note that you can send isolated DICOM instances with this command, but
 also entire patients, studies or series.
+Various optional fields are also available::
+$ curl -X POST http://localhost:8042/modalities/sample/store \
+--data '{
+"Resources" : ["d4b46c8e-74b16992-b0f5ca11-f04a60fa-8eb13a88"],
+"Synchronous" : false,
+"LocalAet" : "ORTHANC",
+"MoveOriginatorAet": "ORTHANC",
+"MoveOriginatorID": 1234,
+"Timeout": 10,
+"StorageCommitment": false
+}'
 Bulk Store SCU
 ^^^^^^^^^^^^^^
 .. highlight:: bash
 Note that the list of resources to be sent can include the
 :ref:`Orthanc identifiers <orthanc-ids>` of entire patients,
 studies or series as well.
+Performing C-Echo
-Performing Query/Retrieve and Find with REST
+-----------------
---------------------------------------------
+To validate the DICOM connectivity between Orthanc and a remote modality,
+you can perform a C-ECHO::
+$ curl -X POST http://localhost:8042/modalities/sample/echo -d ''
+From Orthanc 1.7.0, you can include an extra ``Timeout`` field.
+$ curl -X POST http://localhost:8042/modalities/sample/echo -d '{ "Timeout": 10 }'
+If no ``Timeout`` parameter is specified, the value of the ``DicomScuTimeout``
+configuration is used as a default.  If ``Timeout`` is set to zero, this means
+no timeout.
+Performing C-Move
+-----------------
+.. highlight:: bash
+You can perform a DICOM C-Move to move a specific study from one modality
+to another (including Orthanc itself if you don't specify the ``TargetAet``
+field).
+I.e. to move a study whose you know the ``StudyInstanceUID`` from
+the modality ``sample`` to another Orthanc whose AET is ``ORTHANCB``::
+$ curl --request POST --url http://localhost:8042/modalities/samples/move \
+--data '{
+"Level" : "Study",
+"Resources" : [
+{
+"StudyInstanceUID": "1.2.840.113543.6.6.4.7.64067529866380271256212683512383713111129"
+}
+],
+"TargetAet": "ORTHANCB",
+"Timeout": 60
+}'
+Performing Query/Retrieve (C-Find) and Find with REST
+-----------------------------------------------------
 *Section contributed by Bryan Dearlove*
 Orthanc can be used to perform queries on the local Orthanc instance,
 or on remote modalities through the REST API.
 insensitive unless configured otherwise within the Orthanc
 configuration file::
 $ curl --request POST \
 --url http://localhost:8042/modalities/sample/query \
---data '{"Level":"Study","Query": {"PatientID":"","StudyDescription":"*Chest*","PatientName":""}}'
+--data '{
+"Level" : "Study",
+"Query" : {
+"PatientID" : "",
+"StudyDescription" : "*Chest*",
+"PatientName" : ""
+}
+}'
 You might be interested in including the ``Normalize`` option to bypass
 the normalization of the outgoing C-FIND queries. For instance, for
 the ``InstitutionName`` to be included at the ``Study`` level, one would
 run::
 {
 "ID" : "11541b16-e368-41cf-a8e9-3acf4061d238",
 "Path" : "/jobs/11541b16-e368-41cf-a8e9-3acf4061d238"
 }
 .. _rest-find:
 Performing Finds within Orthanc
 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 '{"Level":"Instance","Query":{"Modality":"CR","StudyDate":"20180323-","PatientID":"*"}}'
+$ curl --request POST --url http://localhost:8042/tools/find \
+--data '{
+"Level" : "Instance",
+"Query" : {
+"Modality" : "CR",
+"StudyDate" : "20180323-",
+"PatientID" : "*"
+}
+}'
 Setting the ``Expand`` field to ``true`` in the POST body of the
 query will automatically report details about each study::
 $ curl https://demo.orthanc-server.com/tools/find -d '{"Level":"Study","Query":{"PatientName":"KNIX"}}'

Mercurial > hg > orthanc-book

comparison Sphinx/source/users/rest.rst @ 404:7469b6c5618b