Mercurial > hg > orthanc-book

comparison OpenAPI/orthanc-openapi.json @ 1000:2e103fb1fa11

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Orthanc 1.12.2
author Alain Mazy <am@osimis.io>
date Tue, 19 Dec 2023 17:54:15 +0100
parents a6bf749b3c04
children a3436ae3709c
comparison
equal deleted inserted replaced
998:bd7fbe3042f7 1000:2e103fb1fa11
1 { 1 {
2 "info" : { 2 "info" : {
3 "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)).", 3 "description" : "This is the full documentation of the [REST API](https://orthanc.uclouvain.be/book/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://orthanc.uclouvain.be/book/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)).",
4 "title" : "Orthanc API", 4 "title" : "Orthanc API",
5 "version" : "1.12.1" 5 "version" : "1.12.2"
6 }, 6 },
7 "openapi" : "3.0.0", 7 "openapi" : "3.0.0",
8 "paths" : { 8 "paths" : {
9 "/changes" : { 9 "/changes" : {
10 "delete" : { 10 "delete" : {
50 "description" : "The list of changes", 50 "description" : "The list of changes",
51 "example" : { 51 "example" : {
52 "Changes" : [ 52 "Changes" : [
53 { 53 {
54 "ChangeType" : "NewInstance", 54 "ChangeType" : "NewInstance",
55 "Date" : "20180414T091510", 55 "Date" : "20231109T160739",
56 "ID" : "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", 56 "ID" : "26d2e33b-3239a2d5-64f57e0b-d8da59a7-2ef362e7",
57 "Path" : "/instances/055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", 57 "Path" : "/instances/26d2e33b-3239a2d5-64f57e0b-d8da59a7-2ef362e7",
58 "ResourceType" : "Instance", 58 "ResourceType" : "Instance",
59 "Seq" : 1 59 "Seq" : 1
60 }, 60 },
61 { 61 {
62 "ChangeType" : "NewSeries", 62 "ChangeType" : "NewSeries",
63 "Date" : "20180414T091510", 63 "Date" : "20231109T160739",
64 "ID" : "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb", 64 "ID" : "1de00990-03680ef4-0be6bd5b-73a7d350-fb46abfa",
65 "Path" : "/series/318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb", 65 "Path" : "/series/1de00990-03680ef4-0be6bd5b-73a7d350-fb46abfa",
66 "ResourceType" : "Series", 66 "ResourceType" : "Series",
67 "Seq" : 2 67 "Seq" : 2
68 } 68 }
69 ], 69 ],
70 "Done" : false, 70 "Done" : false,
215 "content" : { 215 "content" : {
216 "application/json" : { 216 "application/json" : {
217 "schema" : { 217 "schema" : {
218 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if `expand` argument is provided)", 218 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if `expand` argument is provided)",
219 "example" : [ 219 "example" : [
220 "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000", 220 "26d2e33b-3239a2d5-64f57e0b-d8da59a7-2ef362e7",
221 "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8" 221 "1a0ac939-976cc50b-21c0f6ab-80200f03-c3b813be"
222 ] 222 ]
223 } 223 }
224 } 224 }
225 }, 225 },
226 "description" : "" 226 "description" : ""
366 "content" : { 366 "content" : {
367 "application/json" : { 367 "application/json" : {
368 "schema" : { 368 "schema" : {
369 "description" : "Information about the DICOM instance", 369 "description" : "Information about the DICOM instance",
370 "example" : { 370 "example" : {
371 "FileSize" : 526744, 371 "FileSize" : 368852,
372 "FileUuid" : "dc031d9e-ef02-4871-821f-ffe445deb7c2", 372 "FileUuid" : "eec5367e-b460-475c-a808-75343dbf9136",
373 "ID" : "d94d9a03-3003b047-a4affc69-322313b2-680530a2", 373 "ID" : "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f",
374 "IndexInSeries" : 155, 374 "IndexInSeries" : 1,
375 "Labels" : [], 375 "Labels" : [],
376 "MainDicomTags" : { 376 "MainDicomTags" : {
377 "AcquisitionNumber" : "4", 377 "ImageOrientationPatient" : "0\\1\\0\\0\\0\\-1",
378 "ImageOrientationPatient" : "1\\0\\0\\0\\1\\0", 378 "ImagePositionPatient" : "0\\-159\\-425.915649",
379 "ImagePositionPatient" : "-249.51171875\\-458.51171875\\314", 379 "InstanceCreationDate" : "20050927",
380 "InstanceCreationDate" : "20151217", 380 "InstanceCreationTime" : "155030.000000",
381 "InstanceCreationTime" : "125204.215000", 381 "InstanceNumber" : "1",
382 "InstanceNumber" : "155", 382 "SOPInstanceUID" : "1.2.840.113704.7.1.1.6632.1127829031.2"
383 "SOPInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.168997935789297163075628247666" 383 },
384 }, 384 "ParentSeries" : "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
385 "ParentSeries" : "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2",
386 "Type" : "Instance" 385 "Type" : "Instance"
387 } 386 }
388 } 387 }
389 } 388 }
390 }, 389 },
396 } 395 }
397 }, 396 },
398 "/instances/{id}/anonymize" : { 397 "/instances/{id}/anonymize" : {
399 "post" : { 398 "post" : {
400 "deprecated" : false, 399 "deprecated" : false,
401 "description" : "Download an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#anonymization-of-a-single-instance", 400 "description" : "Download an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-a-single-instance",
402 "parameters" : [ 401 "parameters" : [
403 { 402 {
404 "description" : "Orthanc identifier of the instance of interest", 403 "description" : "Orthanc identifier of the instance of interest",
405 "in" : "path", 404 "in" : "path",
406 "name" : "id", 405 "name" : "id",
453 "Replace" : { 452 "Replace" : {
454 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).", 453 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).",
455 "type" : "object" 454 "type" : "object"
456 }, 455 },
457 "Transcode" : { 456 "Transcode" : {
458 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 457 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
459 "type" : "string" 458 "type" : "string"
460 } 459 }
461 } 460 }
462 } 461 }
463 } 462 }
508 "200" : { 507 "200" : {
509 "content" : { 508 "content" : {
510 "application/json" : { 509 "application/json" : {
511 "schema" : { 510 "schema" : {
512 "description" : "JSON array containing the names of the attachments", 511 "description" : "JSON array containing the names of the attachments",
513 "example" : [ "dicom", "dicom-as-json" ] 512 "example" : [ "dicom" ]
514 } 513 }
515 } 514 }
516 }, 515 },
517 "description" : "" 516 "description" : ""
518 } 517 }
982 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 981 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
983 "CompressedSize" : 526970, 982 "CompressedSize" : 526970,
984 "ContentType" : 1, 983 "ContentType" : 1,
985 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 984 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
986 "UncompressedSize" : 526970, 985 "UncompressedSize" : 526970,
987 "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" 986 "Uuid" : "ada05909-0efc-43fd-b615-c5cafbaeacf8"
988 } 987 }
989 } 988 }
990 } 989 }
991 }, 990 },
992 "description" : "", 991 "description" : "",
1238 }, 1237 },
1239 "summary" : "Verify attachment", 1238 "summary" : "Verify attachment",
1240 "tags" : [ "Instances" ] 1239 "tags" : [ "Instances" ]
1241 } 1240 }
1242 }, 1241 },
1243 "/instances/{id}/content" : { 1242 "/instances/{id}/content/{path}" : {
1244 "get" : { 1243 "get" : {
1245 "deprecated" : false, 1244 "deprecated" : false,
1246 "description" : "Get the raw content of one DICOM tag in the hierarchy of DICOM dataset", 1245 "description" : "Get the raw content of one DICOM tag in the hierarchy of DICOM dataset",
1247 "parameters" : [ 1246 "parameters" : [
1248 { 1247 {
1248 "description" : "Orthanc identifier of the DICOM instance of interest",
1249 "in" : "path",
1250 "name" : "id",
1251 "required" : true,
1252 "schema" : {
1253 "type" : "string"
1254 }
1255 },
1256 {
1249 "description" : "Path to the DICOM tag. This is the interleaving of one DICOM tag, possibly followed by an index for sequences. Sequences are accessible as, for instance, `/0008-1140/1/0008-1150`", 1257 "description" : "Path to the DICOM tag. This is the interleaving of one DICOM tag, possibly followed by an index for sequences. Sequences are accessible as, for instance, `/0008-1140/1/0008-1150`",
1250 "in" : "path", 1258 "in" : "path",
1251 "name" : "...", 1259 "name" : "path",
1252 "required" : true,
1253 "schema" : {
1254 "type" : "string"
1255 }
1256 },
1257 {
1258 "description" : "Orthanc identifier of the DICOM instance of interest",
1259 "in" : "path",
1260 "name" : "id",
1261 "required" : true, 1260 "required" : true,
1262 "schema" : { 1261 "schema" : {
1263 "type" : "string" 1262 "type" : "string"
1264 } 1263 }
1265 } 1264 }
1317 "/instances/{id}/file" : { 1316 "/instances/{id}/file" : {
1318 "get" : { 1317 "get" : {
1319 "deprecated" : false, 1318 "deprecated" : false,
1320 "description" : "Download one DICOM instance", 1319 "description" : "Download one DICOM instance",
1321 "parameters" : [ 1320 "parameters" : [
1321 {
1322 "description" : "If present, the DICOM file will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
1323 "in" : "query",
1324 "name" : "transcode",
1325 "required" : false,
1326 "schema" : {
1327 "type" : "string"
1328 }
1329 },
1322 { 1330 {
1323 "description" : "This HTTP header can be set to retrieve the DICOM instance in DICOMweb format", 1331 "description" : "This HTTP header can be set to retrieve the DICOM instance in DICOMweb format",
1324 "in" : "header", 1332 "in" : "header",
1325 "name" : "Accept", 1333 "name" : "Accept",
1326 "required" : false, 1334 "required" : false,
1691 } 1699 }
1692 }, 1700 },
1693 "/instances/{id}/frames/{frame}/matlab" : { 1701 "/instances/{id}/frames/{frame}/matlab" : {
1694 "get" : { 1702 "get" : {
1695 "deprecated" : false, 1703 "deprecated" : false,
1696 "description" : "Decode one frame of interest from the given DICOM instance, and export this frame as a Octave/Matlab matrix to be imported with `eval()`: https://book.orthanc-server.com/faq/matlab.html", 1704 "description" : "Decode one frame of interest from the given DICOM instance, and export this frame as a Octave/Matlab matrix to be imported with `eval()`: https://orthanc.uclouvain.be/book/faq/matlab.html",
1697 "parameters" : [ 1705 "parameters" : [
1698 { 1706 {
1699 "description" : "Index of the frame (starts at `0`)", 1707 "description" : "Index of the frame (starts at `0`)",
1700 "in" : "path", 1708 "in" : "path",
1701 "name" : "frame", 1709 "name" : "frame",
2512 } 2520 }
2513 }, 2521 },
2514 "/instances/{id}/matlab" : { 2522 "/instances/{id}/matlab" : {
2515 "get" : { 2523 "get" : {
2516 "deprecated" : false, 2524 "deprecated" : false,
2517 "description" : "Decode the first frame of the given DICOM instance., and export this frame as a Octave/Matlab matrix to be imported with `eval()`: https://book.orthanc-server.com/faq/matlab.html", 2525 "description" : "Decode the first frame of the given DICOM instance., and export this frame as a Octave/Matlab matrix to be imported with `eval()`: https://orthanc.uclouvain.be/book/faq/matlab.html",
2518 "parameters" : [ 2526 "parameters" : [
2519 { 2527 {
2520 "description" : "Orthanc identifier of the DICOM instance of interest", 2528 "description" : "Orthanc identifier of the DICOM instance of interest",
2521 "in" : "path", 2529 "in" : "path",
2522 "name" : "id", 2530 "name" : "id",
2590 "TransferSyntax", 2598 "TransferSyntax",
2591 "SopClassUid", 2599 "SopClassUid",
2592 "RemoteIP", 2600 "RemoteIP",
2593 "HttpUsername", 2601 "HttpUsername",
2594 "PixelDataOffset", 2602 "PixelDataOffset",
2603 "MainDicomTagsSignature",
2595 "4202" 2604 "4202"
2596 ] 2605 ]
2597 } 2606 }
2598 } 2607 }
2599 }, 2608 },
2749 } 2758 }
2750 }, 2759 },
2751 "/instances/{id}/modify" : { 2760 "/instances/{id}/modify" : {
2752 "post" : { 2761 "post" : {
2753 "deprecated" : false, 2762 "deprecated" : false,
2754 "description" : "Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#modification-of-a-single-instance", 2763 "description" : "Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-a-single-instance",
2755 "parameters" : [ 2764 "parameters" : [
2756 { 2765 {
2757 "description" : "Orthanc identifier of the instance of interest", 2766 "description" : "Orthanc identifier of the instance of interest",
2758 "in" : "path", 2767 "in" : "path",
2759 "name" : "id", 2768 "name" : "id",
2802 "Replace" : { 2811 "Replace" : {
2803 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).", 2812 "description" : "Associative array to change the value of some DICOM tags in the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).",
2804 "type" : "object" 2813 "type" : "object"
2805 }, 2814 },
2806 "Transcode" : { 2815 "Transcode" : {
2807 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 2816 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
2808 "type" : "string" 2817 "type" : "string"
2809 } 2818 }
2810 } 2819 }
2811 } 2820 }
2812 } 2821 }
2882 "description" : "Information about the DICOM instance", 2891 "description" : "Information about the DICOM instance",
2883 "example" : { 2892 "example" : {
2884 "0008,0005" : { 2893 "0008,0005" : {
2885 "Name" : "SpecificCharacterSet", 2894 "Name" : "SpecificCharacterSet",
2886 "Type" : "String", 2895 "Type" : "String",
2887 "Value" : "ISO_IR 192" 2896 "Value" : "ISO_IR 100"
2888 }, 2897 },
2889 "0008,0012" : { 2898 "0008,0012" : {
2890 "Name" : "InstanceCreationDate", 2899 "Name" : "InstanceCreationDate",
2891 "Type" : "String", 2900 "Type" : "String",
2892 "Value" : "20151217" 2901 "Value" : "20050927"
2893 }, 2902 },
2894 "0008,0013" : { 2903 "0008,0013" : {
2895 "Name" : "InstanceCreationTime", 2904 "Name" : "InstanceCreationTime",
2896 "Type" : "String", 2905 "Type" : "String",
2897 "Value" : "125204.215000" 2906 "Value" : "155030.000000"
2898 }, 2907 },
2899 "0008,0016" : { 2908 "0008,0016" : {
2900 "Name" : "SOPClassUID", 2909 "Name" : "SOPClassUID",
2901 "Type" : "String", 2910 "Type" : "String",
2902 "Value" : "1.2.840.10008.5.1.4.1.1.2" 2911 "Value" : "1.2.840.10008.5.1.4.1.1.2"
2903 }, 2912 },
2904 "0008,0018" : { 2913 "0008,0018" : {
2905 "Name" : "SOPInstanceUID", 2914 "Name" : "SOPInstanceUID",
2906 "Type" : "String", 2915 "Type" : "String",
2907 "Value" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.168997935789297163075628247666" 2916 "Value" : "1.2.840.113704.7.1.1.6632.1127829031.2"
2908 }, 2917 },
2909 "0020,0013" : { 2918 "0020,0013" : {
2910 "Name" : "InstanceNumber", 2919 "Name" : "InstanceNumber",
2911 "Type" : "String", 2920 "Type" : "String",
2912 "Value" : "155" 2921 "Value" : "1"
2913 },
2914 "0028,0303" : {
2915 "Name" : "LongitudinalTemporalInformationModified",
2916 "Type" : "String",
2917 "Value" : "MODIFIED"
2918 } 2922 }
2919 } 2923 }
2920 } 2924 }
2921 } 2925 }
2922 }, 2926 },
3024 "content" : { 3028 "content" : {
3025 "application/json" : { 3029 "application/json" : {
3026 "schema" : { 3030 "schema" : {
3027 "description" : "Information about the parent DICOM patient", 3031 "description" : "Information about the parent DICOM patient",
3028 "example" : { 3032 "example" : {
3029 "ID" : "65ce8003-696b2eb6-03adeee7-6561ce8e-3e03f13a", 3033 "ID" : "2f74083e-9b042648-10edac14-b26950f8-f82ec3a0",
3030 "IsStable" : true, 3034 "IsStable" : true,
3031 "Labels" : [], 3035 "Labels" : [],
3032 "LastUpdate" : "20200803T131236", 3036 "LastUpdate" : "20231109T160911",
3033 "MainDicomTags" : { 3037 "MainDicomTags" : {
3034 "PatientBirthDate" : "", 3038 "PatientBirthDate" : "19910101",
3035 "PatientID" : "HN_P001", 3039 "PatientID" : "Vafk,T,6",
3036 "PatientName" : "HN_P001", 3040 "PatientName" : "PHENIX",
3037 "PatientSex" : "M" 3041 "PatientSex" : ""
3038 }, 3042 },
3039 "Studies" : [ "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b" ], 3043 "Studies" : [ "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a" ],
3040 "Type" : "Patient" 3044 "Type" : "Patient"
3041 } 3045 }
3042 } 3046 }
3043 } 3047 }
3044 }, 3048 },
3355 "application/json" : { 3359 "application/json" : {
3356 "schema" : { 3360 "schema" : {
3357 "description" : "Information about the parent DICOM series", 3361 "description" : "Information about the parent DICOM series",
3358 "example" : { 3362 "example" : {
3359 "ExpectedNumberOfInstances" : null, 3363 "ExpectedNumberOfInstances" : null,
3360 "ID" : "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2", 3364 "ID" : "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
3361 "Instances" : [ 3365 "Instances" : [ "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f" ],
3362 "ccc7cee2-81566098-5531d590-57b3c148-1787d177",
3363 "af464afa-bf0c7970-02a3c666-337a8df8-1d955e27",
3364 "42616941-88cbd2a7-f30ceecb-3f53b658-c641372c",
3365 "1470f579-11b80cb9-ecf22279-041175d9-d8f3c3ef",
3366 "373622cf-43a0259b-ebf55c2a-02e5ef32-1a3115f0",
3367 "72b68848-9729ad79-e8762db4-50d97dd3-f3591322",
3368 "73e2f25f-aa47b7ba-5d1c6e7b-91b98261-a195316e",
3369 "c22831de-6ddaa06c-1f877da5-400a8f03-83668321",
3370 "0c322d30-98af6f31-0bd59c19-99e07f68-317aeb3b",
3371 "dd69d888-f3065dac-a47c947c-1aed47c8-fc181d11",
3372 "..."
3373 ],
3374 "IsStable" : true, 3366 "IsStable" : true,
3375 "Labels" : [], 3367 "Labels" : [],
3376 "LastUpdate" : "20200803T131236", 3368 "LastUpdate" : "20231109T160851",
3377 "MainDicomTags" : { 3369 "MainDicomTags" : {
3378 "BodyPartExamined" : "CHEST", 3370 "ImageOrientationPatient" : "0\\1\\0\\0\\0\\-1",
3379 "ImageOrientationPatient" : "1\\0\\0\\0\\1\\0", 3371 "Manufacturer" : "Philips",
3380 "Manufacturer" : "SIEMENS",
3381 "Modality" : "CT", 3372 "Modality" : "CT",
3382 "SeriesDate" : "20091022", 3373 "PerformedProcedureStepDescription" : "CT2 tête, face, sinus",
3383 "SeriesDescription" : "HEAD/NECK 2.0 B30s", 3374 "ProtocolName" : "COU 2 mm/Neck/Sv",
3384 "SeriesInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.215111709746721743805035350686", 3375 "SeriesInstanceUID" : "1.2.840.113704.1.111.5692.1127828999.2",
3385 "SeriesNumber" : "4", 3376 "SeriesNumber" : "2276",
3386 "SeriesTime" : "173151.203000" 3377 "StationName" : "ctrad"
3387 }, 3378 },
3388 "ParentStudy" : "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b", 3379 "ParentStudy" : "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a",
3389 "Status" : "Unknown", 3380 "Status" : "Unknown",
3390 "Type" : "Series" 3381 "Type" : "Series"
3391 } 3382 }
3392 } 3383 }
3393 } 3384 }
3475 "content" : { 3466 "content" : {
3476 "application/json" : { 3467 "application/json" : {
3477 "schema" : { 3468 "schema" : {
3478 "description" : "", 3469 "description" : "",
3479 "example" : { 3470 "example" : {
3480 "DicomDiskSize" : "526744", 3471 "DicomDiskSize" : "368852",
3481 "DicomDiskSizeMB" : 0, 3472 "DicomDiskSizeMB" : 0,
3482 "DicomUncompressedSize" : "526744", 3473 "DicomUncompressedSize" : "368852",
3483 "DicomUncompressedSizeMB" : 0, 3474 "DicomUncompressedSizeMB" : 0,
3484 "DiskSize" : "539420", 3475 "DiskSize" : "368852",
3485 "DiskSizeMB" : 0, 3476 "DiskSizeMB" : 0,
3486 "UncompressedSize" : "539420", 3477 "UncompressedSize" : "368852",
3487 "UncompressedSizeMB" : 0 3478 "UncompressedSizeMB" : 0
3488 }, 3479 },
3489 "properties" : { 3480 "properties" : {
3490 "DicomDiskSize" : { 3481 "DicomDiskSize" : {
3491 "description" : "Size on the disk of the DICOM instances associated with the instance, expressed in bytes", 3482 "description" : "Size on the disk of the DICOM instances associated with the instance, expressed in bytes",
3577 "content" : { 3568 "content" : {
3578 "application/json" : { 3569 "application/json" : {
3579 "schema" : { 3570 "schema" : {
3580 "description" : "Information about the parent DICOM study", 3571 "description" : "Information about the parent DICOM study",
3581 "example" : { 3572 "example" : {
3582 "ID" : "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b", 3573 "ID" : "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a",
3583 "IsStable" : true, 3574 "IsStable" : true,
3584 "Labels" : [], 3575 "Labels" : [],
3585 "LastUpdate" : "20200803T131236", 3576 "LastUpdate" : "20231109T160911",
3586 "MainDicomTags" : { 3577 "MainDicomTags" : {
3587 "AccessionNumber" : "2819497684894126", 3578 "AccessionNumber" : "A10011234814",
3588 "ReferringPhysicianName" : "", 3579 "InstitutionName" : "HUG",
3589 "StudyDate" : "20091022", 3580 "ReferringPhysicianName" : "CHIR-PED^CHIR-PE",
3590 "StudyDescription" : "RT^HEAD_NECK (Adult)", 3581 "RequestedProcedureDescription" : "CT2 TÊTE, FACE, SINUS",
3591 "StudyID" : "", 3582 "RequestingPhysician" : "KOHLER^Romain",
3592 "StudyInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.2193.7172.847236098565581057121195872945", 3583 "StudyDate" : "20050927",
3593 "StudyTime" : "172721.327000" 3584 "StudyDescription" : "CT2 tête, face, sinus",
3594 }, 3585 "StudyID" : "1361",
3595 "ParentPatient" : "65ce8003-696b2eb6-03adeee7-6561ce8e-3e03f13a", 3586 "StudyInstanceUID" : "2.16.840.1.113669.632.20.1211.10000098591",
3587 "StudyTime" : "154952.000000"
3588 },
3589 "ParentPatient" : "2f74083e-9b042648-10edac14-b26950f8-f82ec3a0",
3596 "PatientMainDicomTags" : { 3590 "PatientMainDicomTags" : {
3597 "PatientBirthDate" : "", 3591 "PatientBirthDate" : "19910101",
3598 "PatientID" : "HN_P001", 3592 "PatientID" : "Vafk,T,6",
3599 "PatientName" : "HN_P001", 3593 "PatientName" : "PHENIX",
3600 "PatientSex" : "M" 3594 "PatientSex" : ""
3601 }, 3595 },
3602 "Series" : [ 3596 "Series" : [
3603 "9c7031b2-97909802-c35563e6-168bf0af-5cfbdce4", 3597 "7696013f-4c89c563-2b071693-5d1f97f6-f8ab232d",
3604 "1d9c4560-6480f3d9-0a4d3654-65715f38-755ad2e0", 3598 "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
3605 "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2" 3599 "17cc7e52-4f1a3e4d-9182f727-56e9cc71-c037892f"
3606 ], 3600 ],
3607 "Type" : "Study" 3601 "Type" : "Study"
3608 } 3602 }
3609 } 3603 }
3610 } 3604 }
3750 "content" : { 3744 "content" : {
3751 "application/json" : { 3745 "application/json" : {
3752 "schema" : { 3746 "schema" : {
3753 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)", 3747 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)",
3754 "example" : [ 3748 "example" : [
3755 "0d9e3061-0ec4-49ff-966b-7f0dc99ad6e6", 3749 "0b584e01-3aba-4b18-a428-fce60430f8b8",
3756 "46fd1fe1-84d4-4dcd-b386-d48f320e98e3", 3750 "35e9ad9d-1169-4154-b8b1-4c8e0303aa78",
3757 "723a96f3-b473-45c4-bc49-00e54c1734ca", 3751 "384de7a4-3be1-4fb9-992a-62e6209969c2",
3758 "..." 3752 "..."
3759 ] 3753 ]
3760 } 3754 }
3761 } 3755 }
3762 }, 3756 },
3766 "summary" : "List jobs", 3760 "summary" : "List jobs",
3767 "tags" : [ "Jobs" ] 3761 "tags" : [ "Jobs" ]
3768 } 3762 }
3769 }, 3763 },
3770 "/jobs/{id}" : { 3764 "/jobs/{id}" : {
3771 "get" : { 3765 "delete" : {
3772 "deprecated" : false, 3766 "deprecated" : false,
3773 "description" : "Retrieve detailed information about the job whose identifier is provided in the URL: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 3767 "description" : "Delete the job from the jobs history. Only a completed job can be deleted. If the job has not run or not completed yet, you must cancel it first. If the job has outputs, all outputs will be deleted as well. ",
3768 "parameters" : [
3769 {
3770 "description" : "Identifier of the job of interest",
3771 "in" : "path",
3772 "name" : "id",
3773 "required" : true,
3774 "schema" : {
3775 "type" : "string"
3776 }
3777 }
3778 ],
3779 "responses" : {
3780 "200" : {
3781 "description" : ""
3782 }
3783 },
3784 "summary" : "Delete a job from history",
3785 "tags" : [ "Jobs" ]
3786 },
3787 "get" : {
3788 "deprecated" : false,
3789 "description" : "Retrieve detailed information about the job whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
3774 "parameters" : [ 3790 "parameters" : [
3775 { 3791 {
3776 "description" : "Identifier of the job of interest", 3792 "description" : "Identifier of the job of interest",
3777 "in" : "path", 3793 "in" : "path",
3778 "name" : "id", 3794 "name" : "id",
3818 } 3834 }
3819 }, 3835 },
3820 "/jobs/{id}/cancel" : { 3836 "/jobs/{id}/cancel" : {
3821 "post" : { 3837 "post" : {
3822 "deprecated" : false, 3838 "deprecated" : false,
3823 "description" : "Cancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 3839 "description" : "Cancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
3824 "parameters" : [ 3840 "parameters" : [
3825 { 3841 {
3826 "description" : "Identifier of the job of interest", 3842 "description" : "Identifier of the job of interest",
3827 "in" : "path", 3843 "in" : "path",
3828 "name" : "id", 3844 "name" : "id",
3850 } 3866 }
3851 }, 3867 },
3852 "/jobs/{id}/pause" : { 3868 "/jobs/{id}/pause" : {
3853 "post" : { 3869 "post" : {
3854 "deprecated" : false, 3870 "deprecated" : false,
3855 "description" : "Pause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 3871 "description" : "Pause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
3856 "parameters" : [ 3872 "parameters" : [
3857 { 3873 {
3858 "description" : "Identifier of the job of interest", 3874 "description" : "Identifier of the job of interest",
3859 "in" : "path", 3875 "in" : "path",
3860 "name" : "id", 3876 "name" : "id",
3882 } 3898 }
3883 }, 3899 },
3884 "/jobs/{id}/resubmit" : { 3900 "/jobs/{id}/resubmit" : {
3885 "post" : { 3901 "post" : {
3886 "deprecated" : false, 3902 "deprecated" : false,
3887 "description" : "Resubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 3903 "description" : "Resubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
3888 "parameters" : [ 3904 "parameters" : [
3889 { 3905 {
3890 "description" : "Identifier of the job of interest", 3906 "description" : "Identifier of the job of interest",
3891 "in" : "path", 3907 "in" : "path",
3892 "name" : "id", 3908 "name" : "id",
3914 } 3930 }
3915 }, 3931 },
3916 "/jobs/{id}/resume" : { 3932 "/jobs/{id}/resume" : {
3917 "post" : { 3933 "post" : {
3918 "deprecated" : false, 3934 "deprecated" : false,
3919 "description" : "Resume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 3935 "description" : "Resume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
3920 "parameters" : [ 3936 "parameters" : [
3921 { 3937 {
3922 "description" : "Identifier of the job of interest", 3938 "description" : "Identifier of the job of interest",
3923 "in" : "path", 3939 "in" : "path",
3924 "name" : "id", 3940 "name" : "id",
4235 } 4251 }
4236 }, 4252 },
4237 "/modalities/{id}/echo" : { 4253 "/modalities/{id}/echo" : {
4238 "post" : { 4254 "post" : {
4239 "deprecated" : false, 4255 "deprecated" : false,
4240 "description" : "Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-c-echo", 4256 "description" : "Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo",
4241 "parameters" : [ 4257 "parameters" : [
4242 { 4258 {
4243 "description" : "Identifier of the modality of interest", 4259 "description" : "Identifier of the modality of interest",
4244 "in" : "path", 4260 "in" : "path",
4245 "name" : "id", 4261 "name" : "id",
4538 } 4554 }
4539 }, 4555 },
4540 "/modalities/{id}/move" : { 4556 "/modalities/{id}/move" : {
4541 "post" : { 4557 "post" : {
4542 "deprecated" : false, 4558 "deprecated" : false,
4543 "description" : "Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-c-move", 4559 "description" : "Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-c-move",
4544 "parameters" : [ 4560 "parameters" : [
4545 { 4561 {
4546 "description" : "Identifier of the modality of interest", 4562 "description" : "Identifier of the modality of interest",
4547 "in" : "path", 4563 "in" : "path",
4548 "name" : "id", 4564 "name" : "id",
4630 } 4646 }
4631 }, 4647 },
4632 "/modalities/{id}/query" : { 4648 "/modalities/{id}/query" : {
4633 "post" : { 4649 "post" : {
4634 "deprecated" : false, 4650 "deprecated" : false,
4635 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest", 4651 "description" : "Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest",
4636 "parameters" : [ 4652 "parameters" : [
4637 { 4653 {
4638 "description" : "Identifier of the modality of interest", 4654 "description" : "Identifier of the modality of interest",
4639 "in" : "path", 4655 "in" : "path",
4640 "name" : "id", 4656 "name" : "id",
4703 } 4719 }
4704 }, 4720 },
4705 "/modalities/{id}/storage-commitment" : { 4721 "/modalities/{id}/storage-commitment" : {
4706 "post" : { 4722 "post" : {
4707 "deprecated" : false, 4723 "deprecated" : false,
4708 "description" : "Trigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu", 4724 "description" : "Trigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu",
4709 "parameters" : [ 4725 "parameters" : [
4710 { 4726 {
4711 "description" : "Identifier of the modality of interest", 4727 "description" : "Identifier of the modality of interest",
4712 "in" : "path", 4728 "in" : "path",
4713 "name" : "id", 4729 "name" : "id",
4774 } 4790 }
4775 }, 4791 },
4776 "/modalities/{id}/store" : { 4792 "/modalities/{id}/store" : {
4777 "post" : { 4793 "post" : {
4778 "deprecated" : false, 4794 "deprecated" : false,
4779 "description" : "Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#rest-store-scu", 4795 "description" : "Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#rest-store-scu",
4780 "parameters" : [ 4796 "parameters" : [
4781 { 4797 {
4782 "description" : "Identifier of the modality of interest", 4798 "description" : "Identifier of the modality of interest",
4783 "in" : "path", 4799 "in" : "path",
4784 "name" : "id", 4800 "name" : "id",
4836 "type" : "string" 4852 "type" : "string"
4837 }, 4853 },
4838 "type" : "array" 4854 "type" : "array"
4839 }, 4855 },
4840 "StorageCommitment" : { 4856 "StorageCommitment" : {
4841 "description" : "Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: https://book.orthanc-server.com/users/storage-commitment.html#chaining-c-store-with-storage-commitment", 4857 "description" : "Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: https://orthanc.uclouvain.be/book/users/storage-commitment.html#chaining-c-store-with-storage-commitment",
4842 "type" : "boolean" 4858 "type" : "boolean"
4843 }, 4859 },
4844 "Synchronous" : { 4860 "Synchronous" : {
4845 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 4861 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
4846 "type" : "boolean" 4862 "type" : "boolean"
5002 "content" : { 5018 "content" : {
5003 "application/json" : { 5019 "application/json" : {
5004 "schema" : { 5020 "schema" : {
5005 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported patients (if `expand` argument is provided)", 5021 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported patients (if `expand` argument is provided)",
5006 "example" : [ 5022 "example" : [
5007 "0946fcb6-cf12ab43-bad958c1-bf057ad5-0fc6f54c", 5023 "da39a3ee-5e6b4b0d-3255bfef-95601890-afd80709",
5008 "da39a3ee-5e6b4b0d-3255bfef-95601890-afd80709" 5024 "16738bc3-e47ed42a-43ce044c-a3414a45-cb069bd0"
5009 ] 5025 ]
5010 } 5026 }
5011 } 5027 }
5012 }, 5028 },
5013 "description" : "" 5029 "description" : ""
5089 "description" : "Information about the DICOM patient", 5105 "description" : "Information about the DICOM patient",
5090 "example" : { 5106 "example" : {
5091 "ID" : "46e6332c-677825b6-202fcf7c-f787bc5f-7b07c382", 5107 "ID" : "46e6332c-677825b6-202fcf7c-f787bc5f-7b07c382",
5092 "IsStable" : true, 5108 "IsStable" : true,
5093 "Labels" : [], 5109 "Labels" : [],
5094 "LastUpdate" : "20180414T091542", 5110 "LastUpdate" : "20231109T160830",
5095 "MainDicomTags" : { 5111 "MainDicomTags" : {
5096 "PatientID" : "SOtNwu", 5112 "PatientID" : "SOtNwu",
5097 "PatientName" : "INCISIX" 5113 "PatientName" : "INCISIX"
5098 }, 5114 },
5099 "Studies" : [ "e98b9ac7-dd31ac40-ff046cb2-f0400d30-12f81d85" ], 5115 "Studies" : [ "e98b9ac7-dd31ac40-ff046cb2-f0400d30-12f81d85" ],
5110 } 5126 }
5111 }, 5127 },
5112 "/patients/{id}/anonymize" : { 5128 "/patients/{id}/anonymize" : {
5113 "post" : { 5129 "post" : {
5114 "deprecated" : false, 5130 "deprecated" : false,
5115 "description" : "Start a job that will anonymize all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series", 5131 "description" : "Start a job that will anonymize all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series",
5116 "parameters" : [ 5132 "parameters" : [
5117 { 5133 {
5118 "description" : "Orthanc identifier of the patient of interest", 5134 "description" : "Orthanc identifier of the patient of interest",
5119 "in" : "path", 5135 "in" : "path",
5120 "name" : "id", 5136 "name" : "id",
5183 "Synchronous" : { 5199 "Synchronous" : {
5184 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 5200 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
5185 "type" : "boolean" 5201 "type" : "boolean"
5186 }, 5202 },
5187 "Transcode" : { 5203 "Transcode" : {
5188 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 5204 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
5189 "type" : "string" 5205 "type" : "string"
5190 } 5206 }
5191 } 5207 }
5192 } 5208 }
5193 } 5209 }
5233 "schema" : { 5249 "schema" : {
5234 "type" : "string" 5250 "type" : "string"
5235 } 5251 }
5236 }, 5252 },
5237 { 5253 {
5238 "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", 5254 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
5239 "in" : "query", 5255 "in" : "query",
5240 "name" : "transcode", 5256 "name" : "transcode",
5241 "required" : false, 5257 "required" : false,
5242 "schema" : { 5258 "schema" : {
5243 "type" : "string" 5259 "type" : "string"
5300 "Synchronous" : { 5316 "Synchronous" : {
5301 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 5317 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
5302 "type" : "boolean" 5318 "type" : "boolean"
5303 }, 5319 },
5304 "Transcode" : { 5320 "Transcode" : {
5305 "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", 5321 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
5306 "type" : "string" 5322 "type" : "string"
5307 } 5323 }
5308 } 5324 }
5309 } 5325 }
5310 } 5326 }
5314 "200" : { 5330 "200" : {
5315 "content" : { 5331 "content" : {
5316 "application/json" : { 5332 "application/json" : {
5317 "examples" : {}, 5333 "examples" : {},
5318 "schema" : { 5334 "schema" : {
5319 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 5335 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
5320 "properties" : { 5336 "properties" : {
5321 "ID" : { 5337 "ID" : {
5322 "description" : "Identifier of the job", 5338 "description" : "Identifier of the job",
5323 "type" : "string" 5339 "type" : "string"
5324 }, 5340 },
5845 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 5861 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
5846 "CompressedSize" : 526970, 5862 "CompressedSize" : 526970,
5847 "ContentType" : 1, 5863 "ContentType" : 1,
5848 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 5864 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
5849 "UncompressedSize" : 526970, 5865 "UncompressedSize" : 526970,
5850 "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" 5866 "Uuid" : "ada05909-0efc-43fd-b615-c5cafbaeacf8"
5851 } 5867 }
5852 } 5868 }
5853 } 5869 }
5854 }, 5870 },
5855 "description" : "", 5871 "description" : "",
6107 "get" : { 6123 "get" : {
6108 "deprecated" : false, 6124 "deprecated" : false,
6109 "description" : "Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL", 6125 "description" : "Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL",
6110 "parameters" : [ 6126 "parameters" : [
6111 { 6127 {
6128 "description" : "If false or missing, only retrieve the list of child instances",
6129 "in" : "query",
6130 "name" : "expand",
6131 "required" : false,
6132 "schema" : {
6133 "type" : "string"
6134 }
6135 },
6136 {
6112 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)", 6137 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)",
6113 "in" : "query", 6138 "in" : "query",
6114 "name" : "full", 6139 "name" : "full",
6115 "required" : false, 6140 "required" : false,
6116 "schema" : { 6141 "schema" : {
6152 "schema" : { 6177 "schema" : {
6153 "description" : "JSON array containing information about the child DICOM instances", 6178 "description" : "JSON array containing information about the child DICOM instances",
6154 "example" : [ 6179 "example" : [
6155 { 6180 {
6156 "FileSize" : 526866, 6181 "FileSize" : 526866,
6157 "FileUuid" : "c14b2b87-53e2-420b-baf9-020cae34fedf", 6182 "FileUuid" : "ae097e47-5826-4f9d-9ca4-0d262a929c12",
6158 "ID" : "e3dfd688-80e4743a-29c45f90-371ec4a4-04d18ae5", 6183 "ID" : "7ca06aee-5cb2cc11-d4d71cfc-b6cd777b-83b57611",
6159 "IndexInSeries" : 137, 6184 "IndexInSeries" : 165,
6160 "Labels" : [], 6185 "Labels" : [],
6161 "{...}" : "..." 6186 "{...}" : "..."
6162 }, 6187 },
6163 { 6188 {
6164 "FileSize" : 526870, 6189 "FileSize" : 526870,
6165 "FileUuid" : "27cdb02f-500f-4b37-9ca1-058d8d4f649a", 6190 "FileUuid" : "2098edc6-7c49-43b5-be67-45318c0ef7fc",
6166 "ID" : "4fecddf1-518346e4-4f30176b-c453b3d8-65899230", 6191 "ID" : "6eeb2475-5b5ba0a3-d39fb207-106beb1e-be3df75a",
6167 "IndexInSeries" : 114, 6192 "IndexInSeries" : 124,
6168 "Labels" : [], 6193 "Labels" : [],
6169 "{...}" : "..." 6194 "{...}" : "..."
6170 }, 6195 },
6171 { 6196 {
6172 "FileSize" : 526868, 6197 "FileSize" : 526870,
6173 "FileUuid" : "5a6334a8-e050-47e5-8832-531ee62aa9a7", 6198 "FileUuid" : "56f4e359-2c96-4356-a951-02ee363effd7",
6174 "ID" : "c9a55bc1-9e98ba4b-bc455dc3-24c4c525-1b171b6c", 6199 "ID" : "c6ce208f-e9d1447d-84fd8575-b48fac0e-7cd6b065",
6175 "IndexInSeries" : 66, 6200 "IndexInSeries" : 122,
6176 "Labels" : [], 6201 "Labels" : [],
6177 "{...}" : "..." 6202 "{...}" : "..."
6178 }, 6203 },
6179 { 6204 {
6180 "FileSize" : 526866, 6205 "FileSize" : 526864,
6181 "FileUuid" : "e6c09e08-8284-4416-a90f-67a7dc9f68f0", 6206 "FileUuid" : "90f60b6d-056b-4d71-82fb-1d8810e3bf7e",
6182 "ID" : "135cca6f-4c099fdd-afc99251-f58a819b-5a0222eb", 6207 "ID" : "792409cc-6943e472-65123f4a-b18520da-56db9e95",
6183 "IndexInSeries" : 161, 6208 "IndexInSeries" : 95,
6184 "Labels" : [], 6209 "Labels" : [],
6185 "{...}" : "..." 6210 "{...}" : "..."
6186 }, 6211 },
6187 { 6212 {
6188 "FileSize" : 526866, 6213 "FileSize" : 526864,
6189 "FileUuid" : "9eb33412-d1e9-4bb0-879b-5501db81d574", 6214 "FileUuid" : "5fd8c2e8-8825-4a89-9988-75c9c72db157",
6190 "ID" : "719d58b1-2a259486-7cc5919d-68a2bd30-da2cd290", 6215 "ID" : "8de7f8ce-56dd2622-55ff7e02-08b67d7b-f7330657",
6191 "IndexInSeries" : 61, 6216 "IndexInSeries" : 73,
6192 "Labels" : [], 6217 "Labels" : [],
6193 "{...}" : "..." 6218 "{...}" : "..."
6194 }, 6219 },
6195 "..." 6220 "..."
6196 ] 6221 ]
6565 "schema" : { 6590 "schema" : {
6566 "type" : "string" 6591 "type" : "string"
6567 } 6592 }
6568 }, 6593 },
6569 { 6594 {
6570 "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", 6595 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
6571 "in" : "query", 6596 "in" : "query",
6572 "name" : "transcode", 6597 "name" : "transcode",
6573 "required" : false, 6598 "required" : false,
6574 "schema" : { 6599 "schema" : {
6575 "type" : "string" 6600 "type" : "string"
6636 "Synchronous" : { 6661 "Synchronous" : {
6637 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 6662 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
6638 "type" : "boolean" 6663 "type" : "boolean"
6639 }, 6664 },
6640 "Transcode" : { 6665 "Transcode" : {
6641 "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", 6666 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
6642 "type" : "string" 6667 "type" : "string"
6643 } 6668 }
6644 } 6669 }
6645 } 6670 }
6646 } 6671 }
6650 "200" : { 6675 "200" : {
6651 "content" : { 6676 "content" : {
6652 "application/json" : { 6677 "application/json" : {
6653 "examples" : {}, 6678 "examples" : {},
6654 "schema" : { 6679 "schema" : {
6655 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 6680 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
6656 "properties" : { 6681 "properties" : {
6657 "ID" : { 6682 "ID" : {
6658 "description" : "Identifier of the job", 6683 "description" : "Identifier of the job",
6659 "type" : "string" 6684 "type" : "string"
6660 }, 6685 },
6716 "200" : { 6741 "200" : {
6717 "content" : { 6742 "content" : {
6718 "application/json" : { 6743 "application/json" : {
6719 "schema" : { 6744 "schema" : {
6720 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)", 6745 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
6721 "example" : [ "LastUpdate" ] 6746 "example" : [ "LastUpdate", "MainDicomTagsSignature" ]
6722 } 6747 }
6723 } 6748 }
6724 }, 6749 },
6725 "description" : "" 6750 "description" : ""
6726 } 6751 }
6874 } 6899 }
6875 }, 6900 },
6876 "/patients/{id}/modify" : { 6901 "/patients/{id}/modify" : {
6877 "post" : { 6902 "post" : {
6878 "deprecated" : false, 6903 "deprecated" : false,
6879 "description" : "Start a job that will modify all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series", 6904 "description" : "Start a job that will modify all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series",
6880 "parameters" : [ 6905 "parameters" : [
6881 { 6906 {
6882 "description" : "Orthanc identifier of the patient of interest", 6907 "description" : "Orthanc identifier of the patient of interest",
6883 "in" : "path", 6908 "in" : "path",
6884 "name" : "id", 6909 "name" : "id",
6943 "Synchronous" : { 6968 "Synchronous" : {
6944 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 6969 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
6945 "type" : "boolean" 6970 "type" : "boolean"
6946 }, 6971 },
6947 "Transcode" : { 6972 "Transcode" : {
6948 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 6973 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
6949 "type" : "string" 6974 "type" : "string"
6950 } 6975 }
6951 } 6976 }
6952 } 6977 }
6953 } 6978 }
7084 "summary" : "Is the patient protected against recycling?", 7109 "summary" : "Is the patient protected against recycling?",
7085 "tags" : [ "Patients" ] 7110 "tags" : [ "Patients" ]
7086 }, 7111 },
7087 "put" : { 7112 "put" : {
7088 "deprecated" : false, 7113 "deprecated" : false,
7089 "description" : "Check out configuration options `MaximumStorageSize` and `MaximumPatientCount`", 7114 "description" : "Protects a patient by sending `1` or `true` in the payload request. Unprotects a patient by sending `0` or `false` in the payload requests. More info: https://orthanc.uclouvain.be/book/faq/features.html#recycling-protection",
7090 "parameters" : [ 7115 "parameters" : [
7091 { 7116 {
7092 "description" : "Orthanc identifier of the patient of interest", 7117 "description" : "Orthanc identifier of the patient of interest",
7093 "in" : "path", 7118 "in" : "path",
7094 "name" : "id", 7119 "name" : "id",
7101 "responses" : { 7126 "responses" : {
7102 "200" : { 7127 "200" : {
7103 "description" : "" 7128 "description" : ""
7104 } 7129 }
7105 }, 7130 },
7106 "summary" : "Protect one patient against recycling", 7131 "summary" : "Protect/Unprotect a patient against recycling",
7107 "tags" : [ "Patients" ] 7132 "tags" : [ "Patients" ]
7108 } 7133 }
7109 }, 7134 },
7110 "/patients/{id}/reconstruct" : { 7135 "/patients/{id}/reconstruct" : {
7111 "post" : { 7136 "post" : {
7150 "get" : { 7175 "get" : {
7151 "deprecated" : false, 7176 "deprecated" : false,
7152 "description" : "Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL", 7177 "description" : "Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL",
7153 "parameters" : [ 7178 "parameters" : [
7154 { 7179 {
7180 "description" : "If false or missing, only retrieve the list of child series",
7181 "in" : "query",
7182 "name" : "expand",
7183 "required" : false,
7184 "schema" : {
7185 "type" : "string"
7186 }
7187 },
7188 {
7155 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)", 7189 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)",
7156 "in" : "query", 7190 "in" : "query",
7157 "name" : "full", 7191 "name" : "full",
7158 "required" : false, 7192 "required" : false,
7159 "schema" : { 7193 "schema" : {
7197 "example" : [ 7231 "example" : [
7198 { 7232 {
7199 "ExpectedNumberOfInstances" : null, 7233 "ExpectedNumberOfInstances" : null,
7200 "ID" : "52cc572c-3ee31930-c4b6d5e7-16c786dc-97bc209b", 7234 "ID" : "52cc572c-3ee31930-c4b6d5e7-16c786dc-97bc209b",
7201 "Instances" : [ 7235 "Instances" : [
7202 "e3dfd688-80e4743a-29c45f90-371ec4a4-04d18ae5", 7236 "7ca06aee-5cb2cc11-d4d71cfc-b6cd777b-83b57611",
7203 "4fecddf1-518346e4-4f30176b-c453b3d8-65899230", 7237 "6eeb2475-5b5ba0a3-d39fb207-106beb1e-be3df75a",
7204 "c9a55bc1-9e98ba4b-bc455dc3-24c4c525-1b171b6c", 7238 "c6ce208f-e9d1447d-84fd8575-b48fac0e-7cd6b065",
7205 "135cca6f-4c099fdd-afc99251-f58a819b-5a0222eb", 7239 "792409cc-6943e472-65123f4a-b18520da-56db9e95",
7206 "719d58b1-2a259486-7cc5919d-68a2bd30-da2cd290", 7240 "8de7f8ce-56dd2622-55ff7e02-08b67d7b-f7330657",
7207 "..." 7241 "..."
7208 ], 7242 ],
7209 "IsStable" : true, 7243 "IsStable" : true,
7210 "Labels" : [], 7244 "Labels" : [],
7211 "{...}" : "..." 7245 "{...}" : "..."
7325 "CountStudies" : 1, 7359 "CountStudies" : 1,
7326 "DicomDiskSize" : "87460012", 7360 "DicomDiskSize" : "87460012",
7327 "DicomDiskSizeMB" : 83, 7361 "DicomDiskSizeMB" : 83,
7328 "DicomUncompressedSize" : "87460012", 7362 "DicomUncompressedSize" : "87460012",
7329 "DicomUncompressedSizeMB" : 83, 7363 "DicomUncompressedSizeMB" : 83,
7330 "DiskSize" : "89640436", 7364 "DiskSize" : "87460012",
7331 "DiskSizeMB" : 85, 7365 "DiskSizeMB" : 83,
7332 "UncompressedSize" : "89640436", 7366 "UncompressedSize" : "87460012",
7333 "UncompressedSizeMB" : 85 7367 "UncompressedSizeMB" : 83
7334 }, 7368 },
7335 "properties" : { 7369 "properties" : {
7336 "CountInstances" : { 7370 "CountInstances" : {
7337 "description" : "Number of child instances within this patient", 7371 "description" : "Number of child instances within this patient",
7338 "type" : "number" 7372 "type" : "number"
7391 "/patients/{id}/studies" : { 7425 "/patients/{id}/studies" : {
7392 "get" : { 7426 "get" : {
7393 "deprecated" : false, 7427 "deprecated" : false,
7394 "description" : "Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL", 7428 "description" : "Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL",
7395 "parameters" : [ 7429 "parameters" : [
7430 {
7431 "description" : "If false or missing, only retrieve the list of child studies",
7432 "in" : "query",
7433 "name" : "expand",
7434 "required" : false,
7435 "schema" : {
7436 "type" : "string"
7437 }
7438 },
7396 { 7439 {
7397 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)", 7440 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)",
7398 "in" : "query", 7441 "in" : "query",
7399 "name" : "full", 7442 "name" : "full",
7400 "required" : false, 7443 "required" : false,
7439 "example" : [ 7482 "example" : [
7440 { 7483 {
7441 "ID" : "e98b9ac7-dd31ac40-ff046cb2-f0400d30-12f81d85", 7484 "ID" : "e98b9ac7-dd31ac40-ff046cb2-f0400d30-12f81d85",
7442 "IsStable" : true, 7485 "IsStable" : true,
7443 "Labels" : [], 7486 "Labels" : [],
7444 "LastUpdate" : "20180414T091542", 7487 "LastUpdate" : "20231109T160830",
7445 "MainDicomTags" : { 7488 "MainDicomTags" : {
7446 "AccessionNumber" : "0", 7489 "AccessionNumber" : "0",
7447 "InstitutionName" : "dPJ", 7490 "InstitutionName" : "dPJ",
7448 "ReferringPhysicianName" : "YzTEkpkak0p0Tk5", 7491 "ReferringPhysicianName" : "YzTEkpkak0p0Tk5",
7449 "RequestedProcedureDescription" : "CT2 tête, face, sinus", 7492 "RequestedProcedureDescription" : "CT2 tête, face, sinus",
7649 } 7692 }
7650 }, 7693 },
7651 "/peers/{id}/store" : { 7694 "/peers/{id}/store" : {
7652 "post" : { 7695 "post" : {
7653 "deprecated" : false, 7696 "deprecated" : false,
7654 "description" : "Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#sending-one-resource", 7697 "description" : "Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#sending-one-resource",
7655 "parameters" : [ 7698 "parameters" : [
7656 { 7699 {
7657 "description" : "Identifier of the modality of interest", 7700 "description" : "Identifier of the modality of interest",
7658 "in" : "path", 7701 "in" : "path",
7659 "name" : "id", 7702 "name" : "id",
7947 } 7990 }
7948 }, 7991 },
7949 "/queries" : { 7992 "/queries" : {
7950 "get" : { 7993 "get" : {
7951 "deprecated" : false, 7994 "deprecated" : false,
7952 "description" : "List the identifiers of all the query/retrieve operations on DICOM modalities, as initiated by calls to `/modalities/{id}/query`. The length of this list is bounded by the `QueryRetrieveSize` configuration option of Orthanc. https://book.orthanc-server.com/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest", 7995 "description" : "List the identifiers of all the query/retrieve operations on DICOM modalities, as initiated by calls to `/modalities/{id}/query`. The length of this list is bounded by the `QueryRetrieveSize` configuration option of Orthanc. https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest",
7953 "parameters" : [], 7996 "parameters" : [],
7954 "responses" : { 7997 "responses" : {
7955 "200" : { 7998 "200" : {
7956 "content" : { 7999 "content" : {
7957 "application/json" : { 8000 "application/json" : {
8392 } 8435 }
8393 }, 8436 },
8394 "/queries/{id}/answers/{index}/retrieve" : { 8437 "/queries/{id}/answers/{index}/retrieve" : {
8395 "post" : { 8438 "post" : {
8396 "deprecated" : false, 8439 "deprecated" : false,
8397 "description" : "Start a C-MOVE SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move", 8440 "description" : "Start a C-MOVE SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move",
8398 "parameters" : [ 8441 "parameters" : [
8399 { 8442 {
8400 "description" : "Identifier of the query of interest", 8443 "description" : "Identifier of the query of interest",
8401 "in" : "path", 8444 "in" : "path",
8402 "name" : "id", 8445 "name" : "id",
8605 } 8648 }
8606 }, 8649 },
8607 "/queries/{id}/retrieve" : { 8650 "/queries/{id}/retrieve" : {
8608 "post" : { 8651 "post" : {
8609 "deprecated" : false, 8652 "deprecated" : false,
8610 "description" : "Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move", 8653 "description" : "Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move",
8611 "parameters" : [ 8654 "parameters" : [
8612 { 8655 {
8613 "description" : "Identifier of the query of interest", 8656 "description" : "Identifier of the query of interest",
8614 "in" : "path", 8657 "in" : "path",
8615 "name" : "id", 8658 "name" : "id",
8759 "content" : { 8802 "content" : {
8760 "application/json" : { 8803 "application/json" : {
8761 "schema" : { 8804 "schema" : {
8762 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported series (if `expand` argument is provided)", 8805 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported series (if `expand` argument is provided)",
8763 "example" : [ 8806 "example" : [
8764 "318603c5-03e8cffc-a82b6ee1-3ccd3c1e-18d7e3bb", 8807 "1de00990-03680ef4-0be6bd5b-73a7d350-fb46abfa",
8765 "7124dba7-09803f33-98b73826-33f14632-ea842d29" 8808 "a69a10d7-068c5263-8aab53fe-de7af5f2-373a74bd"
8766 ] 8809 ]
8767 } 8810 }
8768 } 8811 }
8769 }, 8812 },
8770 "description" : "" 8813 "description" : ""
8848 "ExpectedNumberOfInstances" : null, 8891 "ExpectedNumberOfInstances" : null,
8849 "ID" : "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52", 8892 "ID" : "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
8850 "Instances" : [ "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f" ], 8893 "Instances" : [ "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f" ],
8851 "IsStable" : true, 8894 "IsStable" : true,
8852 "Labels" : [], 8895 "Labels" : [],
8853 "LastUpdate" : "20180414T091542", 8896 "LastUpdate" : "20231109T160851",
8854 "MainDicomTags" : { 8897 "MainDicomTags" : {
8855 "ImageOrientationPatient" : "0\\1\\0\\0\\0\\-1", 8898 "ImageOrientationPatient" : "0\\1\\0\\0\\0\\-1",
8856 "Manufacturer" : "Philips", 8899 "Manufacturer" : "Philips",
8857 "Modality" : "CT", 8900 "Modality" : "CT",
8858 "PerformedProcedureStepDescription" : "CT2 tête, face, sinus", 8901 "PerformedProcedureStepDescription" : "CT2 tête, face, sinus",
8876 } 8919 }
8877 }, 8920 },
8878 "/series/{id}/anonymize" : { 8921 "/series/{id}/anonymize" : {
8879 "post" : { 8922 "post" : {
8880 "deprecated" : false, 8923 "deprecated" : false,
8881 "description" : "Start a job that will anonymize all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series", 8924 "description" : "Start a job that will anonymize all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series",
8882 "parameters" : [ 8925 "parameters" : [
8883 { 8926 {
8884 "description" : "Orthanc identifier of the series of interest", 8927 "description" : "Orthanc identifier of the series of interest",
8885 "in" : "path", 8928 "in" : "path",
8886 "name" : "id", 8929 "name" : "id",
8949 "Synchronous" : { 8992 "Synchronous" : {
8950 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 8993 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
8951 "type" : "boolean" 8994 "type" : "boolean"
8952 }, 8995 },
8953 "Transcode" : { 8996 "Transcode" : {
8954 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 8997 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
8955 "type" : "string" 8998 "type" : "string"
8956 } 8999 }
8957 } 9000 }
8958 } 9001 }
8959 } 9002 }
8999 "schema" : { 9042 "schema" : {
9000 "type" : "string" 9043 "type" : "string"
9001 } 9044 }
9002 }, 9045 },
9003 { 9046 {
9004 "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", 9047 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
9005 "in" : "query", 9048 "in" : "query",
9006 "name" : "transcode", 9049 "name" : "transcode",
9007 "required" : false, 9050 "required" : false,
9008 "schema" : { 9051 "schema" : {
9009 "type" : "string" 9052 "type" : "string"
9066 "Synchronous" : { 9109 "Synchronous" : {
9067 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 9110 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
9068 "type" : "boolean" 9111 "type" : "boolean"
9069 }, 9112 },
9070 "Transcode" : { 9113 "Transcode" : {
9071 "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", 9114 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
9072 "type" : "string" 9115 "type" : "string"
9073 } 9116 }
9074 } 9117 }
9075 } 9118 }
9076 } 9119 }
9080 "200" : { 9123 "200" : {
9081 "content" : { 9124 "content" : {
9082 "application/json" : { 9125 "application/json" : {
9083 "examples" : {}, 9126 "examples" : {},
9084 "schema" : { 9127 "schema" : {
9085 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 9128 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
9086 "properties" : { 9129 "properties" : {
9087 "ID" : { 9130 "ID" : {
9088 "description" : "Identifier of the job", 9131 "description" : "Identifier of the job",
9089 "type" : "string" 9132 "type" : "string"
9090 }, 9133 },
9611 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 9654 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
9612 "CompressedSize" : 526970, 9655 "CompressedSize" : 526970,
9613 "ContentType" : 1, 9656 "ContentType" : 1,
9614 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 9657 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
9615 "UncompressedSize" : 526970, 9658 "UncompressedSize" : 526970,
9616 "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" 9659 "Uuid" : "ada05909-0efc-43fd-b615-c5cafbaeacf8"
9617 } 9660 }
9618 } 9661 }
9619 } 9662 }
9620 }, 9663 },
9621 "description" : "", 9664 "description" : "",
9873 "get" : { 9916 "get" : {
9874 "deprecated" : false, 9917 "deprecated" : false,
9875 "description" : "Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL", 9918 "description" : "Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL",
9876 "parameters" : [ 9919 "parameters" : [
9877 { 9920 {
9921 "description" : "If false or missing, only retrieve the list of child instances",
9922 "in" : "query",
9923 "name" : "expand",
9924 "required" : false,
9925 "schema" : {
9926 "type" : "string"
9927 }
9928 },
9929 {
9878 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)", 9930 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)",
9879 "in" : "query", 9931 "in" : "query",
9880 "name" : "full", 9932 "name" : "full",
9881 "required" : false, 9933 "required" : false,
9882 "schema" : { 9934 "schema" : {
9918 "schema" : { 9970 "schema" : {
9919 "description" : "JSON array containing information about the child DICOM instances", 9971 "description" : "JSON array containing information about the child DICOM instances",
9920 "example" : [ 9972 "example" : [
9921 { 9973 {
9922 "FileSize" : 368852, 9974 "FileSize" : 368852,
9923 "FileUuid" : "9016272a-ee8c-41b2-afc6-dcfe06dd3be8", 9975 "FileUuid" : "eec5367e-b460-475c-a808-75343dbf9136",
9924 "ID" : "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f", 9976 "ID" : "6582b1c0-292ad5ab-ba0f088f-f7a1766f-9a29a54f",
9925 "IndexInSeries" : 1, 9977 "IndexInSeries" : 1,
9926 "Labels" : [], 9978 "Labels" : [],
9927 "{...}" : "..." 9979 "{...}" : "..."
9928 } 9980 }
10185 "schema" : { 10237 "schema" : {
10186 "type" : "string" 10238 "type" : "string"
10187 } 10239 }
10188 }, 10240 },
10189 { 10241 {
10190 "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", 10242 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
10191 "in" : "query", 10243 "in" : "query",
10192 "name" : "transcode", 10244 "name" : "transcode",
10193 "required" : false, 10245 "required" : false,
10194 "schema" : { 10246 "schema" : {
10195 "type" : "string" 10247 "type" : "string"
10256 "Synchronous" : { 10308 "Synchronous" : {
10257 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 10309 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
10258 "type" : "boolean" 10310 "type" : "boolean"
10259 }, 10311 },
10260 "Transcode" : { 10312 "Transcode" : {
10261 "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", 10313 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
10262 "type" : "string" 10314 "type" : "string"
10263 } 10315 }
10264 } 10316 }
10265 } 10317 }
10266 } 10318 }
10270 "200" : { 10322 "200" : {
10271 "content" : { 10323 "content" : {
10272 "application/json" : { 10324 "application/json" : {
10273 "examples" : {}, 10325 "examples" : {},
10274 "schema" : { 10326 "schema" : {
10275 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 10327 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
10276 "properties" : { 10328 "properties" : {
10277 "ID" : { 10329 "ID" : {
10278 "description" : "Identifier of the job", 10330 "description" : "Identifier of the job",
10279 "type" : "string" 10331 "type" : "string"
10280 }, 10332 },
10336 "200" : { 10388 "200" : {
10337 "content" : { 10389 "content" : {
10338 "application/json" : { 10390 "application/json" : {
10339 "schema" : { 10391 "schema" : {
10340 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)", 10392 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
10341 "example" : [ "LastUpdate" ] 10393 "example" : [ "RemoteAET", "LastUpdate", "MainDicomTagsSignature" ]
10342 } 10394 }
10343 } 10395 }
10344 }, 10396 },
10345 "description" : "" 10397 "description" : ""
10346 } 10398 }
10494 } 10546 }
10495 }, 10547 },
10496 "/series/{id}/modify" : { 10548 "/series/{id}/modify" : {
10497 "post" : { 10549 "post" : {
10498 "deprecated" : false, 10550 "deprecated" : false,
10499 "description" : "Start a job that will modify all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series", 10551 "description" : "Start a job that will modify all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series",
10500 "parameters" : [ 10552 "parameters" : [
10501 { 10553 {
10502 "description" : "Orthanc identifier of the series of interest", 10554 "description" : "Orthanc identifier of the series of interest",
10503 "in" : "path", 10555 "in" : "path",
10504 "name" : "id", 10556 "name" : "id",
10563 "Synchronous" : { 10615 "Synchronous" : {
10564 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 10616 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
10565 "type" : "boolean" 10617 "type" : "boolean"
10566 }, 10618 },
10567 "Transcode" : { 10619 "Transcode" : {
10568 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 10620 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
10569 "type" : "string" 10621 "type" : "string"
10570 } 10622 }
10571 } 10623 }
10572 } 10624 }
10573 } 10625 }
10985 "description" : "Information about the parent DICOM patient", 11037 "description" : "Information about the parent DICOM patient",
10986 "example" : { 11038 "example" : {
10987 "ID" : "2f74083e-9b042648-10edac14-b26950f8-f82ec3a0", 11039 "ID" : "2f74083e-9b042648-10edac14-b26950f8-f82ec3a0",
10988 "IsStable" : true, 11040 "IsStable" : true,
10989 "Labels" : [], 11041 "Labels" : [],
10990 "LastUpdate" : "20180414T091601", 11042 "LastUpdate" : "20231109T160911",
10991 "MainDicomTags" : { 11043 "MainDicomTags" : {
10992 "PatientBirthDate" : "19910101", 11044 "PatientBirthDate" : "19910101",
10993 "PatientID" : "Vafk,T,6", 11045 "PatientID" : "Vafk,T,6",
10994 "PatientName" : "PHENIX", 11046 "PatientName" : "PHENIX",
10995 "PatientSex" : "" 11047 "PatientSex" : ""
11148 "CountInstances" : 1, 11200 "CountInstances" : 1,
11149 "DicomDiskSize" : "368852", 11201 "DicomDiskSize" : "368852",
11150 "DicomDiskSizeMB" : 0, 11202 "DicomDiskSizeMB" : 0,
11151 "DicomUncompressedSize" : "368852", 11203 "DicomUncompressedSize" : "368852",
11152 "DicomUncompressedSizeMB" : 0, 11204 "DicomUncompressedSizeMB" : 0,
11153 "DiskSize" : "381000", 11205 "DiskSize" : "368852",
11154 "DiskSizeMB" : 0, 11206 "DiskSizeMB" : 0,
11155 "UncompressedSize" : "381000", 11207 "UncompressedSize" : "368852",
11156 "UncompressedSizeMB" : 0 11208 "UncompressedSizeMB" : 0
11157 }, 11209 },
11158 "properties" : { 11210 "properties" : {
11159 "CountInstances" : { 11211 "CountInstances" : {
11160 "description" : "Number of child instances within this series", 11212 "description" : "Number of child instances within this series",
11253 "description" : "Information about the parent DICOM study", 11305 "description" : "Information about the parent DICOM study",
11254 "example" : { 11306 "example" : {
11255 "ID" : "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a", 11307 "ID" : "49974143-ec23cb52-6b2a1c46-14d5daa0-0822ce1a",
11256 "IsStable" : true, 11308 "IsStable" : true,
11257 "Labels" : [], 11309 "Labels" : [],
11258 "LastUpdate" : "20180414T091601", 11310 "LastUpdate" : "20231109T160911",
11259 "MainDicomTags" : { 11311 "MainDicomTags" : {
11260 "AccessionNumber" : "A10011234814", 11312 "AccessionNumber" : "A10011234814",
11261 "InstitutionName" : "HUG", 11313 "InstitutionName" : "HUG",
11262 "ReferringPhysicianName" : "CHIR-PED^CHIR-PE", 11314 "ReferringPhysicianName" : "CHIR-PED^CHIR-PE",
11263 "RequestedProcedureDescription" : "CT2 TÊTE, FACE, SINUS", 11315 "RequestedProcedureDescription" : "CT2 TÊTE, FACE, SINUS",
11274 "PatientID" : "Vafk,T,6", 11326 "PatientID" : "Vafk,T,6",
11275 "PatientName" : "PHENIX", 11327 "PatientName" : "PHENIX",
11276 "PatientSex" : "" 11328 "PatientSex" : ""
11277 }, 11329 },
11278 "Series" : [ 11330 "Series" : [
11331 "7696013f-4c89c563-2b071693-5d1f97f6-f8ab232d",
11279 "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52", 11332 "37836232-d13a2350-fa1dedc5-962b31aa-010f8e52",
11280 "7696013f-4c89c563-2b071693-5d1f97f6-f8ab232d",
11281 "17cc7e52-4f1a3e4d-9182f727-56e9cc71-c037892f" 11333 "17cc7e52-4f1a3e4d-9182f727-56e9cc71-c037892f"
11282 ], 11334 ],
11283 "Type" : "Study" 11335 "Type" : "Study"
11284 } 11336 }
11285 } 11337 }
11302 "content" : { 11354 "content" : {
11303 "application/json" : { 11355 "application/json" : {
11304 "schema" : { 11356 "schema" : {
11305 "description" : "", 11357 "description" : "",
11306 "example" : { 11358 "example" : {
11307 "CountInstances" : 2552, 11359 "CountInstances" : 2352,
11308 "CountPatients" : 8, 11360 "CountPatients" : 7,
11309 "CountSeries" : 26, 11361 "CountSeries" : 23,
11310 "CountStudies" : 8, 11362 "CountStudies" : 7,
11311 "TotalDiskSize" : "1068132148", 11363 "TotalDiskSize" : "881421860",
11312 "TotalDiskSizeMB" : 1018, 11364 "TotalDiskSizeMB" : 840,
11313 "TotalUncompressedSize" : "1068132148", 11365 "TotalUncompressedSize" : "881421860",
11314 "TotalUncompressedSizeMB" : 1018 11366 "TotalUncompressedSizeMB" : 840
11315 }, 11367 },
11316 "properties" : { 11368 "properties" : {
11317 "CountInstances" : { 11369 "CountInstances" : {
11318 "description" : "Number of DICOM instances stored in Orthanc", 11370 "description" : "Number of DICOM instances stored in Orthanc",
11319 "type" : "number" 11371 "type" : "number"
11358 } 11410 }
11359 }, 11411 },
11360 "/storage-commitment/{id}" : { 11412 "/storage-commitment/{id}" : {
11361 "get" : { 11413 "get" : {
11362 "deprecated" : false, 11414 "deprecated" : false,
11363 "description" : "Get the storage commitment report whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu", 11415 "description" : "Get the storage commitment report whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu",
11364 "parameters" : [ 11416 "parameters" : [
11365 { 11417 {
11366 "description" : "Identifier of the storage commitment report", 11418 "description" : "Identifier of the storage commitment report",
11367 "in" : "path", 11419 "in" : "path",
11368 "name" : "id", 11420 "name" : "id",
11414 } 11466 }
11415 }, 11467 },
11416 "/storage-commitment/{id}/remove" : { 11468 "/storage-commitment/{id}/remove" : {
11417 "post" : { 11469 "post" : {
11418 "deprecated" : false, 11470 "deprecated" : false,
11419 "description" : "Remove out of Orthanc, the DICOM instances that have been reported to have been properly received the storage commitment report whose identifier is provided in the URL. This is only possible if the `Status` of the storage commitment report is `Success`. https://book.orthanc-server.com/users/storage-commitment.html#removing-the-instances", 11471 "description" : "Remove out of Orthanc, the DICOM instances that have been reported to have been properly received the storage commitment report whose identifier is provided in the URL. This is only possible if the `Status` of the storage commitment report is `Success`. https://orthanc.uclouvain.be/book/users/storage-commitment.html#removing-the-instances",
11420 "parameters" : [ 11472 "parameters" : [
11421 { 11473 {
11422 "description" : "Identifier of the storage commitment report", 11474 "description" : "Identifier of the storage commitment report",
11423 "in" : "path", 11475 "in" : "path",
11424 "name" : "id", 11476 "name" : "id",
11502 "content" : { 11554 "content" : {
11503 "application/json" : { 11555 "application/json" : {
11504 "schema" : { 11556 "schema" : {
11505 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported studies (if `expand` argument is provided)", 11557 "description" : "JSON array containing either the Orthanc identifiers, or detailed information about the reported studies (if `expand` argument is provided)",
11506 "example" : [ 11558 "example" : [
11507 "6c65289b-db2fcb71-7eaf73f4-8e12470c-a4d6d7cf", 11559 "6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715",
11508 "6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715" 11560 "27f7126f-4f66fb14-03f4081b-f9341db2-53925988"
11509 ] 11561 ]
11510 } 11562 }
11511 } 11563 }
11512 }, 11564 },
11513 "description" : "" 11565 "description" : ""
11589 "description" : "Information about the DICOM study", 11641 "description" : "Information about the DICOM study",
11590 "example" : { 11642 "example" : {
11591 "ID" : "27f7126f-4f66fb14-03f4081b-f9341db2-53925988", 11643 "ID" : "27f7126f-4f66fb14-03f4081b-f9341db2-53925988",
11592 "IsStable" : true, 11644 "IsStable" : true,
11593 "Labels" : [], 11645 "Labels" : [],
11594 "LastUpdate" : "20180414T091532", 11646 "LastUpdate" : "20231109T160811",
11595 "MainDicomTags" : { 11647 "MainDicomTags" : {
11596 "AccessionNumber" : "0", 11648 "AccessionNumber" : "0",
11597 "InstitutionName" : "7GEFF0GbzqCNo43Yd0,Ibu,zQSSX", 11649 "InstitutionName" : "7GEFF0GbzqCNo43Yd0,Ibu,zQSSX",
11598 "ReferringPhysicianName" : "dAEvNTxZJO0E", 11650 "ReferringPhysicianName" : "dAEvNTxZJO0E",
11599 "RequestedProcedureDescription" : "IRM cérébrale, neuro-crâne", 11651 "RequestedProcedureDescription" : "IRM cérébrale, neuro-crâne",
11609 "PatientID" : "5Yp0E", 11661 "PatientID" : "5Yp0E",
11610 "PatientName" : "BRAINIX", 11662 "PatientName" : "BRAINIX",
11611 "PatientSex" : "0000" 11663 "PatientSex" : "0000"
11612 }, 11664 },
11613 "Series" : [ 11665 "Series" : [
11666 "ae164c84-e5bd0366-ba937a6d-65414092-f294d6b6",
11667 "3ca69615-fcd4a4fb-e5f2cc9d-9c7a49a5-add98bbf",
11668 "2ac1316d-3e432022-62eabff2-c59f5475-9b1ac3f8",
11614 "635faa23-fd8378ee-d03bce29-ee47c2fb-a65c5509", 11669 "635faa23-fd8378ee-d03bce29-ee47c2fb-a65c5509",
11615 "dc0216d2-a406a5ad-31ef7a78-113ae9d9-29939f9e", 11670 "dc0216d2-a406a5ad-31ef7a78-113ae9d9-29939f9e",
11616 "1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0",
11617 "4baa97c7-d53d3d82-a5eb9403-17ef5a77-4e0efb55", 11671 "4baa97c7-d53d3d82-a5eb9403-17ef5a77-4e0efb55",
11618 "2ac1316d-3e432022-62eabff2-c59f5475-9b1ac3f8", 11672 "1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0"
11619 "ae164c84-e5bd0366-ba937a6d-65414092-f294d6b6",
11620 "3ca69615-fcd4a4fb-e5f2cc9d-9c7a49a5-add98bbf"
11621 ], 11673 ],
11622 "Type" : "Study" 11674 "Type" : "Study"
11623 } 11675 }
11624 } 11676 }
11625 } 11677 }
11632 } 11684 }
11633 }, 11685 },
11634 "/studies/{id}/anonymize" : { 11686 "/studies/{id}/anonymize" : {
11635 "post" : { 11687 "post" : {
11636 "deprecated" : false, 11688 "deprecated" : false,
11637 "description" : "Start a job that will anonymize all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series", 11689 "description" : "Start a job that will anonymize all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series",
11638 "parameters" : [ 11690 "parameters" : [
11639 { 11691 {
11640 "description" : "Orthanc identifier of the study of interest", 11692 "description" : "Orthanc identifier of the study of interest",
11641 "in" : "path", 11693 "in" : "path",
11642 "name" : "id", 11694 "name" : "id",
11705 "Synchronous" : { 11757 "Synchronous" : {
11706 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 11758 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
11707 "type" : "boolean" 11759 "type" : "boolean"
11708 }, 11760 },
11709 "Transcode" : { 11761 "Transcode" : {
11710 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 11762 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
11711 "type" : "string" 11763 "type" : "string"
11712 } 11764 }
11713 } 11765 }
11714 } 11766 }
11715 } 11767 }
11755 "schema" : { 11807 "schema" : {
11756 "type" : "string" 11808 "type" : "string"
11757 } 11809 }
11758 }, 11810 },
11759 { 11811 {
11760 "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", 11812 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
11761 "in" : "query", 11813 "in" : "query",
11762 "name" : "transcode", 11814 "name" : "transcode",
11763 "required" : false, 11815 "required" : false,
11764 "schema" : { 11816 "schema" : {
11765 "type" : "string" 11817 "type" : "string"
11822 "Synchronous" : { 11874 "Synchronous" : {
11823 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 11875 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
11824 "type" : "boolean" 11876 "type" : "boolean"
11825 }, 11877 },
11826 "Transcode" : { 11878 "Transcode" : {
11827 "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", 11879 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
11828 "type" : "string" 11880 "type" : "string"
11829 } 11881 }
11830 } 11882 }
11831 } 11883 }
11832 } 11884 }
11836 "200" : { 11888 "200" : {
11837 "content" : { 11889 "content" : {
11838 "application/json" : { 11890 "application/json" : {
11839 "examples" : {}, 11891 "examples" : {},
11840 "schema" : { 11892 "schema" : {
11841 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 11893 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
11842 "properties" : { 11894 "properties" : {
11843 "ID" : { 11895 "ID" : {
11844 "description" : "Identifier of the job", 11896 "description" : "Identifier of the job",
11845 "type" : "string" 11897 "type" : "string"
11846 }, 11898 },
12367 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 12419 "CompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
12368 "CompressedSize" : 526970, 12420 "CompressedSize" : 526970,
12369 "ContentType" : 1, 12421 "ContentType" : 1,
12370 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248", 12422 "UncompressedMD5" : "26f3fad6ca0c355f02d57c7fa6770248",
12371 "UncompressedSize" : 526970, 12423 "UncompressedSize" : 526970,
12372 "Uuid" : "b7c99eb7-229f-464e-8f46-6878c8e79e5c" 12424 "Uuid" : "ada05909-0efc-43fd-b615-c5cafbaeacf8"
12373 } 12425 }
12374 } 12426 }
12375 } 12427 }
12376 }, 12428 },
12377 "description" : "", 12429 "description" : "",
12629 "get" : { 12681 "get" : {
12630 "deprecated" : false, 12682 "deprecated" : false,
12631 "description" : "Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL", 12683 "description" : "Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL",
12632 "parameters" : [ 12684 "parameters" : [
12633 { 12685 {
12686 "description" : "If false or missing, only retrieve the list of child instances",
12687 "in" : "query",
12688 "name" : "expand",
12689 "required" : false,
12690 "schema" : {
12691 "type" : "string"
12692 }
12693 },
12694 {
12634 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)", 12695 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)",
12635 "in" : "query", 12696 "in" : "query",
12636 "name" : "full", 12697 "name" : "full",
12637 "required" : false, 12698 "required" : false,
12638 "schema" : { 12699 "schema" : {
12673 "application/json" : { 12734 "application/json" : {
12674 "schema" : { 12735 "schema" : {
12675 "description" : "JSON array containing information about the child DICOM instances", 12736 "description" : "JSON array containing information about the child DICOM instances",
12676 "example" : [ 12737 "example" : [
12677 { 12738 {
12678 "FileSize" : 527858, 12739 "FileSize" : 169478,
12679 "FileUuid" : "42607af0-e2ca-402a-9cb4-8819a0485dbd", 12740 "FileUuid" : "208aca23-40e8-453e-bbb5-630b32612038",
12680 "ID" : "82cc1a6b-7b05d34e-cd74474b-594f0d43-94f609d8", 12741 "ID" : "6059d07c-02ae8c74-9436dc7c-007b4d5d-4c770a30",
12681 "IndexInSeries" : 3, 12742 "IndexInSeries" : 19,
12682 "Labels" : [], 12743 "Labels" : [],
12683 "{...}" : "..." 12744 "{...}" : "..."
12684 }, 12745 },
12685 { 12746 {
12686 "FileSize" : 527858, 12747 "FileSize" : 169414,
12687 "FileUuid" : "f986a0de-cf3b-4acc-a2ca-ce6a5844ec63", 12748 "FileUuid" : "42ab9bde-ed03-4364-9122-2921c802b85c",
12688 "ID" : "2fbd6d5f-802f6561-b9d8da32-c54ead16-18a208bd", 12749 "ID" : "f5701efb-98170697-404d15f6-59baf69e-4e8ddfae",
12689 "IndexInSeries" : 13, 12750 "IndexInSeries" : 21,
12690 "Labels" : [], 12751 "Labels" : [],
12691 "{...}" : "..." 12752 "{...}" : "..."
12692 }, 12753 },
12693 { 12754 {
12694 "FileSize" : 527858, 12755 "FileSize" : 169478,
12695 "FileUuid" : "64cc6dae-228d-4e60-82ea-34c540a09cfb", 12756 "FileUuid" : "8600a683-34b2-4b10-b33c-5dcfb77f24b6",
12696 "ID" : "4dbca7c1-f6e1a582-b3196370-0151cac8-19caac8e", 12757 "ID" : "40df6ac1-5ec86316-035ff3c1-07e5c8a8-f6cbd37c",
12697 "IndexInSeries" : 17, 12758 "IndexInSeries" : 17,
12698 "Labels" : [], 12759 "Labels" : [],
12699 "{...}" : "..." 12760 "{...}" : "..."
12700 }, 12761 },
12701 { 12762 {
12702 "FileSize" : 527858, 12763 "FileSize" : 169478,
12703 "FileUuid" : "06823b17-6217-4534-b318-4de5c9157c74", 12764 "FileUuid" : "cfa27d70-f9d9-47d9-87a2-ccff1e852f7c",
12704 "ID" : "98c6f0c7-e6f9812b-d0a9df8a-97eeaa41-fa891d8e", 12765 "ID" : "59ad98a9-7958f687-ed67451f-bb584346-8b6bdb7b",
12705 "IndexInSeries" : 6, 12766 "IndexInSeries" : 10,
12706 "Labels" : [], 12767 "Labels" : [],
12707 "{...}" : "..." 12768 "{...}" : "..."
12708 }, 12769 },
12709 { 12770 {
12710 "FileSize" : 527858, 12771 "FileSize" : 169478,
12711 "FileUuid" : "7012f4ad-e1f7-49a8-95e0-5050227b4090", 12772 "FileUuid" : "85eb4c39-0139-4193-8869-064a42e48f7f",
12712 "ID" : "c25f4e48-8f7d737e-3dbeafb5-f1563a30-eddf816c", 12773 "ID" : "4cf245ed-6ae18f9e-22e12942-2b9513f2-99a638e5",
12713 "IndexInSeries" : 20, 12774 "IndexInSeries" : 7,
12714 "Labels" : [], 12775 "Labels" : [],
12715 "{...}" : "..." 12776 "{...}" : "..."
12716 }, 12777 },
12717 "..." 12778 "..."
12718 ] 12779 ]
13087 "schema" : { 13148 "schema" : {
13088 "type" : "string" 13149 "type" : "string"
13089 } 13150 }
13090 }, 13151 },
13091 { 13152 {
13092 "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", 13153 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
13093 "in" : "query", 13154 "in" : "query",
13094 "name" : "transcode", 13155 "name" : "transcode",
13095 "required" : false, 13156 "required" : false,
13096 "schema" : { 13157 "schema" : {
13097 "type" : "string" 13158 "type" : "string"
13158 "Synchronous" : { 13219 "Synchronous" : {
13159 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 13220 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
13160 "type" : "boolean" 13221 "type" : "boolean"
13161 }, 13222 },
13162 "Transcode" : { 13223 "Transcode" : {
13163 "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", 13224 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
13164 "type" : "string" 13225 "type" : "string"
13165 } 13226 }
13166 } 13227 }
13167 } 13228 }
13168 } 13229 }
13172 "200" : { 13233 "200" : {
13173 "content" : { 13234 "content" : {
13174 "application/json" : { 13235 "application/json" : {
13175 "examples" : {}, 13236 "examples" : {},
13176 "schema" : { 13237 "schema" : {
13177 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 13238 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
13178 "properties" : { 13239 "properties" : {
13179 "ID" : { 13240 "ID" : {
13180 "description" : "Identifier of the job", 13241 "description" : "Identifier of the job",
13181 "type" : "string" 13242 "type" : "string"
13182 }, 13243 },
13202 } 13263 }
13203 }, 13264 },
13204 "/studies/{id}/merge" : { 13265 "/studies/{id}/merge" : {
13205 "post" : { 13266 "post" : {
13206 "deprecated" : false, 13267 "deprecated" : false,
13207 "description" : "Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#merging", 13268 "description" : "Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#merging",
13208 "parameters" : [ 13269 "parameters" : [
13209 { 13270 {
13210 "description" : "Orthanc identifier of the study of interest", 13271 "description" : "Orthanc identifier of the study of interest",
13211 "in" : "path", 13272 "in" : "path",
13212 "name" : "id", 13273 "name" : "id",
13318 "200" : { 13379 "200" : {
13319 "content" : { 13380 "content" : {
13320 "application/json" : { 13381 "application/json" : {
13321 "schema" : { 13382 "schema" : {
13322 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)", 13383 "description" : "JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)",
13323 "example" : [ "LastUpdate" ] 13384 "example" : [ "LastUpdate", "MainDicomTagsSignature" ]
13324 } 13385 }
13325 } 13386 }
13326 }, 13387 },
13327 "description" : "" 13388 "description" : ""
13328 } 13389 }
13476 } 13537 }
13477 }, 13538 },
13478 "/studies/{id}/modify" : { 13539 "/studies/{id}/modify" : {
13479 "post" : { 13540 "post" : {
13480 "deprecated" : false, 13541 "deprecated" : false,
13481 "description" : "Start a job that will modify all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series", 13542 "description" : "Start a job that will modify all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series",
13482 "parameters" : [ 13543 "parameters" : [
13483 { 13544 {
13484 "description" : "Orthanc identifier of the study of interest", 13545 "description" : "Orthanc identifier of the study of interest",
13485 "in" : "path", 13546 "in" : "path",
13486 "name" : "id", 13547 "name" : "id",
13545 "Synchronous" : { 13606 "Synchronous" : {
13546 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 13607 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
13547 "type" : "boolean" 13608 "type" : "boolean"
13548 }, 13609 },
13549 "Transcode" : { 13610 "Transcode" : {
13550 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 13611 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
13551 "type" : "string" 13612 "type" : "string"
13552 } 13613 }
13553 } 13614 }
13554 } 13615 }
13555 } 13616 }
13859 "description" : "Information about the parent DICOM patient", 13920 "description" : "Information about the parent DICOM patient",
13860 "example" : { 13921 "example" : {
13861 "ID" : "16738bc3-e47ed42a-43ce044c-a3414a45-cb069bd0", 13922 "ID" : "16738bc3-e47ed42a-43ce044c-a3414a45-cb069bd0",
13862 "IsStable" : true, 13923 "IsStable" : true,
13863 "Labels" : [], 13924 "Labels" : [],
13864 "LastUpdate" : "20180414T091532", 13925 "LastUpdate" : "20231109T160811",
13865 "MainDicomTags" : { 13926 "MainDicomTags" : {
13866 "PatientBirthDate" : "19490301", 13927 "PatientBirthDate" : "19490301",
13867 "PatientID" : "5Yp0E", 13928 "PatientID" : "5Yp0E",
13868 "PatientName" : "BRAINIX", 13929 "PatientName" : "BRAINIX",
13869 "PatientSex" : "0000" 13930 "PatientSex" : "0000"
13924 "get" : { 13985 "get" : {
13925 "deprecated" : false, 13986 "deprecated" : false,
13926 "description" : "Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL", 13987 "description" : "Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL",
13927 "parameters" : [ 13988 "parameters" : [
13928 { 13989 {
13990 "description" : "If false or missing, only retrieve the list of child series",
13991 "in" : "query",
13992 "name" : "expand",
13993 "required" : false,
13994 "schema" : {
13995 "type" : "string"
13996 }
13997 },
13998 {
13929 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)", 13999 "description" : "If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)",
13930 "in" : "query", 14000 "in" : "query",
13931 "name" : "full", 14001 "name" : "full",
13932 "required" : false, 14002 "required" : false,
13933 "schema" : { 14003 "schema" : {
13969 "schema" : { 14039 "schema" : {
13970 "description" : "JSON array containing information about the child DICOM series", 14040 "description" : "JSON array containing information about the child DICOM series",
13971 "example" : [ 14041 "example" : [
13972 { 14042 {
13973 "ExpectedNumberOfInstances" : null, 14043 "ExpectedNumberOfInstances" : null,
13974 "ID" : "635faa23-fd8378ee-d03bce29-ee47c2fb-a65c5509", 14044 "ID" : "ae164c84-e5bd0366-ba937a6d-65414092-f294d6b6",
13975 "Instances" : [ 14045 "Instances" : [
13976 "ed8aacd6-5d2cfad4-9e1a2f77-edf1cee5-8f3bdde0", 14046 "c2844203-2847dbbf-9cebc5f8-7c6e430d-46dc6b65",
13977 "7a93b85e-5956dbf9-894c1f27-dc73112f-4cbcda70", 14047 "f6581db2-3615fae4-a3ac132f-bbe4aee1-17e20af0",
13978 "065baa49-a7b4e4a0-e7468f1d-e9b5bca8-56316fa2", 14048 "8e098491-cec2ab54-e895deb2-a535f068-54dfa2ff",
13979 "ca69bc1a-a4fcc0a8-9e6828b0-c816dbaa-240fdc45", 14049 "00330d0f-911e5e8d-1e305bae-e5c53b73-d2a49298",
13980 "edd8ff85-9805d97a-2375f736-40662993-aef40418", 14050 "1c492d29-eaee29f4-84b25276-30eeff8b-fd47cb85",
13981 "..." 14051 "..."
13982 ], 14052 ],
13983 "IsStable" : true, 14053 "IsStable" : true,
13984 "Labels" : [], 14054 "Labels" : [],
13985 "{...}" : "..." 14055 "{...}" : "..."
13986 }, 14056 },
13987 { 14057 {
13988 "ExpectedNumberOfInstances" : null, 14058 "ExpectedNumberOfInstances" : null,
13989 "ID" : "dc0216d2-a406a5ad-31ef7a78-113ae9d9-29939f9e", 14059 "ID" : "3ca69615-fcd4a4fb-e5f2cc9d-9c7a49a5-add98bbf",
13990 "Instances" : [ 14060 "Instances" : [
13991 "2cd73574-190bb147-0a86bcca-68c75104-d22f09dd", 14061 "af359625-b4989dec-8bf86813-3c7324c3-065ca845",
13992 "ff95b7c0-d14e3e42-d642eacd-281cb07c-4e0bbc8b", 14062 "7f4ba1f7-6d0f26e0-2084254d-d0d2a66d-86ba5135",
13993 "22384bf2-0bbe7bdb-013f6ff2-f7834e9f-3d8754bf", 14063 "4dbca7c1-f6e1a582-b3196370-0151cac8-19caac8e",
13994 "3e50a403-17c8ce10-6e0234e3-a8bed1bf-3dbc54ee", 14064 "e5dca4e6-df508be3-33c2e526-386ca449-101f5a04",
13995 "3db0ed84-61a28da4-72a52d5a-3f7daa77-b81ddf17", 14065 "5d85c7d5-58bd5d4c-1545b66b-f343dee5-8624943f",
13996 "..." 14066 "..."
13997 ], 14067 ],
13998 "IsStable" : true, 14068 "IsStable" : true,
13999 "Labels" : [], 14069 "Labels" : [],
14000 "{...}" : "..." 14070 "{...}" : "..."
14001 }, 14071 },
14002 { 14072 {
14003 "ExpectedNumberOfInstances" : null, 14073 "ExpectedNumberOfInstances" : null,
14004 "ID" : "1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0", 14074 "ID" : "2ac1316d-3e432022-62eabff2-c59f5475-9b1ac3f8",
14005 "Instances" : [ 14075 "Instances" : [
14006 "2db53a93-91179cd5-f2080c32-c9b156ec-b8f65fa7", 14076 "3d452ed9-55e92667-3aeaa943-ef7ac7b7-c1d910ba",
14007 "9058e01a-31a7d982-1691e575-a8607d94-29a9aaca", 14077 "81cb1a6d-64f63651-d7023a43-28c0b72e-b50075b5",
14008 "40df6ac1-5ec86316-035ff3c1-07e5c8a8-f6cbd37c", 14078 "00402ce7-ac05c687-4d0839bc-cecd4fad-3d1b7eed",
14009 "144ca294-6e759cfb-e14e3404-e78a0a29-1dd3273c", 14079 "8c313325-8991e5e0-230eefbf-0787185f-9f247e3d",
14010 "3b2a215c-2560d4b0-e3730c07-87d3fa7d-3fef44ed", 14080 "f9fb8cb4-67023766-442eb9ff-697f66e9-7ccbe176",
14011 "..." 14081 "..."
14012 ], 14082 ],
14013 "IsStable" : true, 14083 "IsStable" : true,
14014 "Labels" : [], 14084 "Labels" : [],
14015 "{...}" : "..." 14085 "{...}" : "..."
14016 }, 14086 },
14017 { 14087 {
14018 "ExpectedNumberOfInstances" : null, 14088 "ExpectedNumberOfInstances" : null,
14019 "ID" : "4baa97c7-d53d3d82-a5eb9403-17ef5a77-4e0efb55", 14089 "ID" : "635faa23-fd8378ee-d03bce29-ee47c2fb-a65c5509",
14020 "Instances" : [ 14090 "Instances" : [
14021 "9b41ef96-b4031ffc-b1b7ea5d-8a38d55d-fe804601", 14091 "15aa5488-fdeb2c38-d5e49109-23879aff-83f9acbd",
14022 "8137542c-069dd229-d0226fba-f8c571cd-19c7b61a", 14092 "0a3d6e84-30f0133e-8ff54580-f9b49ea9-2bc5c9aa",
14023 "985681e7-99cd2ce5-f7d79f12-27bfc29f-0e5a4d72", 14093 "065baa49-a7b4e4a0-e7468f1d-e9b5bca8-56316fa2",
14024 "f0b9f0ab-110181f8-ce83a1a2-4d8eb2c9-0b682503", 14094 "2623949c-6c314b62-824d30cc-79ae73ec-210298a5",
14025 "ef13019a-9edf339d-395d8632-558518bf-b82b1b21", 14095 "c9fcb81d-9644e671-54069338-6b3f01bf-1251713a",
14026 "..." 14096 "..."
14027 ], 14097 ],
14028 "IsStable" : true, 14098 "IsStable" : true,
14029 "Labels" : [], 14099 "Labels" : [],
14030 "{...}" : "..." 14100 "{...}" : "..."
14031 }, 14101 },
14032 { 14102 {
14033 "ExpectedNumberOfInstances" : null, 14103 "ExpectedNumberOfInstances" : null,
14034 "ID" : "2ac1316d-3e432022-62eabff2-c59f5475-9b1ac3f8", 14104 "ID" : "dc0216d2-a406a5ad-31ef7a78-113ae9d9-29939f9e",
14035 "Instances" : [ 14105 "Instances" : [
14036 "61eeef27-cb5515a3-0860ab44-90125207-a56e6883", 14106 "9012697e-f3940497-8f5c35b9-49e7e62e-9fbf5365",
14037 "18bc4146-4bb09c43-e4080c80-19bfc186-6b3d7272", 14107 "205b7183-17ae9444-1a245339-5f1cad9d-0c8e761e",
14038 "00402ce7-ac05c687-4d0839bc-cecd4fad-3d1b7eed", 14108 "c22daa01-b9261803-5d3338bd-70bdcc9a-e46a813d",
14039 "ea902bf2-6dc22ee9-e962333a-7ce2c27f-d684977e", 14109 "a00470ef-7bd55ce9-a10252de-0b3758ea-75859fd4",
14040 "8371936f-4141219a-ca7d69df-0d82697e-271eef91", 14110 "17f2e7f4-f66af68b-007ff348-24988949-1778251f",
14041 "..." 14111 "..."
14042 ], 14112 ],
14043 "IsStable" : true, 14113 "IsStable" : true,
14044 "Labels" : [], 14114 "Labels" : [],
14045 "{...}" : "..." 14115 "{...}" : "..."
14134 } 14204 }
14135 }, 14205 },
14136 "/studies/{id}/split" : { 14206 "/studies/{id}/split" : {
14137 "post" : { 14207 "post" : {
14138 "deprecated" : false, 14208 "deprecated" : false,
14139 "description" : "Start a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, by taking some of its children series or instances out of it and putting them into a brand new study (this new study is created by setting the `StudyInstanceUID` tag to a random identifier): https://book.orthanc-server.com/users/anonymization.html#splitting", 14209 "description" : "Start a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, by taking some of its children series or instances out of it and putting them into a brand new study (this new study is created by setting the `StudyInstanceUID` tag to a random identifier): https://orthanc.uclouvain.be/book/users/anonymization.html#splitting",
14140 "parameters" : [ 14210 "parameters" : [
14141 { 14211 {
14142 "description" : "Orthanc identifier of the study of interest", 14212 "description" : "Orthanc identifier of the study of interest",
14143 "in" : "path", 14213 "in" : "path",
14144 "name" : "id", 14214 "name" : "id",
14257 "CountSeries" : 7, 14327 "CountSeries" : 7,
14258 "DicomDiskSize" : "68153234", 14328 "DicomDiskSize" : "68153234",
14259 "DicomDiskSizeMB" : 64, 14329 "DicomDiskSizeMB" : 64,
14260 "DicomUncompressedSize" : "68153234", 14330 "DicomUncompressedSize" : "68153234",
14261 "DicomUncompressedSizeMB" : 64, 14331 "DicomUncompressedSizeMB" : 64,
14262 "DiskSize" : "72203548", 14332 "DiskSize" : "68153234",
14263 "DiskSizeMB" : 68, 14333 "DiskSizeMB" : 64,
14264 "UncompressedSize" : "72203548", 14334 "UncompressedSize" : "68153234",
14265 "UncompressedSizeMB" : 68 14335 "UncompressedSizeMB" : 64
14266 }, 14336 },
14267 "properties" : { 14337 "properties" : {
14268 "CountInstances" : { 14338 "CountInstances" : {
14269 "description" : "Number of child instances within this study", 14339 "description" : "Number of child instances within this study",
14270 "type" : "number" 14340 "type" : "number"
14326 "content" : { 14396 "content" : {
14327 "application/json" : { 14397 "application/json" : {
14328 "schema" : { 14398 "schema" : {
14329 "description" : "", 14399 "description" : "",
14330 "example" : { 14400 "example" : {
14331 "ApiVersion" : 20, 14401 "ApiVersion" : 21,
14332 "CheckRevisions" : false, 14402 "CheckRevisions" : false,
14333 "DatabaseBackendPlugin" : null, 14403 "DatabaseBackendPlugin" : null,
14334 "DatabaseServerIdentifier" : "d67a54ff-aa19a273-ead8ba48-fa279633-f9654ab4", 14404 "DatabaseServerIdentifier" : "a67fa91c-20328956-26614107-bbaec3f4-5cbbc6f9",
14335 "DatabaseVersion" : 6, 14405 "DatabaseVersion" : 6,
14336 "DicomAet" : "ORTHANC", 14406 "DicomAet" : "ORTHANC",
14337 "DicomPort" : 4242, 14407 "DicomPort" : 4242,
14338 "HasLabels" : true, 14408 "HasLabels" : true,
14339 "HttpPort" : 8042, 14409 "HttpPort" : 8042,
14340 "IngestTranscoding" : "", 14410 "IngestTranscoding" : "",
14341 "IsHttpServerSecure" : false, 14411 "IsHttpServerSecure" : true,
14342 "MainDicomTags" : { 14412 "MainDicomTags" : {
14343 "Instance" : "0008,0012;0008,0013;0008,0018;0020,0012;0020,0013;0020,0032;0020,0037;0020,0100;0020,4000;0028,0008;0054,1330", 14413 "Instance" : "0008,0012;0008,0013;0008,0018;0020,0012;0020,0013;0020,0032;0020,0037;0020,0100;0020,4000;0028,0008;0054,1330",
14344 "Patient" : "0010,0010;0010,0020;0010,0030;0010,0040;0010,1000", 14414 "Patient" : "0010,0010;0010,0020;0010,0030;0010,0040;0010,1000",
14345 "Series" : "0008,0021;0008,0031;0008,0060;0008,0070;0008,1010;0008,103e;0008,1070;0018,0010;0018,0015;0018,0024;0018,1030;0018,1090;0018,1400;0020,000e;0020,0011;0020,0037;0020,0105;0020,1002;0040,0254;0054,0081;0054,0101;0054,1000", 14415 "Series" : "0008,0021;0008,0031;0008,0060;0008,0070;0008,1010;0008,103e;0008,1070;0018,0010;0018,0015;0018,0024;0018,1030;0018,1090;0018,1400;0020,000e;0020,0011;0020,0037;0020,0105;0020,1002;0040,0254;0054,0081;0054,0101;0054,1000",
14346 "Study" : "0008,0020;0008,0030;0008,0050;0008,0080;0008,0090;0008,1030;0020,000d;0020,0010;0032,1032;0032,1060" 14416 "Study" : "0008,0020;0008,0030;0008,0050;0008,0080;0008,0090;0008,1030;0020,000d;0020,0010;0032,1032;0032,1060"
14351 "OverwriteInstances" : false, 14421 "OverwriteInstances" : false,
14352 "PluginsEnabled" : true, 14422 "PluginsEnabled" : true,
14353 "StorageAreaPlugin" : null, 14423 "StorageAreaPlugin" : null,
14354 "StorageCompression" : false, 14424 "StorageCompression" : false,
14355 "UserMetadata" : {}, 14425 "UserMetadata" : {},
14356 "Version" : "1.12.0" 14426 "Version" : "1.12.1"
14357 }, 14427 },
14358 "properties" : { 14428 "properties" : {
14359 "ApiVersion" : { 14429 "ApiVersion" : {
14360 "description" : "Version of the REST API", 14430 "description" : "Version of the REST API",
14361 "type" : "number" 14431 "type" : "number"
14371 "DatabaseServerIdentifier" : { 14441 "DatabaseServerIdentifier" : {
14372 "description" : "ID of the server in the database (when running multiple Orthanc on the same DB)", 14442 "description" : "ID of the server in the database (when running multiple Orthanc on the same DB)",
14373 "type" : "string" 14443 "type" : "string"
14374 }, 14444 },
14375 "DatabaseVersion" : { 14445 "DatabaseVersion" : {
14376 "description" : "Version of the database: https://book.orthanc-server.com/developers/db-versioning.html", 14446 "description" : "Version of the database: https://orthanc.uclouvain.be/book/developers/db-versioning.html",
14377 "type" : "number" 14447 "type" : "number"
14378 }, 14448 },
14379 "DicomAet" : { 14449 "DicomAet" : {
14380 "description" : "The DICOM AET of Orthanc", 14450 "description" : "The DICOM AET of Orthanc",
14381 "type" : "string" 14451 "type" : "string"
14395 "IngestTranscoding" : { 14465 "IngestTranscoding" : {
14396 "description" : "Whether instances are transcoded when ingested into Orthanc (`` if no transcoding is performed) (new in Orthanc 1.11.0)", 14466 "description" : "Whether instances are transcoded when ingested into Orthanc (`` if no transcoding is performed) (new in Orthanc 1.11.0)",
14397 "type" : "string" 14467 "type" : "string"
14398 }, 14468 },
14399 "IsHttpServerSecure" : { 14469 "IsHttpServerSecure" : {
14400 "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", 14470 "description" : "Whether the REST API is properly secured (assuming no reverse proxy is in use): https://orthanc.uclouvain.be/book/faq/security.html#securing-the-http-server",
14401 "type" : "boolean" 14471 "type" : "boolean"
14402 }, 14472 },
14403 "MainDicomTags" : { 14473 "MainDicomTags" : {
14404 "description" : "The list of MainDicomTags saved in DB for each resource level (new in Orthanc 1.11.0)", 14474 "description" : "The list of MainDicomTags saved in DB for each resource level (new in Orthanc 1.11.0)",
14405 "type" : "object" 14475 "type" : "object"
14635 "Synchronous" : { 14705 "Synchronous" : {
14636 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 14706 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
14637 "type" : "boolean" 14707 "type" : "boolean"
14638 }, 14708 },
14639 "Transcode" : { 14709 "Transcode" : {
14640 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 14710 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
14641 "type" : "string" 14711 "type" : "string"
14642 } 14712 }
14643 } 14713 }
14644 } 14714 }
14645 } 14715 }
14823 "Synchronous" : { 14893 "Synchronous" : {
14824 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.", 14894 "description" : "If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.",
14825 "type" : "boolean" 14895 "type" : "boolean"
14826 }, 14896 },
14827 "Transcode" : { 14897 "Transcode" : {
14828 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html", 14898 "description" : "Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
14829 "type" : "string" 14899 "type" : "string"
14830 } 14900 }
14831 } 14901 }
14832 } 14902 }
14833 } 14903 }
14859 "summary" : "Modify a set of resources", 14929 "summary" : "Modify a set of resources",
14860 "tags" : [ "System" ] 14930 "tags" : [ "System" ]
14861 } 14931 }
14862 }, 14932 },
14863 "/tools/create-archive" : { 14933 "/tools/create-archive" : {
14934 "get" : {
14935 "deprecated" : false,
14936 "description" : "Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument",
14937 "parameters" : [
14938 {
14939 "description" : "A comma separated list of Orthanc resource identifiers to include in the ZIP archive.",
14940 "in" : "query",
14941 "name" : "resources",
14942 "required" : true,
14943 "schema" : {
14944 "type" : "string"
14945 }
14946 },
14947 {
14948 "description" : "If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
14949 "in" : "query",
14950 "name" : "transcode",
14951 "required" : false,
14952 "schema" : {
14953 "type" : "string"
14954 }
14955 }
14956 ],
14957 "responses" : {
14958 "200" : {
14959 "description" : ""
14960 }
14961 },
14962 "summary" : "Create ZIP archive",
14963 "tags" : [ "System" ]
14964 },
14864 "post" : { 14965 "post" : {
14865 "deprecated" : false, 14966 "deprecated" : false,
14866 "description" : "Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body", 14967 "description" : "Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body",
14867 "parameters" : [], 14968 "parameters" : [],
14868 "requestBody" : { 14969 "requestBody" : {
14889 "Synchronous" : { 14990 "Synchronous" : {
14890 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 14991 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
14891 "type" : "boolean" 14992 "type" : "boolean"
14892 }, 14993 },
14893 "Transcode" : { 14994 "Transcode" : {
14894 "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", 14995 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
14895 "type" : "string" 14996 "type" : "string"
14896 } 14997 }
14897 } 14998 }
14898 } 14999 }
14899 } 15000 }
14903 "200" : { 15004 "200" : {
14904 "content" : { 15005 "content" : {
14905 "application/json" : { 15006 "application/json" : {
14906 "examples" : {}, 15007 "examples" : {},
14907 "schema" : { 15008 "schema" : {
14908 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 15009 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
14909 "properties" : { 15010 "properties" : {
14910 "ID" : { 15011 "ID" : {
14911 "description" : "Identifier of the job", 15012 "description" : "Identifier of the job",
14912 "type" : "string" 15013 "type" : "string"
14913 }, 15014 },
14998 "summary" : "Create one DICOM instance", 15099 "summary" : "Create one DICOM instance",
14999 "tags" : [ "System" ] 15100 "tags" : [ "System" ]
15000 } 15101 }
15001 }, 15102 },
15002 "/tools/create-media" : { 15103 "/tools/create-media" : {
15104 "get" : {
15105 "deprecated" : false,
15106 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument",
15107 "parameters" : [
15108 {
15109 "description" : "A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media.",
15110 "in" : "query",
15111 "name" : "resources",
15112 "required" : true,
15113 "schema" : {
15114 "type" : "string"
15115 }
15116 },
15117 {
15118 "description" : "If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
15119 "in" : "query",
15120 "name" : "transcode",
15121 "required" : false,
15122 "schema" : {
15123 "type" : "string"
15124 }
15125 }
15126 ],
15127 "responses" : {
15128 "200" : {
15129 "description" : ""
15130 }
15131 },
15132 "summary" : "Create DICOMDIR media",
15133 "tags" : [ "System" ]
15134 },
15003 "post" : { 15135 "post" : {
15004 "deprecated" : false, 15136 "deprecated" : false,
15005 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body", 15137 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body",
15006 "parameters" : [], 15138 "parameters" : [],
15007 "requestBody" : { 15139 "requestBody" : {
15032 "Synchronous" : { 15164 "Synchronous" : {
15033 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 15165 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
15034 "type" : "boolean" 15166 "type" : "boolean"
15035 }, 15167 },
15036 "Transcode" : { 15168 "Transcode" : {
15037 "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", 15169 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
15038 "type" : "string" 15170 "type" : "string"
15039 } 15171 }
15040 } 15172 }
15041 } 15173 }
15042 } 15174 }
15046 "200" : { 15178 "200" : {
15047 "content" : { 15179 "content" : {
15048 "application/json" : { 15180 "application/json" : {
15049 "examples" : {}, 15181 "examples" : {},
15050 "schema" : { 15182 "schema" : {
15051 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 15183 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
15052 "properties" : { 15184 "properties" : {
15053 "ID" : { 15185 "ID" : {
15054 "description" : "Identifier of the job", 15186 "description" : "Identifier of the job",
15055 "type" : "string" 15187 "type" : "string"
15056 }, 15188 },
15074 "summary" : "Create DICOMDIR media", 15206 "summary" : "Create DICOMDIR media",
15075 "tags" : [ "System" ] 15207 "tags" : [ "System" ]
15076 } 15208 }
15077 }, 15209 },
15078 "/tools/create-media-extended" : { 15210 "/tools/create-media-extended" : {
15211 "get" : {
15212 "deprecated" : false,
15213 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument",
15214 "parameters" : [
15215 {
15216 "description" : "A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media.",
15217 "in" : "query",
15218 "name" : "resources",
15219 "required" : true,
15220 "schema" : {
15221 "type" : "string"
15222 }
15223 },
15224 {
15225 "description" : "If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
15226 "in" : "query",
15227 "name" : "transcode",
15228 "required" : false,
15229 "schema" : {
15230 "type" : "string"
15231 }
15232 }
15233 ],
15234 "responses" : {
15235 "200" : {
15236 "description" : ""
15237 }
15238 },
15239 "summary" : "Create DICOMDIR media",
15240 "tags" : [ "System" ]
15241 },
15079 "post" : { 15242 "post" : {
15080 "deprecated" : false, 15243 "deprecated" : false,
15081 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body", 15244 "description" : "Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body",
15082 "parameters" : [], 15245 "parameters" : [],
15083 "requestBody" : { 15246 "requestBody" : {
15108 "Synchronous" : { 15271 "Synchronous" : {
15109 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.", 15272 "description" : "If `true`, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option \"SynchronousZipStream\" is set to \"false\", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.",
15110 "type" : "boolean" 15273 "type" : "boolean"
15111 }, 15274 },
15112 "Transcode" : { 15275 "Transcode" : {
15113 "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", 15276 "description" : "If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html",
15114 "type" : "string" 15277 "type" : "string"
15115 } 15278 }
15116 } 15279 }
15117 } 15280 }
15118 } 15281 }
15122 "200" : { 15285 "200" : {
15123 "content" : { 15286 "content" : {
15124 "application/json" : { 15287 "application/json" : {
15125 "examples" : {}, 15288 "examples" : {},
15126 "schema" : { 15289 "schema" : {
15127 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://book.orthanc-server.com/users/advanced-rest.html#jobs", 15290 "description" : "In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs",
15128 "properties" : { 15291 "properties" : {
15129 "ID" : { 15292 "ID" : {
15130 "description" : "Identifier of the job", 15293 "description" : "Identifier of the job",
15131 "type" : "string" 15294 "type" : "string"
15132 }, 15295 },
15301 } 15464 }
15302 }, 15465 },
15303 "/tools/find" : { 15466 "/tools/find" : {
15304 "post" : { 15467 "post" : {
15305 "deprecated" : false, 15468 "deprecated" : false,
15306 "description" : "This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://book.orthanc-server.com/users/rest.html#performing-finds-within-orthanc", 15469 "description" : "This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://orthanc.uclouvain.be/book/users/rest.html#performing-finds-within-orthanc",
15307 "parameters" : [], 15470 "parameters" : [],
15308 "requestBody" : { 15471 "requestBody" : {
15309 "content" : { 15472 "content" : {
15310 "application/json" : { 15473 "application/json" : {
15311 "schema" : { 15474 "schema" : {
15416 } 15579 }
15417 }, 15580 },
15418 "/tools/invalidate-tags" : { 15581 "/tools/invalidate-tags" : {
15419 "post" : { 15582 "post" : {
15420 "deprecated" : false, 15583 "deprecated" : false,
15421 "description" : "Remove all the attachments of the type \"DICOM-as-JSON\" that are associated will all the DICOM instances stored in Orthanc. These summaries will be automatically re-created on the next access. This is notably useful after changes to the `Dictionary` configuration option. https://book.orthanc-server.com/faq/orthanc-storage.html#storage-area", 15584 "description" : "Remove all the attachments of the type \"DICOM-as-JSON\" that are associated will all the DICOM instances stored in Orthanc. These summaries will be automatically re-created on the next access. This is notably useful after changes to the `Dictionary` configuration option. https://orthanc.uclouvain.be/book/faq/orthanc-storage.html#storage-area",
15422 "parameters" : [], 15585 "parameters" : [],
15423 "responses" : { 15586 "responses" : {
15424 "200" : { 15587 "200" : {
15425 "description" : "" 15588 "description" : ""
15426 } 15589 }
15870 } 16033 }
15871 }, 16034 },
15872 "/tools/metrics-prometheus" : { 16035 "/tools/metrics-prometheus" : {
15873 "get" : { 16036 "get" : {
15874 "deprecated" : false, 16037 "deprecated" : false,
15875 "description" : "Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://book.orthanc-server.com/users/advanced-rest.html#instrumentation-with-prometheus", 16038 "description" : "Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus",
15876 "parameters" : [], 16039 "parameters" : [],
15877 "responses" : { 16040 "responses" : {
15878 "200" : { 16041 "200" : {
15879 "content" : { 16042 "content" : {
15880 "text/plain" : { 16043 "text/plain" : {
15881 "example" : "orthanc_count_instances 2552 1688489399993\northanc_count_patients 8 1688489399993\northanc_count_series 26 1688489399993\northanc_count_studies 8 1688489399993\northanc_dicom_cache_count 5 1688475481515\northanc_dicom_cache_size 0.636888504 1688475481515\northanc_disk_size_mb 1018.65021 1688489399993\northanc_jobs_completed 10 1688489399993\northanc_jobs_failed 1 1688489399993\northanc_jobs_pending 0 1688489399993\northanc_jobs_running 0 1688489399993\northanc_jobs_success 9 1688489399993\northanc_last_change 5395 1688489399993\northanc_rest_api_active_requests 1 1688489399991\northanc_rest_api_duration_ms 582 1688489398151\northanc_storage_read_duration_ms 17 1688489397639\northanc_uncompressed_size_mb 1018.65021 1688489399993\northanc_up_time_s 172856 1688489399993\n" 16044 "example" : "orthanc_count_instances 2352 1702975679493\northanc_count_patients 7 1702975679493\northanc_count_series 23 1702975679493\northanc_count_studies 7 1702975679493\northanc_dicom_cache_count 353 1702919989969\northanc_dicom_cache_size 127.878067 1702919989969\northanc_disk_size_mb 840.589417 1702975679493\northanc_jobs_completed 10 1702975679493\northanc_jobs_failed 4 1702975679493\northanc_jobs_pending 0 1702975679493\northanc_jobs_running 0 1702975679493\northanc_jobs_success 6 1702975679493\northanc_last_change 4778 1702975679493\northanc_rest_api_active_requests 1 1702975679493\northanc_rest_api_duration_ms 361 1702975672107\northanc_storage_read_duration_ms 0 1702975473995\northanc_uncompressed_size_mb 840.589417 1702975679493\northanc_up_time_s 605413 1702975679493\n"
15882 } 16045 }
15883 }, 16046 },
15884 "description" : "" 16047 "description" : ""
15885 } 16048 }
15886 }, 16049 },
15895 "parameters" : [], 16058 "parameters" : [],
15896 "responses" : { 16059 "responses" : {
15897 "200" : { 16060 "200" : {
15898 "content" : { 16061 "content" : {
15899 "text/plain" : { 16062 "text/plain" : {
15900 "example" : "20230704T165000", 16063 "example" : "20231219T084759",
15901 "schema" : { 16064 "schema" : {
15902 "description" : "The UTC time" 16065 "description" : "The UTC time"
15903 } 16066 }
15904 } 16067 }
15905 }, 16068 },
15917 "parameters" : [], 16080 "parameters" : [],
15918 "responses" : { 16081 "responses" : {
15919 "200" : { 16082 "200" : {
15920 "content" : { 16083 "content" : {
15921 "text/plain" : { 16084 "text/plain" : {
15922 "example" : "20230704T165000", 16085 "example" : "20231219T084759",
15923 "schema" : { 16086 "schema" : {
15924 "description" : "The local time" 16087 "description" : "The local time"
15925 } 16088 }
15926 } 16089 }
15927 }, 16090 },
16033 } 16196 }
16034 } 16197 }
16035 }, 16198 },
16036 "servers" : [ 16199 "servers" : [
16037 { 16200 {
16038 "url" : "https://demo.orthanc-server.com/" 16201 "url" : "https://orthanc.uclouvain.be/demo/"
16039 } 16202 }
16040 ] 16203 ]
16041 } 16204 }