Mercurial > hg > orthanc-book

comparison OpenAPI/orthanc-openapi.json @ 817:01fa632daae9 Orthanc-1.10.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Orthanc 1.10.0
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 23 Feb 2022 15:03:44 +0100
parents 4e9dc26a5cb9
children e95713f90614
comparison
equal deleted inserted replaced
816:908ca7847b9d 817:01fa632daae9
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://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)).",
4 "title" : "Orthanc API", 4 "title" : "Orthanc API",
5 "version" : "1.9.7" 5 "version" : "1.10.0"
6 }, 6 },
7 "openapi" : "3.0.0", 7 "openapi" : "3.0.0",
8 "paths" : { 8 "paths" : {
9 "/changes" : { 9 "/changes" : {
10 "delete" : { 10 "delete" : {
461 "get" : { 461 "get" : {
462 "deprecated" : false, 462 "deprecated" : false,
463 "description" : "Get the list of attachments that are associated with the given instance", 463 "description" : "Get the list of attachments that are associated with the given instance",
464 "parameters" : [ 464 "parameters" : [
465 { 465 {
466 "description" : "If present, retrieve the attachments list and their numerical ids",
467 "in" : "query",
468 "name" : "full",
469 "required" : false,
470 "schema" : {
471 "type" : "string"
472 }
473 },
474 {
466 "description" : "Orthanc identifier of the instance of interest", 475 "description" : "Orthanc identifier of the instance of interest",
467 "in" : "path", 476 "in" : "path",
468 "name" : "id", 477 "name" : "id",
469 "required" : true, 478 "required" : true,
470 "schema" : { 479 "schema" : {
903 }, 912 },
904 "summary" : "Get attachment", 913 "summary" : "Get attachment",
905 "tags" : [ "Instances" ] 914 "tags" : [ "Instances" ]
906 } 915 }
907 }, 916 },
917 "/instances/{id}/attachments/{name}/info" : {
918 "get" : {
919 "deprecated" : false,
920 "description" : "Get all the information about the attachment associated with the given instance",
921 "parameters" : [
922 {
923 "description" : "Optional revision of the attachment, to check if its content has changed",
924 "in" : "header",
925 "name" : "If-None-Match",
926 "required" : false,
927 "schema" : {
928 "type" : "string"
929 }
930 },
931 {
932 "description" : "Orthanc identifier of the instance of interest",
933 "in" : "path",
934 "name" : "id",
935 "required" : true,
936 "schema" : {
937 "type" : "string"
938 }
939 },
940 {
941 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
942 "in" : "path",
943 "name" : "name",
944 "required" : true,
945 "schema" : {
946 "type" : "string"
947 }
948 }
949 ],
950 "responses" : {
951 "200" : {
952 "content" : {
953 "application/json" : {
954 "examples" : {},
955 "schema" : {
956 "description" : "JSON object containing the information about the attachment"
957 }
958 }
959 },
960 "description" : "",
961 "headers" : {
962 "ETag" : {
963 "description" : "Revision of the attachment, to be used in further `PUT` or `DELETE` operations"
964 }
965 }
966 }
967 },
968 "summary" : "Get info about the attachment",
969 "tags" : [ "Instances" ]
970 }
971 },
908 "/instances/{id}/attachments/{name}/is-compressed" : { 972 "/instances/{id}/attachments/{name}/is-compressed" : {
909 "get" : { 973 "get" : {
910 "deprecated" : false, 974 "deprecated" : false,
911 "description" : "Test whether the attachment has been stored as a compressed file on the disk.", 975 "description" : "Test whether the attachment has been stored as a compressed file on the disk.",
912 "parameters" : [ 976 "parameters" : [
1336 "example" : [ 1400 "example" : [
1337 "image-int16", 1401 "image-int16",
1338 "image-uint16", 1402 "image-uint16",
1339 "image-uint8", 1403 "image-uint8",
1340 "matlab", 1404 "matlab",
1405 "numpy",
1341 "preview", 1406 "preview",
1342 "raw", 1407 "raw",
1343 "raw.gz", 1408 "raw.gz",
1344 "rendered" 1409 "rendered"
1345 ] 1410 ]
1366 "schema" : { 1431 "schema" : {
1367 "type" : "number" 1432 "type" : "number"
1368 } 1433 }
1369 }, 1434 },
1370 { 1435 {
1436 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
1437 "in" : "query",
1438 "name" : "returnUnsupportedImage",
1439 "required" : false,
1440 "schema" : {
1441 "type" : "boolean"
1442 }
1443 },
1444 {
1371 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 1445 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
1372 "in" : "header", 1446 "in" : "header",
1373 "name" : "Accept", 1447 "name" : "Accept",
1374 "required" : false, 1448 "required" : false,
1375 "schema" : { 1449 "schema" : {
1437 "schema" : { 1511 "schema" : {
1438 "type" : "number" 1512 "type" : "number"
1439 } 1513 }
1440 }, 1514 },
1441 { 1515 {
1516 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
1517 "in" : "query",
1518 "name" : "returnUnsupportedImage",
1519 "required" : false,
1520 "schema" : {
1521 "type" : "boolean"
1522 }
1523 },
1524 {
1442 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 1525 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
1443 "in" : "header", 1526 "in" : "header",
1444 "name" : "Accept", 1527 "name" : "Accept",
1445 "required" : false, 1528 "required" : false,
1446 "schema" : { 1529 "schema" : {
1508 "schema" : { 1591 "schema" : {
1509 "type" : "number" 1592 "type" : "number"
1510 } 1593 }
1511 }, 1594 },
1512 { 1595 {
1596 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
1597 "in" : "query",
1598 "name" : "returnUnsupportedImage",
1599 "required" : false,
1600 "schema" : {
1601 "type" : "boolean"
1602 }
1603 },
1604 {
1513 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 1605 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
1514 "in" : "header", 1606 "in" : "header",
1515 "name" : "Accept", 1607 "name" : "Accept",
1516 "required" : false, 1608 "required" : false,
1517 "schema" : { 1609 "schema" : {
1605 }, 1697 },
1606 "summary" : "Decode frame for Matlab", 1698 "summary" : "Decode frame for Matlab",
1607 "tags" : [ "Instances" ] 1699 "tags" : [ "Instances" ]
1608 } 1700 }
1609 }, 1701 },
1702 "/instances/{id}/frames/{frame}/numpy" : {
1703 "get" : {
1704 "deprecated" : false,
1705 "description" : "Decode one frame of interest from the given DICOM instance, for use with numpy in Python. The numpy array has 3 dimensions: (height, width, color channel).",
1706 "parameters" : [
1707 {
1708 "description" : "Compress the file as `.npz`",
1709 "in" : "query",
1710 "name" : "compress",
1711 "required" : false,
1712 "schema" : {
1713 "type" : "boolean"
1714 }
1715 },
1716 {
1717 "description" : "On grayscale images, apply the rescaling and return floating-point values",
1718 "in" : "query",
1719 "name" : "rescale",
1720 "required" : false,
1721 "schema" : {
1722 "type" : "boolean"
1723 }
1724 },
1725 {
1726 "description" : "Index of the frame (starts at `0`)",
1727 "in" : "path",
1728 "name" : "frame",
1729 "required" : true,
1730 "schema" : {
1731 "type" : "number"
1732 }
1733 },
1734 {
1735 "description" : "Orthanc identifier of the DICOM resource of interest",
1736 "in" : "path",
1737 "name" : "id",
1738 "required" : true,
1739 "schema" : {
1740 "type" : "string"
1741 }
1742 }
1743 ],
1744 "responses" : {
1745 "200" : {
1746 "content" : {
1747 "text/plain" : {
1748 "examples" : {},
1749 "schema" : {
1750 "description" : "Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html"
1751 }
1752 }
1753 },
1754 "description" : ""
1755 }
1756 },
1757 "summary" : "Decode frame for numpy",
1758 "tags" : [ "Instances" ]
1759 }
1760 },
1610 "/instances/{id}/frames/{frame}/preview" : { 1761 "/instances/{id}/frames/{frame}/preview" : {
1611 "get" : { 1762 "get" : {
1612 "deprecated" : false, 1763 "deprecated" : false,
1613 "description" : "Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.", 1764 "description" : "Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.",
1614 "parameters" : [ 1765 "parameters" : [
1617 "in" : "query", 1768 "in" : "query",
1618 "name" : "quality", 1769 "name" : "quality",
1619 "required" : false, 1770 "required" : false,
1620 "schema" : { 1771 "schema" : {
1621 "type" : "number" 1772 "type" : "number"
1773 }
1774 },
1775 {
1776 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
1777 "in" : "query",
1778 "name" : "returnUnsupportedImage",
1779 "required" : false,
1780 "schema" : {
1781 "type" : "boolean"
1622 } 1782 }
1623 }, 1783 },
1624 { 1784 {
1625 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 1785 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
1626 "in" : "header", 1786 "in" : "header",
1779 "in" : "query", 1939 "in" : "query",
1780 "name" : "quality", 1940 "name" : "quality",
1781 "required" : false, 1941 "required" : false,
1782 "schema" : { 1942 "schema" : {
1783 "type" : "number" 1943 "type" : "number"
1944 }
1945 },
1946 {
1947 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
1948 "in" : "query",
1949 "name" : "returnUnsupportedImage",
1950 "required" : false,
1951 "schema" : {
1952 "type" : "boolean"
1784 } 1953 }
1785 }, 1954 },
1786 { 1955 {
1787 "description" : "Whether to smooth image on resize", 1956 "description" : "Whether to smooth image on resize",
1788 "in" : "query", 1957 "in" : "query",
1975 "schema" : { 2144 "schema" : {
1976 "type" : "number" 2145 "type" : "number"
1977 } 2146 }
1978 }, 2147 },
1979 { 2148 {
2149 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
2150 "in" : "query",
2151 "name" : "returnUnsupportedImage",
2152 "required" : false,
2153 "schema" : {
2154 "type" : "boolean"
2155 }
2156 },
2157 {
1980 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 2158 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
1981 "in" : "header", 2159 "in" : "header",
1982 "name" : "Accept", 2160 "name" : "Accept",
1983 "required" : false, 2161 "required" : false,
1984 "schema" : { 2162 "schema" : {
2037 "schema" : { 2215 "schema" : {
2038 "type" : "number" 2216 "type" : "number"
2039 } 2217 }
2040 }, 2218 },
2041 { 2219 {
2220 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
2221 "in" : "query",
2222 "name" : "returnUnsupportedImage",
2223 "required" : false,
2224 "schema" : {
2225 "type" : "boolean"
2226 }
2227 },
2228 {
2042 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 2229 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
2043 "in" : "header", 2230 "in" : "header",
2044 "name" : "Accept", 2231 "name" : "Accept",
2045 "required" : false, 2232 "required" : false,
2046 "schema" : { 2233 "schema" : {
2096 "in" : "query", 2283 "in" : "query",
2097 "name" : "quality", 2284 "name" : "quality",
2098 "required" : false, 2285 "required" : false,
2099 "schema" : { 2286 "schema" : {
2100 "type" : "number" 2287 "type" : "number"
2288 }
2289 },
2290 {
2291 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
2292 "in" : "query",
2293 "name" : "returnUnsupportedImage",
2294 "required" : false,
2295 "schema" : {
2296 "type" : "boolean"
2101 } 2297 }
2102 }, 2298 },
2103 { 2299 {
2104 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 2300 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
2105 "in" : "header", 2301 "in" : "header",
2551 }, 2747 },
2552 "summary" : "Get instance module", 2748 "summary" : "Get instance module",
2553 "tags" : [ "Instances" ] 2749 "tags" : [ "Instances" ]
2554 } 2750 }
2555 }, 2751 },
2752 "/instances/{id}/numpy" : {
2753 "get" : {
2754 "deprecated" : false,
2755 "description" : "Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).",
2756 "parameters" : [
2757 {
2758 "description" : "Compress the file as `.npz`",
2759 "in" : "query",
2760 "name" : "compress",
2761 "required" : false,
2762 "schema" : {
2763 "type" : "boolean"
2764 }
2765 },
2766 {
2767 "description" : "On grayscale images, apply the rescaling and return floating-point values",
2768 "in" : "query",
2769 "name" : "rescale",
2770 "required" : false,
2771 "schema" : {
2772 "type" : "boolean"
2773 }
2774 },
2775 {
2776 "description" : "Orthanc identifier of the DICOM resource of interest",
2777 "in" : "path",
2778 "name" : "id",
2779 "required" : true,
2780 "schema" : {
2781 "type" : "string"
2782 }
2783 }
2784 ],
2785 "responses" : {
2786 "200" : {
2787 "content" : {
2788 "text/plain" : {
2789 "examples" : {},
2790 "schema" : {
2791 "description" : "Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html"
2792 }
2793 }
2794 },
2795 "description" : ""
2796 }
2797 },
2798 "summary" : "Decode instance for numpy",
2799 "tags" : [ "Instances" ]
2800 }
2801 },
2556 "/instances/{id}/patient" : { 2802 "/instances/{id}/patient" : {
2557 "get" : { 2803 "get" : {
2558 "deprecated" : false, 2804 "deprecated" : false,
2559 "description" : "Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL", 2805 "description" : "Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL",
2560 "parameters" : [ 2806 "parameters" : [
2660 "schema" : { 2906 "schema" : {
2661 "type" : "number" 2907 "type" : "number"
2662 } 2908 }
2663 }, 2909 },
2664 { 2910 {
2911 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
2912 "in" : "query",
2913 "name" : "returnUnsupportedImage",
2914 "required" : false,
2915 "schema" : {
2916 "type" : "boolean"
2917 }
2918 },
2919 {
2665 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`", 2920 "description" : "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`",
2666 "in" : "header", 2921 "in" : "header",
2667 "name" : "Accept", 2922 "name" : "Accept",
2668 "required" : false, 2923 "required" : false,
2669 "schema" : { 2924 "schema" : {
2752 "in" : "query", 3007 "in" : "query",
2753 "name" : "quality", 3008 "name" : "quality",
2754 "required" : false, 3009 "required" : false,
2755 "schema" : { 3010 "schema" : {
2756 "type" : "number" 3011 "type" : "number"
3012 }
3013 },
3014 {
3015 "description" : "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)",
3016 "in" : "query",
3017 "name" : "returnUnsupportedImage",
3018 "required" : false,
3019 "schema" : {
3020 "type" : "boolean"
2757 } 3021 }
2758 }, 3022 },
2759 { 3023 {
2760 "description" : "Whether to smooth image on resize", 3024 "description" : "Whether to smooth image on resize",
2761 "in" : "query", 3025 "in" : "query",
3263 "content" : { 3527 "content" : {
3264 "application/json" : { 3528 "application/json" : {
3265 "schema" : { 3529 "schema" : {
3266 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)", 3530 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)",
3267 "example" : [ 3531 "example" : [
3268 "0c686aae-1509-4179-a8c5-1824c180bb84", 3532 "14a3cacd-fdf1-42ce-8cbe-7d882b60872b",
3269 "f30d99df-3a10-480f-96a9-d0701550f07c" 3533 "45948a0f-d176-4ca7-9efc-187a5d14f1c7",
3534 "6aae44fb-dacf-4115-ad79-77a323fd340b",
3535 "..."
3270 ] 3536 ]
3271 } 3537 }
3272 } 3538 }
3273 }, 3539 },
3274 "description" : "" 3540 "description" : ""
3612 }, 3878 },
3613 "AllowFind" : { 3879 "AllowFind" : {
3614 "description" : "Whether to accept C-FIND SCU commands issued by the remote modality", 3880 "description" : "Whether to accept C-FIND SCU commands issued by the remote modality",
3615 "type" : "boolean" 3881 "type" : "boolean"
3616 }, 3882 },
3883 "AllowFindWorklist" : {
3884 "description" : "Whether to accept C-FIND SCU commands for worklists issued by the remote modality",
3885 "type" : "boolean"
3886 },
3617 "AllowGet" : { 3887 "AllowGet" : {
3618 "description" : "Whether to accept C-GET SCU commands issued by the remote modality", 3888 "description" : "Whether to accept C-GET SCU commands issued by the remote modality",
3619 "type" : "boolean" 3889 "type" : "boolean"
3620 }, 3890 },
3621 "AllowMove" : { 3891 "AllowMove" : {
3688 "example" : { 3958 "example" : {
3689 "AET" : "ORTHANCTEST", 3959 "AET" : "ORTHANCTEST",
3690 "AllowEcho" : true, 3960 "AllowEcho" : true,
3691 "AllowEventReport" : true, 3961 "AllowEventReport" : true,
3692 "AllowFind" : true, 3962 "AllowFind" : true,
3963 "AllowFindWorklist" : true,
3693 "AllowGet" : true, 3964 "AllowGet" : true,
3694 "AllowMove" : true, 3965 "AllowMove" : true,
3695 "AllowNAction" : true, 3966 "AllowNAction" : true,
3696 "AllowStore" : true, 3967 "AllowStore" : true,
3697 "AllowTranscoding" : true, 3968 "AllowTranscoding" : true,
4743 "/patients/{id}/attachments" : { 5014 "/patients/{id}/attachments" : {
4744 "get" : { 5015 "get" : {
4745 "deprecated" : false, 5016 "deprecated" : false,
4746 "description" : "Get the list of attachments that are associated with the given patient", 5017 "description" : "Get the list of attachments that are associated with the given patient",
4747 "parameters" : [ 5018 "parameters" : [
5019 {
5020 "description" : "If present, retrieve the attachments list and their numerical ids",
5021 "in" : "query",
5022 "name" : "full",
5023 "required" : false,
5024 "schema" : {
5025 "type" : "string"
5026 }
5027 },
4748 { 5028 {
4749 "description" : "Orthanc identifier of the patient of interest", 5029 "description" : "Orthanc identifier of the patient of interest",
4750 "in" : "path", 5030 "in" : "path",
4751 "name" : "id", 5031 "name" : "id",
4752 "required" : true, 5032 "required" : true,
5183 } 5463 }
5184 } 5464 }
5185 } 5465 }
5186 }, 5466 },
5187 "summary" : "Get attachment", 5467 "summary" : "Get attachment",
5468 "tags" : [ "Patients" ]
5469 }
5470 },
5471 "/patients/{id}/attachments/{name}/info" : {
5472 "get" : {
5473 "deprecated" : false,
5474 "description" : "Get all the information about the attachment associated with the given patient",
5475 "parameters" : [
5476 {
5477 "description" : "Optional revision of the attachment, to check if its content has changed",
5478 "in" : "header",
5479 "name" : "If-None-Match",
5480 "required" : false,
5481 "schema" : {
5482 "type" : "string"
5483 }
5484 },
5485 {
5486 "description" : "Orthanc identifier of the patient of interest",
5487 "in" : "path",
5488 "name" : "id",
5489 "required" : true,
5490 "schema" : {
5491 "type" : "string"
5492 }
5493 },
5494 {
5495 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
5496 "in" : "path",
5497 "name" : "name",
5498 "required" : true,
5499 "schema" : {
5500 "type" : "string"
5501 }
5502 }
5503 ],
5504 "responses" : {
5505 "200" : {
5506 "content" : {
5507 "application/json" : {
5508 "examples" : {},
5509 "schema" : {
5510 "description" : "JSON object containing the information about the attachment"
5511 }
5512 }
5513 },
5514 "description" : "",
5515 "headers" : {
5516 "ETag" : {
5517 "description" : "Revision of the attachment, to be used in further `PUT` or `DELETE` operations"
5518 }
5519 }
5520 }
5521 },
5522 "summary" : "Get info about the attachment",
5188 "tags" : [ "Patients" ] 5523 "tags" : [ "Patients" ]
5189 } 5524 }
5190 }, 5525 },
5191 "/patients/{id}/attachments/{name}/is-compressed" : { 5526 "/patients/{id}/attachments/{name}/is-compressed" : {
5192 "get" : { 5527 "get" : {
7005 "explorer.js", 7340 "explorer.js",
7006 "authorization", 7341 "authorization",
7007 "connectivity-checks", 7342 "connectivity-checks",
7008 "dicom-web", 7343 "dicom-web",
7009 "gdcm", 7344 "gdcm",
7345 "indexer",
7010 "mysql-index", 7346 "mysql-index",
7011 "mysql-storage", 7347 "mysql-storage",
7012 "odbc-index", 7348 "odbc-index",
7013 "odbc-storage", 7349 "odbc-storage",
7014 "postgresql-index", 7350 "postgresql-index",
7078 "example" : { 7414 "example" : {
7079 "Description" : "Implementation of DICOMweb (QIDO-RS, STOW-RS and WADO-RS) and WADO-URI.", 7415 "Description" : "Implementation of DICOMweb (QIDO-RS, STOW-RS and WADO-RS) and WADO-URI.",
7080 "ExtendsOrthancExplorer" : true, 7416 "ExtendsOrthancExplorer" : true,
7081 "ID" : "dicom-web", 7417 "ID" : "dicom-web",
7082 "RootUri" : "../dicom-web/app/client/index.html", 7418 "RootUri" : "../dicom-web/app/client/index.html",
7083 "Version" : "1.6" 7419 "Version" : "1.7"
7084 } 7420 }
7085 } 7421 }
7086 } 7422 }
7087 }, 7423 },
7088 "description" : "" 7424 "description" : ""
8227 "get" : { 8563 "get" : {
8228 "deprecated" : false, 8564 "deprecated" : false,
8229 "description" : "Get the list of attachments that are associated with the given series", 8565 "description" : "Get the list of attachments that are associated with the given series",
8230 "parameters" : [ 8566 "parameters" : [
8231 { 8567 {
8568 "description" : "If present, retrieve the attachments list and their numerical ids",
8569 "in" : "query",
8570 "name" : "full",
8571 "required" : false,
8572 "schema" : {
8573 "type" : "string"
8574 }
8575 },
8576 {
8232 "description" : "Orthanc identifier of the series of interest", 8577 "description" : "Orthanc identifier of the series of interest",
8233 "in" : "path", 8578 "in" : "path",
8234 "name" : "id", 8579 "name" : "id",
8235 "required" : true, 8580 "required" : true,
8236 "schema" : { 8581 "schema" : {
8666 } 9011 }
8667 } 9012 }
8668 } 9013 }
8669 }, 9014 },
8670 "summary" : "Get attachment", 9015 "summary" : "Get attachment",
9016 "tags" : [ "Series" ]
9017 }
9018 },
9019 "/series/{id}/attachments/{name}/info" : {
9020 "get" : {
9021 "deprecated" : false,
9022 "description" : "Get all the information about the attachment associated with the given series",
9023 "parameters" : [
9024 {
9025 "description" : "Optional revision of the attachment, to check if its content has changed",
9026 "in" : "header",
9027 "name" : "If-None-Match",
9028 "required" : false,
9029 "schema" : {
9030 "type" : "string"
9031 }
9032 },
9033 {
9034 "description" : "Orthanc identifier of the series of interest",
9035 "in" : "path",
9036 "name" : "id",
9037 "required" : true,
9038 "schema" : {
9039 "type" : "string"
9040 }
9041 },
9042 {
9043 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
9044 "in" : "path",
9045 "name" : "name",
9046 "required" : true,
9047 "schema" : {
9048 "type" : "string"
9049 }
9050 }
9051 ],
9052 "responses" : {
9053 "200" : {
9054 "content" : {
9055 "application/json" : {
9056 "examples" : {},
9057 "schema" : {
9058 "description" : "JSON object containing the information about the attachment"
9059 }
9060 }
9061 },
9062 "description" : "",
9063 "headers" : {
9064 "ETag" : {
9065 "description" : "Revision of the attachment, to be used in further `PUT` or `DELETE` operations"
9066 }
9067 }
9068 }
9069 },
9070 "summary" : "Get info about the attachment",
8671 "tags" : [ "Series" ] 9071 "tags" : [ "Series" ]
8672 } 9072 }
8673 }, 9073 },
8674 "/series/{id}/attachments/{name}/is-compressed" : { 9074 "/series/{id}/attachments/{name}/is-compressed" : {
8675 "get" : { 9075 "get" : {
9668 }, 10068 },
9669 "summary" : "Get series module", 10069 "summary" : "Get series module",
9670 "tags" : [ "Series" ] 10070 "tags" : [ "Series" ]
9671 } 10071 }
9672 }, 10072 },
10073 "/series/{id}/numpy" : {
10074 "get" : {
10075 "deprecated" : false,
10076 "description" : "Decode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).",
10077 "parameters" : [
10078 {
10079 "description" : "Compress the file as `.npz`",
10080 "in" : "query",
10081 "name" : "compress",
10082 "required" : false,
10083 "schema" : {
10084 "type" : "boolean"
10085 }
10086 },
10087 {
10088 "description" : "On grayscale images, apply the rescaling and return floating-point values",
10089 "in" : "query",
10090 "name" : "rescale",
10091 "required" : false,
10092 "schema" : {
10093 "type" : "boolean"
10094 }
10095 },
10096 {
10097 "description" : "Orthanc identifier of the DICOM resource of interest",
10098 "in" : "path",
10099 "name" : "id",
10100 "required" : true,
10101 "schema" : {
10102 "type" : "string"
10103 }
10104 }
10105 ],
10106 "responses" : {
10107 "200" : {
10108 "content" : {
10109 "text/plain" : {
10110 "examples" : {},
10111 "schema" : {
10112 "description" : "Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html"
10113 }
10114 }
10115 },
10116 "description" : ""
10117 }
10118 },
10119 "summary" : "Decode series for numpy",
10120 "tags" : [ "Series" ]
10121 }
10122 },
9673 "/series/{id}/ordered-slices" : { 10123 "/series/{id}/ordered-slices" : {
9674 "get" : { 10124 "get" : {
9675 "deprecated" : true, 10125 "deprecated" : true,
9676 "description" : "Sort the instances and frames (slices) of the DICOM series whose Orthanc identifier is provided in the URL. This URI is essentially used by the Orthanc Web viewer and by the Osimis Web viewer.", 10126 "description" : "Sort the instances and frames (slices) of the DICOM series whose Orthanc identifier is provided in the URL. This URI is essentially used by the Orthanc Web viewer and by the Osimis Web viewer.",
9677 "parameters" : [ 10127 "parameters" : [
10637 "get" : { 11087 "get" : {
10638 "deprecated" : false, 11088 "deprecated" : false,
10639 "description" : "Get the list of attachments that are associated with the given study", 11089 "description" : "Get the list of attachments that are associated with the given study",
10640 "parameters" : [ 11090 "parameters" : [
10641 { 11091 {
11092 "description" : "If present, retrieve the attachments list and their numerical ids",
11093 "in" : "query",
11094 "name" : "full",
11095 "required" : false,
11096 "schema" : {
11097 "type" : "string"
11098 }
11099 },
11100 {
10642 "description" : "Orthanc identifier of the study of interest", 11101 "description" : "Orthanc identifier of the study of interest",
10643 "in" : "path", 11102 "in" : "path",
10644 "name" : "id", 11103 "name" : "id",
10645 "required" : true, 11104 "required" : true,
10646 "schema" : { 11105 "schema" : {
11076 } 11535 }
11077 } 11536 }
11078 } 11537 }
11079 }, 11538 },
11080 "summary" : "Get attachment", 11539 "summary" : "Get attachment",
11540 "tags" : [ "Studies" ]
11541 }
11542 },
11543 "/studies/{id}/attachments/{name}/info" : {
11544 "get" : {
11545 "deprecated" : false,
11546 "description" : "Get all the information about the attachment associated with the given study",
11547 "parameters" : [
11548 {
11549 "description" : "Optional revision of the attachment, to check if its content has changed",
11550 "in" : "header",
11551 "name" : "If-None-Match",
11552 "required" : false,
11553 "schema" : {
11554 "type" : "string"
11555 }
11556 },
11557 {
11558 "description" : "Orthanc identifier of the study of interest",
11559 "in" : "path",
11560 "name" : "id",
11561 "required" : true,
11562 "schema" : {
11563 "type" : "string"
11564 }
11565 },
11566 {
11567 "description" : "The name of the attachment, or its index (cf. `UserContentType` configuration option)",
11568 "in" : "path",
11569 "name" : "name",
11570 "required" : true,
11571 "schema" : {
11572 "type" : "string"
11573 }
11574 }
11575 ],
11576 "responses" : {
11577 "200" : {
11578 "content" : {
11579 "application/json" : {
11580 "examples" : {},
11581 "schema" : {
11582 "description" : "JSON object containing the information about the attachment"
11583 }
11584 }
11585 },
11586 "description" : "",
11587 "headers" : {
11588 "ETag" : {
11589 "description" : "Revision of the attachment, to be used in further `PUT` or `DELETE` operations"
11590 }
11591 }
11592 }
11593 },
11594 "summary" : "Get info about the attachment",
11081 "tags" : [ "Studies" ] 11595 "tags" : [ "Studies" ]
11082 } 11596 }
11083 }, 11597 },
11084 "/studies/{id}/attachments/{name}/is-compressed" : { 11598 "/studies/{id}/attachments/{name}/is-compressed" : {
11085 "get" : { 11599 "get" : {
12860 "content" : { 13374 "content" : {
12861 "application/json" : { 13375 "application/json" : {
12862 "schema" : { 13376 "schema" : {
12863 "description" : "", 13377 "description" : "",
12864 "example" : { 13378 "example" : {
12865 "ApiVersion" : 14, 13379 "ApiVersion" : 15,
12866 "CheckRevisions" : false, 13380 "CheckRevisions" : false,
12867 "DatabaseBackendPlugin" : null, 13381 "DatabaseBackendPlugin" : null,
12868 "DatabaseVersion" : 6, 13382 "DatabaseVersion" : 6,
12869 "DicomAet" : "ORTHANC", 13383 "DicomAet" : "ORTHANC",
12870 "DicomPort" : 4242, 13384 "DicomPort" : 4242,
12871 "HttpPort" : 8042, 13385 "HttpPort" : 8042,
12872 "IsHttpServerSecure" : false, 13386 "IsHttpServerSecure" : false,
12873 "Name" : "Orthanc Demo", 13387 "Name" : "Orthanc Demo",
12874 "PluginsEnabled" : true, 13388 "PluginsEnabled" : true,
12875 "StorageAreaPlugin" : null, 13389 "StorageAreaPlugin" : null,
12876 "Version" : "1.9.6" 13390 "Version" : "1.9.7"
12877 }, 13391 },
12878 "properties" : { 13392 "properties" : {
12879 "ApiVersion" : { 13393 "ApiVersion" : {
12880 "description" : "Version of the REST API", 13394 "description" : "Version of the REST API",
12881 "type" : "number" 13395 "type" : "number"
13193 "responses" : { 13707 "responses" : {
13194 "200" : { 13708 "200" : {
13195 "description" : "" 13709 "description" : ""
13196 } 13710 }
13197 }, 13711 },
13198 "summary" : "Describe a set of instances", 13712 "summary" : "Describe a set of resources",
13199 "tags" : [ "System" ] 13713 "tags" : [ "System" ]
13200 } 13714 }
13201 }, 13715 },
13202 "/tools/bulk-delete" : { 13716 "/tools/bulk-delete" : {
13203 "post" : { 13717 "post" : {
13225 "responses" : { 13739 "responses" : {
13226 "200" : { 13740 "200" : {
13227 "description" : "" 13741 "description" : ""
13228 } 13742 }
13229 }, 13743 },
13230 "summary" : "Delete a set of instances", 13744 "summary" : "Delete a set of resources",
13231 "tags" : [ "System" ] 13745 "tags" : [ "System" ]
13232 } 13746 }
13233 }, 13747 },
13234 "/tools/bulk-modify" : { 13748 "/tools/bulk-modify" : {
13235 "post" : { 13749 "post" : {
14315 "parameters" : [], 14829 "parameters" : [],
14316 "responses" : { 14830 "responses" : {
14317 "200" : { 14831 "200" : {
14318 "content" : { 14832 "content" : {
14319 "text/plain" : { 14833 "text/plain" : {
14320 "example" : "orthanc_count_instances 2552 1630401803782\northanc_count_patients 8 1630401803782\northanc_count_series 26 1630401803782\northanc_count_studies 8 1630401803782\northanc_dicom_cache_count 213 1630393626028\northanc_dicom_cache_size 125.938728 1630393626028\northanc_disk_size_mb 1018.65021 1630401803782\northanc_jobs_completed 2 1630401803782\northanc_jobs_failed 0 1630401803782\northanc_jobs_pending 0 1630401803782\northanc_jobs_running 0 1630401803782\northanc_jobs_success 2 1630401803782\northanc_rest_api_active_requests 1 1630401803781\northanc_rest_api_duration_ms 353 1630401802149\northanc_storage_read_duration_ms 0 1630401797848\northanc_uncompressed_size_mb 1018.65021 1630401803782\n" 14834 "example" : "orthanc_count_instances 2552 1645624991823\northanc_count_patients 8 1645624991823\northanc_count_series 26 1645624991823\northanc_count_studies 8 1645624991823\northanc_dicom_cache_count 215 1645572656584\northanc_dicom_cache_size 89.9329529 1645572656583\northanc_disk_size_mb 1018.65021 1645624991823\northanc_jobs_completed 10 1645624991823\northanc_jobs_failed 4 1645624991823\northanc_jobs_pending 0 1645624991823\northanc_jobs_running 0 1645624991823\northanc_jobs_success 6 1645624991823\northanc_rest_api_active_requests 1 1645624991823\northanc_rest_api_duration_ms 342 1645624990284\northanc_storage_read_duration_ms 8 1645624986257\northanc_uncompressed_size_mb 1018.65021 1645624991823\n"
14321 } 14835 }
14322 }, 14836 },
14323 "description" : "" 14837 "description" : ""
14324 } 14838 }
14325 }, 14839 },
14334 "parameters" : [], 14848 "parameters" : [],
14335 "responses" : { 14849 "responses" : {
14336 "200" : { 14850 "200" : {
14337 "content" : { 14851 "content" : {
14338 "text/plain" : { 14852 "text/plain" : {
14339 "example" : "20210831T092323", 14853 "example" : "20220223T140311",
14340 "schema" : { 14854 "schema" : {
14341 "description" : "The UTC time" 14855 "description" : "The UTC time"
14342 } 14856 }
14343 } 14857 }
14344 }, 14858 },
14356 "parameters" : [], 14870 "parameters" : [],
14357 "responses" : { 14871 "responses" : {
14358 "200" : { 14872 "200" : {
14359 "content" : { 14873 "content" : {
14360 "text/plain" : { 14874 "text/plain" : {
14361 "example" : "20210831T092323", 14875 "example" : "20220223T140311",
14362 "schema" : { 14876 "schema" : {
14363 "description" : "The local time" 14877 "description" : "The local time"
14364 } 14878 }
14365 } 14879 }
14366 }, 14880 },