changeset 380:06ab5ab05a2d

API doc: download study
author Alain Mazy <alain@mazy.be>
date Wed, 08 Apr 2020 12:20:46 +0200
parents c9fe3d0d0fa1
children f9c4c6144fec
files Sphinx/source/users/rest.rst
diffstat 1 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/users/rest.rst	Wed Apr 08 08:49:59 2020 +0200
+++ b/Sphinx/source/users/rest.rst	Wed Apr 08 12:20:46 2020 +0200
@@ -383,6 +383,19 @@
 Users of Matlab or Octave can find related information :ref:`in the
 dedicated section <matlab>`.
 
+Downloading studies
+^^^^^^^^^^^^^^^^^^
+
+.. highlight:: bash
+
+All instances of a study can be retrieved as a zip file as follows::
+
+  $ curl http://localhost:8042/studies/6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715/archive > Study.zip
+
+It is also possible to download a zipped DICOMDIR through::
+
+  $ curl http://localhost:8042/instances/6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715/media > Study.zip
+
 
 .. _peering: