Mercurial > hg > orthanc-book
annotate Sphinx/source/users/advanced-rest.rst @ 839:c29ac12e3160
Orthanc-1.11.0
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Mon, 09 May 2022 13:11:36 +0200 |
| parents | 24a2ce71a161 |
| children | 5ba44d8db9bc |
| rev | line source |
|---|---|
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 .. _rest-advanced: |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 Advanced features of the REST API |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 ================================= |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
6 .. contents:: |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
7 :depth: 3 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
9 This section of the Orthanc Book is a complement to the description of |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
10 the :ref:`REST API of Orthanc <rest>`. It explains some advanced uses |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
11 of the API. |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
12 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
13 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
14 .. _jobs: |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
15 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
16 Jobs |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
17 ---- |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
18 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
19 Since Orthanc 1.4.0, a jobs engine is embedded within Orthanc. Jobs |
| 227 | 20 are high-level tasks to be processed by Orthanc. Jobs are first added |
| 21 to a queue of pending tasks, and Orthanc will simultaneously execute a | |
| 22 fixed number of jobs (check out :ref:`configuration option | |
| 23 <configuration>` ``ConcurrentJobs``). Once the jobs have been | |
| 24 processed, they are tagged as successful or failed, and kept in a | |
| 25 history (the size of this history is controlled by the | |
| 26 ``JobsHistorySize`` option). | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
27 |
| 227 | 28 By default, Orthanc saves the jobs into its database (check out the |
| 798 | 29 ``SaveJobs`` option). Jobs are saved every 10 seconds and when |
| 30 Orthanc stops. If Orthanc is stopped then relaunched, the jobs | |
| 227 | 31 whose processing was not finished are automatically put into the queue |
| 798 | 32 of pending tasks or resumed if they were being processed when Orthanc |
| 33 stopped. The command-line option ``--no-jobs`` can also be used to | |
| 34 prevent the loading of jobs from the database upon the launch of | |
| 35 Orthanc. | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
36 |
|
821
d7c8c8f6cffb
removed 'LimitJobs' that is unused
Alain Mazy <am@osimis.io>
parents:
817
diff
changeset
|
37 Note that the queue of pending jobs has no size limit. |
| 227 | 38 |
|
672
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
671
diff
changeset
|
39 .. _jobs-synchronicity: |
|
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
671
diff
changeset
|
40 |
| 227 | 41 Synchronous vs. asynchronous calls |
| 42 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
| 43 | |
| 44 Some calls to the REST API of Orthanc need time to be executed, and | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
45 thus result in adding a job to the processing queue. This notably |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
46 includes the following URIs: |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
47 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
48 * :ref:`Modifying and anonymizing <anonymization>` DICOM instances. |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
49 * Creating ZIP or media archives. |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
50 * C-Move SCU (``/queries/.../retrieve``). |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
51 * C-Store SCU (``/modalities/.../store``). |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
52 * Sending to an Orthanc peer (``/peers/.../store``). |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
53 * :ref:`Split/merge <split-merge>`. |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
54 * Sending images using the :ref:`transfers accelerator <transfers>` plugin. |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
55 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
56 Such REST API calls can be configured to be executed in a synchronous |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
57 or an asynchronous mode: |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
58 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
59 * **Synchronous calls** wait for the end of the execution of their |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
60 associated job. This is in general the default behavior. |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
61 * **Asynchronous calls** end immediately and return a handle to their |
| 227 | 62 associated job. It is up to the caller to monitor the execution by |
| 63 calling the jobs API (e.g. to know whether the job has finished its | |
| 64 execution). | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
65 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
66 The choice between synchronous and asynchronous modes is done by |
| 227 | 67 setting the ``Synchronous`` field (or indifferently the |
| 68 ``Asynchronous`` field) in the POST body of the call to the REST | |
| 69 API. Note that the :ref:`transfers accelerator <transfers>` only runs | |
| 70 in asynchronous mode. | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
71 |
| 227 | 72 An integer number (possibly negative) can be specified in the |
| 73 ``Priority`` field of the POST body. Jobs with higher priority will be | |
| 74 executed first. By default, the priority is set to zero. | |
| 75 | |
| 76 Despite being more complex to handle, the asynchronous mode is highly | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
77 recommended for jobs whose execution time can last over a dozen of |
|
693
650100457193
SynchronousZipStream
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
678
diff
changeset
|
78 seconds (typically, the creation of an archive if |
|
650100457193
SynchronousZipStream
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
678
diff
changeset
|
79 ``SynchronousZipStream`` :ref:`configuration option <configuration>` |
|
650100457193
SynchronousZipStream
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
678
diff
changeset
|
80 is set to ``false``, or a network transfer). Indeed, synchronous |
|
650100457193
SynchronousZipStream
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
678
diff
changeset
|
81 calls can be affected by timeouts in the HTTP protocol if they last |
|
650100457193
SynchronousZipStream
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
678
diff
changeset
|
82 too long. |
| 227 | 83 |
| 84 | |
|
260
f9e7036d81d0
updating DICOMweb documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
253
diff
changeset
|
85 .. _jobs-monitoring: |
|
f9e7036d81d0
updating DICOMweb documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
253
diff
changeset
|
86 |
| 227 | 87 Monitoring jobs |
| 88 ^^^^^^^^^^^^^^^ | |
| 89 | |
| 90 .. highlight:: bash | |
| 91 | |
| 92 The list of all jobs can be retrieved as follows:: | |
| 93 | |
| 94 $ curl http://localhost:8042/jobs | |
| 95 [ "e0d12aac-47eb-454f-bb7f-9857931e2904" ] | |
| 96 | |
| 97 Full details about each job can be retrieved:: | |
| 98 | |
| 99 $ curl http://localhost:8042/jobs/e0d12aac-47eb-454f-bb7f-9857931e2904 | |
| 100 { | |
| 101 "CompletionTime" : "20190306T095223.753851", | |
| 102 "Content" : { | |
| 103 "Description" : "REST API", | |
| 104 "InstancesCount" : 1, | |
| 105 "UncompressedSizeMB" : 0 | |
| 106 }, | |
| 107 "CreationTime" : "20190306T095223.750666", | |
| 108 "EffectiveRuntime" : 0.001, | |
| 109 "ErrorCode" : 0, | |
| 110 "ErrorDescription" : "Success", | |
| 111 "ID" : "e0d12aac-47eb-454f-bb7f-9857931e2904", | |
| 112 "Priority" : 0, | |
| 113 "Progress" : 100, | |
| 114 "State" : "Success", | |
| 115 "Timestamp" : "20190306T095408.556082", | |
| 116 "Type" : "Archive" | |
| 117 } | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
118 |
| 227 | 119 Note that the ``/jobs?expand`` URI will retrieve this information in |
| 120 one single REST query. The ``Content`` field contains the parameters | |
| 121 of the job, and is very specific to the ``Type`` of job. | |
| 122 | |
| 123 The ``State`` field can be: | |
| 124 | |
| 125 * ``Pending``: The job is waiting to be executed. | |
| 126 * ``Running``: The job is being executed. The ``Progress`` field will | |
| 127 be continuously updated to reflect the progression of the execution. | |
| 128 * ``Success``: The job has finished with success. | |
| 129 * ``Failure``: The job has finished with failure. Check out the | |
| 130 ``ErrorCode`` and ``ErrorDescription`` fields for more information. | |
| 131 * ``Paused``: The job has been paused. | |
| 132 * ``Retry``: The job has failed internally, and has been scheduled for | |
| 839 | 133 re-submission after a delay. As of Orthanc 1.11.0, this feature is not |
| 227 | 134 used by any type of job. |
| 135 | |
| 136 In order to wait for the end of an asynchronous call, the caller will | |
| 137 typically have to poll the ``/jobs/...` URI (i.e. make periodic | |
| 138 calls), waiting for the ``State`` field to become ``Success`` or | |
| 139 ``Failure``. | |
| 140 | |
|
671
bc8fa2bf4cf7
asynchronous c-move
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
638
diff
changeset
|
141 Note that the `integration tests of Orthanc |
| 839 | 142 <https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.11.0/Tests/Toolbox.py>`__ |
|
671
bc8fa2bf4cf7
asynchronous c-move
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
638
diff
changeset
|
143 give an example about how to monitor a job in Python using the REST |
|
bc8fa2bf4cf7
asynchronous c-move
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
638
diff
changeset
|
144 API (cf. function ``MonitorJob()``). |
|
bc8fa2bf4cf7
asynchronous c-move
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
638
diff
changeset
|
145 |
| 227 | 146 |
| 833 | 147 .. _jobs-priority: |
| 148 | |
| 149 Jobs priority | |
| 150 ^^^^^^^^^^^^^ | |
| 151 | |
| 152 When executing jobs, Orthanc will pick the jobs with the highest ``Priority`` | |
| 153 from the pending job list. An integer value is a valid ``Priority``. You may | |
| 154 also use negative number to lower the priority below the default one (``0``). | |
| 155 | |
| 156 Pending jobs are not ordered in the API response but they are picked up in the right order. | |
| 157 | |
| 158 | |
|
322
c5226c5509ca
storage commitment scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
310
diff
changeset
|
159 .. _jobs-controlling: |
|
c5226c5509ca
storage commitment scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
310
diff
changeset
|
160 |
| 227 | 161 Interacting with jobs |
| 162 ^^^^^^^^^^^^^^^^^^^^^ | |
| 163 | |
| 164 Given the ID of some job, one can: | |
| 165 | |
| 166 * Cancel the job by POST-ing to ``/jobs/.../cancel``. | |
| 167 * Pause the job by POST-ing to ``/jobs/.../pause``. | |
| 168 * Resume a job in ``Paused`` state by POST-ing to ``/jobs/.../resume``. | |
| 169 * Retry a job in ``Failed`` state by POST-ing to ``/jobs/.../resubmit``. | |
| 170 | |
| 171 The related state machine is depicted in the `implementation notes | |
| 449 | 172 <https://hg.orthanc-server.com/orthanc/raw-file/default/OrthancServer/Resources/ImplementationNotes/JobsEngineStates.pdf>`__. |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
173 |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
174 |
|
487
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
175 Example: Asynchronous generation of an archive |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
177 |
|
487
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
178 .. highlight:: bash |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
179 |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
180 Sucessful jobs are associated with a set of so-called "outputs" that |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
181 can be attached to the job. |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
182 |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
183 Here is a sample bash session to ask Orthanc to generate a ZIP |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
184 archive, then to download it locally:: |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
185 |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
186 $ curl http://localhost:8042/studies/27f7126f-4f66fb14-03f4081b-f9341db2-53925988/archive -d '{"Asynchronous":true}' |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
187 { |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
188 "ID" : "82cc02d1-03fe-41f9-be46-a308d16ea94a", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
189 "Path" : "/jobs/82cc02d1-03fe-41f9-be46-a308d16ea94a" |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
190 } |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
191 $ curl http://localhost:8042/jobs/82cc02d1-03fe-41f9-be46-a308d16ea94a |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
192 { |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
193 "CompletionTime" : "20200817T144700.401777", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
194 "Content" : { |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
195 "Description" : "REST API", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
196 "InstancesCount" : 232, |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
197 "UncompressedSizeMB" : 64 |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
198 }, |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
199 "CreationTime" : "20200817T144658.011824", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
200 "EffectiveRuntime" : 2.3879999999999999, |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
201 "ErrorCode" : 0, |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
202 "ErrorDescription" : "Success", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
203 "ID" : "82cc02d1-03fe-41f9-be46-a308d16ea94a", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
204 "Priority" : 0, |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
205 "Progress" : 100, |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
206 "State" : "Success", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
207 "Timestamp" : "20200817T144705.770825", |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
208 "Type" : "Archive" |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
209 } |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
210 $ curl http://localhost:8042/jobs/82cc02d1-03fe-41f9-be46-a308d16ea94a/archive > a.zip |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
211 |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
212 Note how we retrieve the content of the archive by accessing the |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
213 ``archive`` output of the job (check out the virtual method |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
214 ``IJob::GetOutput()`` from the `source code |
| 839 | 215 <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__ |
|
487
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
216 of Orthanc). |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
217 |
|
516
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
218 Here is the corresponding sequence of commands to generate a DICOMDIR |
|
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
219 media:: |
|
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
220 |
|
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
221 $ curl http://localhost:8042/studies/27f7126f-4f66fb14-03f4081b-f9341db2-53925988/media -d '{"Asynchronous":true}' |
|
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
222 $ curl http://localhost:8042/jobs/6332be8a-0052-44fb-8cc2-ac959aeccad9/archive > a.zip |
|
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
223 |
| 839 | 224 As of Orthanc 1.11.0, only the creation of a ZIP or a DICOMDIR archive |
|
516
416581db306e
sample: asynchronous download of media archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
513
diff
changeset
|
225 produces such "outputs". |
|
487
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
226 |
|
13bb9af3df26
Example: Asynchronous generation of an archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
461
diff
changeset
|
227 |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
228 .. _pdf: |
|
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
229 |
| 310 | 230 Attaching PDF file as DICOM series |
| 231 ---------------------------------- | |
|
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
232 |
|
226
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
233 Among many different types of data, DICOM files can be used to store |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
234 PDF files. The ``/tools/create-dicom`` URI can be used to upload a PDF |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
235 file to Orthanc. The following scripts perform such a *DICOM-ization*; |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
236 They convert the ``HelloWorld2.pdf`` file to base64, then perform a |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
237 ``POST`` request with JSON data containing the converted payload. |
|
225
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
238 |
|
545
931052bd5a53
explain the "Parent" field in "/tools/create-dicom" for PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
528
diff
changeset
|
239 Importantly, the ``Parent`` field of the ``POST`` body can be set to |
|
931052bd5a53
explain the "Parent" field in "/tools/create-dicom" for PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
528
diff
changeset
|
240 the :ref:`Orthanc identifier of some study <orthanc-ids>` in order to |
|
931052bd5a53
explain the "Parent" field in "/tools/create-dicom" for PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
528
diff
changeset
|
241 attach the newly-created PDF series to the given parent study. |
|
931052bd5a53
explain the "Parent" field in "/tools/create-dicom" for PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
528
diff
changeset
|
242 |
|
297
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
243 Using bash: |
| 227 | 244 |
|
297
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
245 .. code-block:: bash |
|
225
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
246 |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
247 # create the json data, with the BASE64 data embedded in it |
|
545
931052bd5a53
explain the "Parent" field in "/tools/create-dicom" for PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
528
diff
changeset
|
248 (echo -n '{"Parent": "b6e8436b-c5835b7b-cecc9576-0483e165-ab5c710b", "Tags" : {"Modality" : "CT"}, "Content" : "data:application/pdf;base64,'; base64 HelloWorld2.pdf; echo '"}') > /tmp/foo |
|
225
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
249 |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
250 # upload it to Orthanc |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
251 cat /tmp/foo | curl -H "Content-Type: application/json" -d @- http://localhost:8042/tools/create-dicom |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
252 |
| 227 | 253 |
|
297
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
254 Using powershell: |
|
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
255 |
|
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
256 .. code-block:: perl |
|
225
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
257 |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
258 # create the BASE64 string data |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
259 $fileInBase64 = $([Convert]::ToBase64String((gc -Path "HelloWorld2.pdf" -Encoding Byte))) |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
260 |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
261 # create the json data |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
262 $params = @{Tags = @{PatientName = "Benjamino";Modality = "CT"};Content= "data:application/pdf;base64,$fileInBase64"} |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
263 |
| 376 | 264 # disabling the progress bar makes the Invoke-RestMethod call MUCH faster |
|
297
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
265 $ProgressPreference = 'SilentlyContinue' |
|
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
266 |
|
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
267 # upload it to Orthanc |
|
64d1ddab8246
Improved PDF creation Pwsh snippet + added Dicom instance upload example with
Benjamin Golinvaux <bgo@osimis.io>
parents:
290
diff
changeset
|
268 $reply = Invoke-RestMethod http://localhost:8042/tools/create-dicom -Method POST -Body ($params|ConvertTo-Json) -ContentType 'application/json' |
|
225
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
269 |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
270 # display the result |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
271 Write-Host "The instance can be retrieved in PDF at http://localhost:8042$($reply.Path)/pdf" |
|
ced9dbf86de8
Added tutorial that shows how to upload and retrieve PDF files using the REST API
Benjamin Golinvaux <bgo@osimis.io>
parents:
224
diff
changeset
|
272 |
|
226
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
273 Please note that the ``/tools/create-dicom`` API call will return the |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
274 Orthanc instance ID of the newly created DICOM resource. |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
275 |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
276 You can use the ``/instances/.../pdf`` URI to retrieve an embedded PDF |
|
eaae8d630277
proofreading of pdf
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
277 file. |
| 228 | 278 |
| 279 | |
| 596 | 280 .. _private-tags: |
| 281 | |
| 282 Creating DICOM instance with private tags | |
| 283 ----------------------------------------- | |
| 284 | |
| 285 .. highlight:: json | |
| 286 | |
| 287 The ``/tools/create-dicom`` URI can be used to create DICOM instances | |
| 288 containing private tags. Those private tags must first be defined in | |
| 289 the ``Dictionary`` configuration option of Orthanc. Importantly, the | |
| 290 ``xxxx,0010`` tag must be defined to register the private creator, | |
| 291 where ``xxxx`` is the private group of interest. Here is a sample:: | |
| 292 | |
| 293 { | |
| 294 "Dictionary" : { | |
| 295 "0405,0010" : [ "LO", "Private data element", 1, 1, "RawDataStore" ], | |
| 296 "0405,1001" : [ "ST", "XML", 1, 1, "RawDataStore" ] | |
| 297 } | |
| 298 } | |
| 299 | |
| 300 Once Orthanc is started using this configuration file, it is possible | |
| 301 to create a DICOM instance using the following POST body on | |
| 302 ``/tools/create-dicom``:: | |
| 303 | |
| 304 { | |
| 305 "PrivateCreator" : "RawDataStore", | |
| 306 "Tags" : | |
| 307 { | |
| 308 "PatientName" : "Love^Sarah", | |
| 309 "PatientID" : "7", | |
| 310 "0405,0010" : "RawDataStore", | |
| 311 "0405,1001" : "<xml><test>Testing</test></xml>" | |
| 312 } | |
| 313 } | |
| 314 | |
| 808 | 315 Rob Oakes provides more a `detailed explanation about how to use |
| 316 private tags with Orthanc | |
| 317 <https://oak-tree.tech/blog/soandor-orthanc-private-headers>`__ on | |
| 318 Oak-Tree's homepage. | |
| 228 | 319 |
| 808 | 320 |
| 228 | 321 .. _prometheus: |
| 322 | |
| 323 Instrumentation with Prometheus | |
| 324 ------------------------------- | |
| 325 | |
| 326 .. highlight:: text | |
| 327 | |
| 328 Orthanc publishes its metrics according to the `text-based format of | |
| 329 Prometheus | |
| 330 <https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format>`__ | |
| 331 (check also the `OpenMetrics project <https://openmetrics.io/>`__), onto | |
| 332 the ``/tools/metrics-prometheus`` URI of the REST API. For instance:: | |
| 333 | |
| 334 $ curl http://localhost:8042/tools/metrics-prometheus | |
| 335 orthanc_count_instances 1 1551868380543 | |
| 336 orthanc_count_patients 1 1551868380543 | |
| 337 orthanc_count_series 1 1551868380543 | |
| 338 orthanc_count_studies 1 1551868380543 | |
| 339 orthanc_disk_size_mb 0.0135002136 1551868380543 | |
| 340 orthanc_jobs_completed 1 1551868380543 | |
| 341 orthanc_jobs_failed 0 1551868380543 | |
| 342 orthanc_jobs_pending 0 1551868380543 | |
| 343 orthanc_jobs_running 0 1551868380543 | |
| 344 orthanc_jobs_success 1 1551868380543 | |
| 345 orthanc_rest_api_active_requests 1 1551868380543 | |
| 346 orthanc_rest_api_duration_ms 0 1551868094265 | |
| 347 orthanc_storage_create_duration_ms 0 1551865919315 | |
| 348 orthanc_storage_read_duration_ms 0 1551865943752 | |
| 349 orthanc_store_dicom_duration_ms 5 1551865919319 | |
| 350 orthanc_uncompressed_size_mb 0.0135002136 1551868380543 | |
| 351 | |
| 352 | |
| 353 .. highlight:: bash | |
| 354 | |
| 355 Note that the collection of metrics can be statically disabled by | |
| 356 setting the :ref:`global configuration option <configuration>` | |
| 357 ``MetricsEnabled`` to ``false``, or dynamically disabled by PUT-ing | |
| 358 ``0`` on ``/tools/metrics``:: | |
| 359 | |
| 360 $ curl http://localhost:8042/tools/metrics | |
| 361 1 | |
| 362 $ curl http://localhost:8042/tools/metrics -X PUT -d '0' | |
| 363 $ curl http://localhost:8042/tools/metrics | |
| 364 0 | |
| 365 | |
| 366 | |
| 367 .. highlight:: yaml | |
| 368 | |
| 369 Here is a sample configuration for Prometheus (in the `YAML format | |
| 370 <https://en.wikipedia.org/wiki/YAML>`__):: | |
| 371 | |
| 372 scrape_configs: | |
| 373 - job_name: 'orthanc' | |
| 374 scrape_interval: 10s | |
| 375 metrics_path: /tools/metrics-prometheus | |
| 376 basic_auth: | |
| 377 username: orthanc | |
| 378 password: orthanc | |
| 379 static_configs: | |
| 380 - targets: ['192.168.0.2:8042'] | |
| 381 | |
| 382 .. highlight:: bash | |
| 383 | |
| 384 Obviously, make sure to adapt this sample with your actual IP | |
| 385 address. Thanks to Docker, you can easily start a Prometheus server by | |
| 386 writing this configuration to, say, ``/tmp/prometheus.yml``, then | |
| 387 type:: | |
| 388 | |
|
363
9c28eeab2db6
removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
359
diff
changeset
|
389 $ sudo run -p 9090:9090 -v /tmp/prometheus.yml:/etc/prometheus/prometheus.yml --rm prom/prometheus:v2.7.0 |