Mercurial > hg > orthanc-book
changeset 1220:04c433057467
fix spelling of Rest API as REST API
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 12 Nov 2025 13:25:21 +0100 |
| parents | edee43d6b49e |
| children | 69b41a9a2d7a |
| files | Sphinx/source/faq/db-benchmark.rst Sphinx/source/faq/debugging-encodings.rst Sphinx/source/faq/transfer-atomicity.rst Sphinx/source/plugins/authorization.rst Sphinx/source/plugins/object-storage.rst Sphinx/source/plugins/orthanc-explorer-2.rst Sphinx/source/plugins/worklists-plugin.rst Sphinx/source/users/lua.rst |
| diffstat | 8 files changed, 18 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/faq/db-benchmark.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/faq/db-benchmark.rst Wed Nov 12 13:25:21 2025 +0100 @@ -63,7 +63,7 @@ as their performance is not optimal and they currently lack the latest DB features like: * The ``ExtendedFind`` extension to perform ordering and more advanced filtering in ``/tools/find``. -* Key-Value Stores and Queues to enable some features like the Rest API +* Key-Value Stores and Queues to enable some features like the REST API of the :ref:`Worklist plugin <worklist>` or enable the :ref:`advanced storage <advanced-storage>` plugin.
--- a/Sphinx/source/faq/debugging-encodings.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/faq/debugging-encodings.rst Wed Nov 12 13:25:21 2025 +0100 @@ -11,7 +11,7 @@ -------------------------------------------------- If your DICOM files are valid, Orthanc should display all strings correctly both -in the UI and in the Rest API in which all strings are converted to UTF-8. +in the UI and in the REST API in which all strings are converted to UTF-8. However, it might still be useful to understand what's wrong with your files such that you can possibly fix your files once they have been stored in Orthanc
--- a/Sphinx/source/faq/transfer-atomicity.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/faq/transfer-atomicity.rst Wed Nov 12 13:25:21 2025 +0100 @@ -54,7 +54,7 @@ | | * If ``/dicom-web/servers/sample/stow`` returns | study in a single STOW-RS request | | | a 200 or if job is successfull | | +--------------------------------------------------+--------------------------------------------------+-----------------------------------------------+ -| **Orthanc Rest API** | * If every call to ``/instances`` receives a | No | +| **Orthanc REST API** | * If every call to ``/instances`` receives a | No | | | 200 | | | | * If ``/peers/sample/store`` receives a | | | | 200 or if job is successfull | | @@ -123,10 +123,10 @@ -Orthanc Rest API +Orthanc REST API ---------------- -When transferring a study through the Orthanc Rest API, each instance is transferred individually. +When transferring a study through the Orthanc REST API, each instance is transferred individually. Therefore, on server side, if the transfer is interrupted, the destination has no way to know that the study has been fully transmitted or not.
--- a/Sphinx/source/plugins/authorization.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/plugins/authorization.rst Wed Nov 12 13:25:21 2025 +0100 @@ -535,7 +535,7 @@ url search params when opening the Orthanc explorer, i.e. ``http://localhost:8042/app/explorer.html?token=1234``. This token will be included as an HTTP header in every request sent to the -Orthanc Rest API. It will also be included in the URL search params +Orthanc REST API. It will also be included in the URL search params when opening the Orthanc or :ref:`Osimis Web viewer <osimis_webviewer>`.
--- a/Sphinx/source/plugins/object-storage.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/plugins/object-storage.rst Wed Nov 12 13:25:21 2025 +0100 @@ -264,7 +264,7 @@ When the ``HybridMode`` is set to ``WriteToObjectStorage``, it is useful to move file from the file system to the object storage to perform a full data migration to object-storage. -To move files from one storage to the other, you should call the plugin Rest API:: +To move files from one storage to the other, you should call the plugin REST API:: $ curl -X POST http://localhost:8042/move-storage \ --data '{
--- a/Sphinx/source/plugins/orthanc-explorer-2.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/plugins/orthanc-explorer-2.rst Wed Nov 12 13:25:21 2025 +0100 @@ -105,7 +105,7 @@ Since version 0.6.0, it is possible to edit some of the DICOM Tags directly in the User Interface. :ref:`DICOM Modification <anonymization>` is quite a complex topic that is provided by Orthanc -Rest API. The Orthanc Explorer 2 User Interface aims at simplifying its use but is also limiting +REST API. The Orthanc Explorer 2 User Interface aims at simplifying its use but is also limiting it to common use cases mainly related to correcting errors in Patient and Study DICOM Tags. At study level, it is possible to:
--- a/Sphinx/source/plugins/worklists-plugin.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/plugins/worklists-plugin.rst Wed Nov 12 13:25:21 2025 +0100 @@ -70,9 +70,9 @@ // New options in v 1.12.10 "SaveInOrthancDatabase": false, // If set to true and if the Orthanc Database supports Key-Value stores - // (PostgreSQL or SQLite), the worklists must be created through the Rest API + // (PostgreSQL or SQLite), the worklists must be created through the REST API // and are stored in the Orthanc DB (new in v 1.12.10) - "SetStudyInstanceUidIfMissing": true, // Add a StudyInstanceUID to the worklist if none is provided in the Rest API call to create it + "SetStudyInstanceUidIfMissing": true, // Add a StudyInstanceUID to the worklist if none is provided in the REST API call to create it "DeleteWorklistsOnStableStudy": true, // Delete the worklist as soon as a a stable study is found with the StudyInstanceUID // provided in the worklist. // Note that this check is performed in the Worklist Housekeeper thread. The plugin @@ -85,7 +85,7 @@ "DeleteWorklistsDelay": 24 // Delay [in hours] after which the worklist is deleted. // Note that this check is performed in the Worklist Housekeeper thread. - // The plugin only deletes worklists that have been created through the Rest API. + // The plugin only deletes worklists that have been created through the REST API. // Set it to 0 if you don't want the plugin to delete worklists after a delay. } } @@ -156,12 +156,12 @@ - ``findscu`` will display the matching worklists. -How to create a worklist file using the Rest API - new in 1.12.10 +How to create a worklist file using the REST API - new in 1.12.10 ----------------------------------------------------------------- .. highlight:: bash -Starting from Orthanc 1.12.10, the plugin provides a Rest API that can be +Starting from Orthanc 1.12.10, the plugin provides a REST API that can be used to create worklists. For example:: $ curl --request POST http://localhost:8042/worklists/create \
--- a/Sphinx/source/users/lua.rst Wed Nov 12 13:21:11 2025 +0100 +++ b/Sphinx/source/users/lua.rst Wed Nov 12 13:25:21 2025 +0100 @@ -164,19 +164,19 @@ kind of concurrency but may also lead to some deadlocks. If a lua function (e.g. ``OnHeartBeat``) performs an HTTP call to an -external Rest API (e.g. ``http://myserver.com/orthanc_is_alive.php``) -which, in turn, calls the Orthanc Rest API (e.g. call ``http://orthanc:8042/system``), +external REST API (e.g. ``http://myserver.com/orthanc_is_alive.php``) +which, in turn, calls the Orthanc REST API (e.g. call ``http://orthanc:8042/system``), odds are high that you meet a deadlock because Orthanc, when handling a -Rest API calls, may try to execute some Lua callbacks (e.g. ``IncomingHttpRequestFilter``) +REST API calls, may try to execute some Lua callbacks (e.g. ``IncomingHttpRequestFilter``) while the Lua context is still blocked inside the ``OnHeartBeat`` function. To avoid deadlocks, always make sure to avoid such back-and-forth communications or make sure they happen asynchronously: your webservice should call the -Orthanc Rest API after it has returned from the endpoint called by +Orthanc REST API after it has returned from the endpoint called by ``OnHeartBeat``. Note that these deadlocks won't happen when a lua function calls its own -Orthanc Rest API using the ``RestApiGet``, ``RestApiPost``, ... functions. +Orthanc REST API using the ``RestApiGet``, ``RestApiPost``, ... functions. .. _lua-rest: