Mercurial > hg > orthanc-book
changeset 839:c29ac12e3160
Orthanc-1.11.0
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Mon, 09 May 2022 13:11:36 +0200 |
| parents | 6afc236cd60a |
| children | 1262a26f96d1 |
| files | OpenAPI/orthanc-openapi.json Sphinx/source/developers/creating-plugins.rst Sphinx/source/developers/db-versioning.rst Sphinx/source/dicom-guide.rst Sphinx/source/faq/crash.rst Sphinx/source/faq/debugging.rst Sphinx/source/faq/features.rst Sphinx/source/faq/main-dicom-tags.rst Sphinx/source/faq/orthanc-storage.rst Sphinx/source/faq/scalability.rst Sphinx/source/plugins/housekeeper.rst Sphinx/source/plugins/python.rst Sphinx/source/users/advanced-rest.rst Sphinx/source/users/anonymization.rst Sphinx/source/users/configuration.rst Sphinx/source/users/debian-packages.rst Sphinx/source/users/docker.rst Sphinx/source/users/rest-cheatsheet.csv Sphinx/source/users/rest.rst |
| diffstat | 19 files changed, 453 insertions(+), 92 deletions(-) [+] |
line wrap: on
line diff
--- a/OpenAPI/orthanc-openapi.json Thu May 05 12:27:09 2022 +0200 +++ b/OpenAPI/orthanc-openapi.json Mon May 09 13:11:36 2022 +0200 @@ -2,7 +2,7 @@ "info" : { "description" : "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ)).", "title" : "Orthanc API", - "version" : "1.10.1" + "version" : "1.11.0" }, "openapi" : "3.0.0", "paths" : { @@ -183,6 +183,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -325,6 +334,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -953,9 +971,16 @@ "200" : { "content" : { "application/json" : { - "examples" : {}, - "schema" : { - "description" : "JSON object containing the information about the attachment" + "schema" : { + "description" : "JSON object containing the information about the attachment", + "example" : { + "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "CompressedSize" : 526970, + "ContentType" : 1, + "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "UncompressedSize" : 526970, + "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" + } } } }, @@ -2816,6 +2841,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -2969,7 +3003,7 @@ "/instances/{id}/reconstruct" : { "post" : { "deprecated" : false, - "description" : "Reconstruct the main DICOM tags of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", + "description" : "Reconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", "parameters" : [ { "description" : "Orthanc identifier of the instance of interest", @@ -2981,12 +3015,27 @@ } } ], - "responses" : { - "200" : { - "description" : "" - } - }, - "summary" : "Reconstruct tags of instance", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "", + "properties" : { + "ReconstructFiles" : { + "description" : "Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)", + "type" : "boolean" + } + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "" + } + }, + "summary" : "Reconstruct tags & optionally files of instance", "tags" : [ "Instances" ] } }, @@ -3121,6 +3170,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -3334,6 +3392,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -3531,9 +3598,9 @@ "schema" : { "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)", "example" : [ - "07436b2f-9d60-431a-a5c3-1aa179b747b5", - "0b6b7498-bcda-457c-95b1-c6616a7f1378", - "12aed87d-c08f-4b27-a29b-41e83ae529a8", + "3c58e15c-0f44-4f78-9ec0-f1fb7d4baadb", + "653e5b90-f9d1-45b7-94d7-f0f199e85ea5", + "6ab21b1d-739c-427f-b791-5ceaa6861943", "..." ] } @@ -4672,6 +4739,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -4747,6 +4823,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -4905,6 +4990,15 @@ "description" : "Synchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.", "parameters" : [ { + "description" : "Filename to set in the \"Content-Disposition\" HTTP header (including file extension)", + "in" : "query", + "name" : "filename", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", "in" : "query", "name" : "transcode", @@ -5509,9 +5603,16 @@ "200" : { "content" : { "application/json" : { - "examples" : {}, - "schema" : { - "description" : "JSON object containing the information about the attachment" + "schema" : { + "description" : "JSON object containing the information about the attachment", + "example" : { + "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "CompressedSize" : 526970, + "ContentType" : 1, + "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "UncompressedSize" : 526970, + "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" + } } } }, @@ -5781,6 +5882,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -6102,6 +6212,15 @@ } }, { + "description" : "Filename to set in the \"Content-Disposition\" HTTP header (including file extension)", + "in" : "query", + "name" : "filename", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", "in" : "query", "name" : "transcode", @@ -6636,7 +6755,7 @@ "/patients/{id}/reconstruct" : { "post" : { "deprecated" : false, - "description" : "Reconstruct the main DICOM tags of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", + "description" : "Reconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", "parameters" : [ { "description" : "Orthanc identifier of the patient of interest", @@ -6648,12 +6767,27 @@ } } ], - "responses" : { - "200" : { - "description" : "" - } - }, - "summary" : "Reconstruct tags of patient", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "", + "properties" : { + "ReconstructFiles" : { + "description" : "Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)", + "type" : "boolean" + } + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "" + } + }, + "summary" : "Reconstruct tags & optionally files of patient", "tags" : [ "Patients" ] } }, @@ -6672,6 +6806,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -6905,6 +7048,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -7349,6 +7501,7 @@ "indexer", "mysql-index", "mysql-storage", + "neuro", "odbc-index", "odbc-storage", "postgresql-index", @@ -8213,6 +8366,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -8288,6 +8450,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -8455,6 +8626,15 @@ "description" : "Synchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.", "parameters" : [ { + "description" : "Filename to set in the \"Content-Disposition\" HTTP header (including file extension)", + "in" : "query", + "name" : "filename", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", "in" : "query", "name" : "transcode", @@ -9059,9 +9239,16 @@ "200" : { "content" : { "application/json" : { - "examples" : {}, - "schema" : { - "description" : "JSON object containing the information about the attachment" + "schema" : { + "description" : "JSON object containing the information about the attachment", + "example" : { + "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "CompressedSize" : 526970, + "ContentType" : 1, + "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "UncompressedSize" : 526970, + "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" + } } } }, @@ -9331,6 +9518,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -9487,6 +9683,15 @@ } }, { + "description" : "Filename to set in the \"Content-Disposition\" HTTP header (including file extension)", + "in" : "query", + "name" : "filename", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", "in" : "query", "name" : "transcode", @@ -10241,6 +10446,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -10291,7 +10505,7 @@ "/series/{id}/reconstruct" : { "post" : { "deprecated" : false, - "description" : "Reconstruct the main DICOM tags of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", + "description" : "Reconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", "parameters" : [ { "description" : "Orthanc identifier of the series of interest", @@ -10303,12 +10517,27 @@ } } ], - "responses" : { - "200" : { - "description" : "" - } - }, - "summary" : "Reconstruct tags of series", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "", + "properties" : { + "ReconstructFiles" : { + "description" : "Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)", + "type" : "boolean" + } + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "" + } + }, + "summary" : "Reconstruct tags & optionally files of series", "tags" : [ "Series" ] } }, @@ -10484,6 +10713,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -10726,6 +10964,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -10801,6 +11048,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -10981,6 +11237,15 @@ "description" : "Synchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.", "parameters" : [ { + "description" : "Filename to set in the \"Content-Disposition\" HTTP header (including file extension)", + "in" : "query", + "name" : "filename", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", "in" : "query", "name" : "transcode", @@ -11585,9 +11850,16 @@ "200" : { "content" : { "application/json" : { - "examples" : {}, - "schema" : { - "description" : "JSON object containing the information about the attachment" + "schema" : { + "description" : "JSON object containing the information about the attachment", + "example" : { + "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "CompressedSize" : 526970, + "ContentType" : 1, + "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", + "UncompressedSize" : 526970, + "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" + } } } }, @@ -11857,6 +12129,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -12188,6 +12469,15 @@ } }, { + "description" : "Filename to set in the \"Content-Disposition\" HTTP header (including file extension)", + "in" : "query", + "name" : "filename", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", "in" : "query", "name" : "transcode", @@ -12914,6 +13204,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -12964,7 +13263,7 @@ "/studies/{id}/reconstruct" : { "post" : { "deprecated" : false, - "description" : "Reconstruct the main DICOM tags of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", + "description" : "Reconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.", "parameters" : [ { "description" : "Orthanc identifier of the study of interest", @@ -12976,12 +13275,27 @@ } } ], - "responses" : { - "200" : { - "description" : "" - } - }, - "summary" : "Reconstruct tags of study", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "", + "properties" : { + "ReconstructFiles" : { + "description" : "Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)", + "type" : "boolean" + } + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "" + } + }, + "summary" : "Reconstruct tags & optionally files of study", "tags" : [ "Studies" ] } }, @@ -13000,6 +13314,15 @@ } }, { + "description" : "If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return ", + "in" : "query", + "name" : "requestedTags", + "required" : false, + "schema" : { + "type" : "string" + } + }, + { "description" : "If present, report the DICOM tags in hexadecimal format", "in" : "query", "name" : "short", @@ -13395,7 +13718,7 @@ "Name" : "Orthanc Demo", "PluginsEnabled" : true, "StorageAreaPlugin" : null, - "Version" : "1.10.0" + "Version" : "1.10.1" }, "properties" : { "ApiVersion" : { @@ -13426,14 +13749,26 @@ "description" : "The port to the HTTP server of Orthanc", "type" : "number" }, + "IngestTranscoding" : { + "description" : "Whether instances are transcoded when ingested into Orthanc (`` if no transcoding is performed) (new in Orthanc 1.11.0)", + "type" : "string" + }, "IsHttpServerSecure" : { "description" : "Whether the REST API is properly secured (assuming no reverse proxy is in use): https://book.orthanc-server.com/faq/security.html#securing-the-http-server", "type" : "boolean" }, + "MainDicomTags" : { + "description" : "The list of MainDicomTags saved in DB for each resource level (new in Orthanc 1.11.0)", + "type" : "object" + }, "Name" : { "description" : "The name of the Orthanc server, cf. the `Name` configuration option", "type" : "string" }, + "OverwriteInstances" : { + "description" : "Whether instances are overwritten when re-ingested (new in Orthanc 1.11.0)", + "type" : "boolean" + }, "PluginsEnabled" : { "description" : "Whether Orthanc was built with support for plugins", "type" : "boolean" @@ -13442,6 +13777,10 @@ "description" : "Information about the installed storage area plugin (`null` if no such plugin is installed)", "type" : "string" }, + "StorageCompression" : { + "description" : "Whether storage compression is enabled (new in Orthanc 1.11.0)", + "type" : "boolean" + }, "Version" : { "description" : "Version of Orthanc", "type" : "string" @@ -13689,7 +14028,7 @@ "type" : "boolean" }, "Level" : { - "description" : "This optional argument specifies the level of interest (can be `Patient`, `Study`, `Series` or `Instance`). Orthanc will loop over the items inside `Resources`, and explorer upward or downward in the DICOM hierarchy in order to find the level of interest.", + "description" : "This optional argument specifies the level of interest (can be `Patient`, `Study`, `Series` or `Instance`). Orthanc will loop over the items inside `Resources`, and explore upward or downward in the DICOM hierarchy in order to find the level of interest.", "type" : "string" }, "Metadata" : { @@ -14336,6 +14675,13 @@ "description" : "Associative array containing the filter on the values of the DICOM tags", "type" : "object" }, + "RequestedTags" : { + "description" : "A list of DICOM tags to include in the response (applicable only if \"Expand\" is set to true). The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.", + "items" : { + "type" : "string" + }, + "type" : "array" + }, "Short" : { "description" : "If set to `true`, report the DICOM tags in hexadecimal format", "type" : "boolean" @@ -14839,7 +15185,7 @@ "200" : { "content" : { "text/plain" : { - "example" : "orthanc_count_instances 2552 1648054911276\northanc_count_patients 8 1648054911276\northanc_count_series 26 1648054911276\northanc_count_studies 8 1648054911276\northanc_dicom_cache_count 501 1647846091296\northanc_dicom_cache_size 127.931984 1647846091296\northanc_disk_size_mb 1018.65021 1648054911276\northanc_jobs_completed 10 1648054911276\northanc_jobs_failed 6 1648054911276\northanc_jobs_pending 0 1648054911276\northanc_jobs_running 0 1648054911276\northanc_jobs_success 4 1648054911276\northanc_rest_api_active_requests 1 1648054911275\northanc_rest_api_duration_ms 368 1648054907876\northanc_storage_read_duration_ms 34 1648054910360\northanc_uncompressed_size_mb 1018.65021 1648054911276\n" + "example" : "orthanc_count_instances 2552 1652090109246\northanc_count_patients 8 1652090109246\northanc_count_series 26 1652090109246\northanc_count_studies 8 1652090109246\northanc_dicom_cache_count 237 1652086829001\northanc_dicom_cache_size 127.918732 1652086829000\northanc_disk_size_mb 1018.65021 1652090109246\northanc_jobs_completed 10 1652090109246\northanc_jobs_failed 3 1652090109246\northanc_jobs_pending 0 1652090109246\northanc_jobs_running 0 1652090109246\northanc_jobs_success 7 1652090109246\northanc_rest_api_active_requests 1 1652090109245\northanc_rest_api_duration_ms 323 1652090102502\northanc_storage_read_duration_ms 0 1652090099081\northanc_uncompressed_size_mb 1018.65021 1652090109246\n" } }, "description" : "" @@ -14858,7 +15204,7 @@ "200" : { "content" : { "text/plain" : { - "example" : "20220323T170151", + "example" : "20220509T095509", "schema" : { "description" : "The UTC time" } @@ -14880,7 +15226,7 @@ "200" : { "content" : { "text/plain" : { - "example" : "20220323T170151", + "example" : "20220509T095509", "schema" : { "description" : "The local time" } @@ -14896,8 +15242,23 @@ "/tools/reconstruct" : { "post" : { "deprecated" : false, - "description" : "Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated.", + "description" : "Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource", "parameters" : [], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "", + "properties" : { + "ReconstructFiles" : { + "description" : "Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)", + "type" : "boolean" + } + } + } + } + } + }, "responses" : { "200" : { "description" : ""
--- a/Sphinx/source/developers/creating-plugins.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/developers/creating-plugins.rst Mon May 09 13:11:36 2022 +0200 @@ -15,7 +15,7 @@ Native Orthanc plugins must use the `plugin SDK <https://sdk.orthanc-server.com/>`__ whose interface is available as a `C header -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__. +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__. As a consequence, an Orthanc plugin will typically be written using C or C++, although it is also possible to create native plugins using languages that feature compatibility with C headers and with `FFI of @@ -96,7 +96,7 @@ that is part of the Orthanc source distribution: * `Plugins/Include/orthanc/OrthancCPlugin.h - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ `Online documentation <https://sdk.orthanc-server.com/>`__ for this C header is available, as generated by `Doxygen @@ -110,8 +110,8 @@ ``HAS_ORTHANC_EXCEPTION`` is set to ``0``: * `Plugins/Samples/Common/OrthanPluginCppWrapper.h - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__ * `Plugins/Samples/Common/OrthanPluginCppWrapper.cpp - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__ * `Plugins/Samples/Common/OrthanPluginException.h - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__
--- a/Sphinx/source/developers/db-versioning.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/developers/db-versioning.rst Mon May 09 13:11:36 2022 +0200 @@ -26,7 +26,7 @@ Version DB v2 DB v3 DB v4 DB v5 DB v6 =============================== ===== ===== ===== ===== ===== Mainline u u u x -Orthanc 0.9.5 - Orthanc 1.10.1 u u u x +Orthanc 0.9.5 - Orthanc 1.11.0 u u u x Orthanc 0.8.5 - Orthanc 0.9.4 u u x Orthanc 0.7.3 - Orthanc 0.8.4 u x Orthanc 0.4.0 - Orthanc 0.7.2 x
--- a/Sphinx/source/dicom-guide.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/dicom-guide.rst Mon May 09 13:11:36 2022 +0200 @@ -665,7 +665,7 @@ $ getscu -v localhost 4242 -aec ORTHANC -k "0008,0052=STUDY" -k "0020,000d=1.2.840.113543.6.6.4.7.64067529866380271256212683512383713111129" -*Note:* As of Orthanc 1.10.1, Orthanc only implements C-Get as a +*Note:* As of Orthanc 1.11.0, Orthanc only implements C-Get as a service class provider (SCP). Using C-Get as a service class user (SCU) is not currently supported in Orthanc.
--- a/Sphinx/source/faq/crash.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/faq/crash.rst Mon May 09 13:11:36 2022 +0200 @@ -64,13 +64,13 @@ above <segfault-plugin>` is available as the ``crash.cpp`` file, here is a sample debug session:: - $ wget https://lsb.orthanc-server.com/orthanc/debug/1.10.1/Orthanc + $ wget https://lsb.orthanc-server.com/orthanc/debug/1.11.0/Orthanc $ chmod +x ./Orthanc $ gcc -fPIC -shared ./crash.cpp -I ~/orthanc/Plugins/Include -o crash.so $ ulimit -c unlimited $ echo '{ "Plugins" : ["crash.so"] }' > Configuration.json $ rm -f core ; ./Orthanc Configuration.json - W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.10.1 + W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.11.0 W0427 15:43:24.215910 main.cpp:1279] Performance warning: Non-release build, runtime debug assertions are turned on W0427 15:43:24.217585 OrthancConfiguration.cpp:61] Reading the configuration from: "Configuration.json" W0427 15:43:24.254733 main.cpp:700] Loading plugin(s) from: crash.so
--- a/Sphinx/source/faq/debugging.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/faq/debugging.rst Mon May 09 13:11:36 2022 +0200 @@ -45,13 +45,13 @@ to debug Orthanc without compiling from sources. Here is a sample debug session:: - $ wget https://lsb.orthanc-server.com/orthanc/debug/1.10.1/Orthanc + $ wget https://lsb.orthanc-server.com/orthanc/debug/1.11.0/Orthanc $ chmod +x ./Orthanc $ gdb ./Orthanc Configuration.json (gdb) catch throw Catchpoint 1 (throw) (gdb) run - W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.10.1 + W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.11.0 ---> Reproduce your error case <--- Thread 15 "Orthanc" hit Catchpoint 1 (exception thrown), 0x00007ffff6de68bd in __cxa_throw () from /usr/lib/x86_64-linux-gnu/libstdc++.so.6 (gdb) backtrace
--- a/Sphinx/source/faq/features.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/faq/features.rst Mon May 09 13:11:36 2022 +0200 @@ -151,7 +151,7 @@ the instance (for REST API). * ``PixelDataOffset`` (new in Orthanc 1.9.1): Offset (in bytes) of the Pixel Data DICOM tag in the DICOM file, if available. -* ``MainDicomTagsSignature`` (new in Orthanc 1.11.0 - not released yet): +* ``MainDicomTagsSignature`` (new in Orthanc 1.11.0): The list of :ref:`MainDicomTags <main-dicom-tags>` that have been saved in DB for this resource.
--- a/Sphinx/source/faq/main-dicom-tags.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/faq/main-dicom-tags.rst Mon May 09 13:11:36 2022 +0200 @@ -78,7 +78,7 @@ .. highlight:: json -Since version 1.11.0 (not released yet), it is possible to +Since version 1.11.0, it is possible to customize a list of ``ExtraMainDicomTags`` to include in the DB through a new configuration option.
--- a/Sphinx/source/faq/orthanc-storage.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/faq/orthanc-storage.rst Mon May 09 13:11:36 2022 +0200 @@ -59,9 +59,9 @@ database schema is kept as simple as possible, and can be found in the following two files of the source code of Orthanc: `PrepareDatabase.sql -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Sources/Database/PrepareDatabase.sql>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Sources/Database/PrepareDatabase.sql>`__ and `InstallTrackAttachmentsSize.sql -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__. +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__. Direct access
--- a/Sphinx/source/faq/scalability.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/faq/scalability.rst Mon May 09 13:11:36 2022 +0200 @@ -54,7 +54,7 @@ Here is a generic setup that should provide best performance in the presence of large databases: -* Make sure to use the latest release of Orthanc (1.10.1 at the time of +* Make sure to use the latest release of Orthanc (1.11.0 at the time of writing) running on a GNU/Linux distribution. * We suggest to use the latest release of the :ref:`PostgreSQL plugin @@ -109,7 +109,7 @@ ingesting of DICOM instances, and multiple "reader" Orthanc servers with features such as DICOMweb or viewers. -* From Orthanc 1.11.0 (not released yet): you have the ability to add +* From Orthanc 1.11.0: you have the ability to add more :ref:`main DICOM tags <main-dicom-tags>` in the Orthanc Index to speed up C-Find, ``tools/find``, DICOMWeb QIDO-RS, WADO-RS and especially WADO-RS Retrieve Metadata.
--- a/Sphinx/source/plugins/housekeeper.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/plugins/housekeeper.rst Mon May 09 13:11:36 2022 +0200 @@ -1,7 +1,7 @@ .. _housekeeper-plugin: -Housekeeper plugin (not released yet) +Housekeeper plugin (new in Orthanc 1.11.0) ========================= This page describes the **official sample plugin** that performs
--- a/Sphinx/source/plugins/python.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/plugins/python.rst Mon May 09 13:11:36 2022 +0200 @@ -18,7 +18,7 @@ Python plugins have access to more features and a more consistent SDK than :ref:`Lua scripts <lua>`. The largest part of the Python API is automatically generated from the `Orthanc plugin SDK in C -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ using the `Clang <https://en.wikipedia.org/wiki/Clang>`__ compiler front-end.
--- a/Sphinx/source/users/advanced-rest.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/advanced-rest.rst Mon May 09 13:11:36 2022 +0200 @@ -130,7 +130,7 @@ ``ErrorCode`` and ``ErrorDescription`` fields for more information. * ``Paused``: The job has been paused. * ``Retry``: The job has failed internally, and has been scheduled for - re-submission after a delay. As of Orthanc 1.10.1, this feature is not + re-submission after a delay. As of Orthanc 1.11.0, this feature is not used by any type of job. In order to wait for the end of an asynchronous call, the caller will @@ -139,7 +139,7 @@ ``Failure``. Note that the `integration tests of Orthanc -<https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.10.1/Tests/Toolbox.py>`__ +<https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.11.0/Tests/Toolbox.py>`__ give an example about how to monitor a job in Python using the REST API (cf. function ``MonitorJob()``). @@ -212,7 +212,7 @@ Note how we retrieve the content of the archive by accessing the ``archive`` output of the job (check out the virtual method ``IJob::GetOutput()`` from the `source code -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__ of Orthanc). Here is the corresponding sequence of commands to generate a DICOMDIR @@ -221,7 +221,7 @@ $ curl http://localhost:8042/studies/27f7126f-4f66fb14-03f4081b-f9341db2-53925988/media -d '{"Asynchronous":true}' $ curl http://localhost:8042/jobs/6332be8a-0052-44fb-8cc2-ac959aeccad9/archive > a.zip -As of Orthanc 1.10.1, only the creation of a ZIP or a DICOMDIR archive +As of Orthanc 1.11.0, only the creation of a ZIP or a DICOMDIR archive produces such "outputs".
--- a/Sphinx/source/users/anonymization.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/anonymization.rst Mon May 09 13:11:36 2022 +0200 @@ -80,7 +80,7 @@ **Implementation:** Internally, the setup of the anonymization profiles can be found in the methods ``SetupAnonymizationXXX()`` of the class ``Orthanc::DicomModification`` (cf. `source code -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancFramework/Sources/DicomParsing/DicomModification.cpp>`__). +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancFramework/Sources/DicomParsing/DicomModification.cpp>`__). Modification of a Single Instance
--- a/Sphinx/source/users/configuration.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/configuration.rst Mon May 09 13:11:36 2022 +0200 @@ -8,7 +8,7 @@ Configuring Orthanc simply consists in providing a configuration file. Orthanc has numerous configuration that are documented in the `default configuration file -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Resources/Configuration.json>`_. This +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Resources/Configuration.json>`_. This file is in the `JSON <https://en.wikipedia.org/wiki/JSON>`_ file format. You can generate this file file with the following call::
--- a/Sphinx/source/users/debian-packages.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/debian-packages.rst Mon May 09 13:11:36 2022 +0200 @@ -106,10 +106,10 @@ This can be done with this sequence of commands:: $ sudo service orthanc stop - $ sudo wget https://lsb.orthanc-server.com/orthanc/1.10.1/Orthanc --output-document /usr/sbin/Orthanc + $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.0/Orthanc --output-document /usr/sbin/Orthanc $ sudo rm -f /usr/share/orthanc/plugins/*.so - $ sudo wget https://lsb.orthanc-server.com/orthanc/1.10.1/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so - $ sudo wget https://lsb.orthanc-server.com/orthanc/1.10.1/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so + $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.0/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so + $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.0/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so $ $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.6/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so $ ...
--- a/Sphinx/source/users/docker.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/docker.rst Mon May 09 13:11:36 2022 +0200 @@ -75,7 +75,7 @@ If more stability is required, you can select the official release of Orthanc to be run:: - $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.10.1 + $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.11.0 Passing additional command-line options (e.g. to make Orthanc verbose) can be done as follows (note the ``/etc/orthanc`` option that is @@ -97,7 +97,7 @@ Or you can also start a specific version of Orthanc for more stability:: - $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.10.1 + $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.11.0 If you have an interest in the :ref:`Python plugin <python-plugin>`, you can use the ``orthanc-python`` image. The latter image is a @@ -105,7 +105,7 @@ Python 3.7 interpreter. Here is how to start this image:: $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python - $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.10.1 + $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.11.0 Fine-tuning the configuration @@ -157,7 +157,7 @@ version: '3.1' # Secrets are only available since this version of Docker Compose services: orthanc: - image: jodogne/orthanc-plugins:1.10.1 + image: jodogne/orthanc-plugins:1.11.0 command: /run/secrets/ # Path to the configuration files (stored as secrets) ports: - 4242:4242 @@ -206,7 +206,7 @@ container to some path in the filesystem of your Linux host, e.g.:: $ mkdir /tmp/orthanc-db - $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.10.1 + $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.11.0 Whole-slide imaging support @@ -327,4 +327,4 @@ * The build artifacts can be found in folder ``/root/orthanc/Build``. * This command launches the mainline version. To start a released version, - use e.g. ``jodogne/orthanc-debug:1.10.1``. + use e.g. ``jodogne/orthanc-debug:1.11.0``.
--- a/Sphinx/source/users/rest-cheatsheet.csv Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/rest-cheatsheet.csv Mon May 09 13:11:36 2022 +0200 @@ -44,7 +44,7 @@ ``/instances/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1patient/get>`__,,,,Get parent patient ``/instances/{id}/pdf``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1pdf/get>`__,,,,Get embedded PDF ``/instances/{id}/preview``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1preview/get>`__,,,,Decode an image (preview) -``/instances/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1reconstruct/post>`__,,,Reconstruct tags of instance +``/instances/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1reconstruct/post>`__,,,Reconstruct tags & optionally files of instance ``/instances/{id}/rendered``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1rendered/get>`__,,,,Render an image ``/instances/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1series/get>`__,,,,Get parent series ``/instances/{id}/simplified-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1simplified-tags/get>`__,,,,Get human-readable tags @@ -98,7 +98,7 @@ ``/patients/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1modify/post>`__,,,Modify patient ``/patients/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1module/get>`__,,,,Get patient module ``/patients/{id}/protected``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1protected/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1protected/put>`__,Is the patient protected against recycling? -``/patients/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1reconstruct/post>`__,,,Reconstruct tags of patient +``/patients/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1reconstruct/post>`__,,,Reconstruct tags & optionally files of patient ``/patients/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1series/get>`__,,,,Get child series ``/patients/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1shared-tags/get>`__,,,,Get shared tags ``/patients/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1statistics/get>`__,,,,Get patient statistics @@ -152,7 +152,7 @@ ``/series/{id}/numpy``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1numpy/get>`__,,,,Decode series for numpy ``/series/{id}/ordered-slices``,`(get) <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1ordered-slices/get>`__,,,,*(deprecated)* Order the slices ``/series/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1patient/get>`__,,,,Get parent patient -``/series/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1reconstruct/post>`__,,,Reconstruct tags of series +``/series/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1reconstruct/post>`__,,,Reconstruct tags & optionally files of series ``/series/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1shared-tags/get>`__,,,,Get shared tags ``/series/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1statistics/get>`__,,,,Get series statistics ``/series/{id}/study``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1study/get>`__,,,,Get parent study @@ -186,7 +186,7 @@ ``/studies/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1module/get>`__,,,,Get study module ``/studies/{id}/module-patient``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1module-patient/get>`__,,,,Get patient module of study ``/studies/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1patient/get>`__,,,,Get parent patient -``/studies/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1reconstruct/post>`__,,,Reconstruct tags of study +``/studies/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1reconstruct/post>`__,,,Reconstruct tags & optionally files of study ``/studies/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1series/get>`__,,,,Get child series ``/studies/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1shared-tags/get>`__,,,,Get shared tags ``/studies/{id}/split``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1split/post>`__,,,Split study
--- a/Sphinx/source/users/rest.rst Thu May 05 12:27:09 2022 +0200 +++ b/Sphinx/source/users/rest.rst Mon May 09 13:11:36 2022 +0200 @@ -94,7 +94,7 @@ $ curl -X POST -H "Expect:" http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm The code distribution of Orthanc contains a `sample Python script -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__ that recursively upload the content of some folder into Orthanc using the REST API:: @@ -106,7 +106,7 @@ import the content of ``.zip``, ``.tar.gz`` or ``.tar.bz2`` archives without having to uncompress them first. It also provides more comprehensive command-line options. `Check this script out -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.10.1/OrthancServer/Resources/Samples/ImportDicomFiles/OrthancImport.py>`__. +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.0/OrthancServer/Resources/Samples/ImportDicomFiles/OrthancImport.py>`__. .. highlight:: perl @@ -436,7 +436,7 @@ .. highlight:: python -Starting with Orthanc 1.10.1, it is possible to immediately download +Starting with Orthanc 1.11.0, it is possible to immediately download DICOM instances and DICOM series as numpy arrays (even if they use a compressed transfer syntax). This is especially useful for the integration within AI (artificial intelligence) pipelines. Here is a @@ -1096,7 +1096,7 @@ .. highlight:: bash -Since Orthanc 1.11.0 (not released yet), you may also request a specific list of tags in the response (like in a C-FIND) even if these +Since Orthanc 1.11.0, you may also request a specific list of tags in the response (like in a C-FIND) even if these tags are not stored in the MainDicomTags or if the tags needs to be computed (like ``ModalitiesInStudy``). This ``RequestedTags`` option is available only if you specify ``"Expand": true``::