Skip to content

Orthanc

pyorthanc.Orthanc

Bases: Client

Orthanc API

version 1.12.4 This is the full documentation of the REST API of Orthanc.

This reference is automatically generated from the source code of Orthanc. A shorter cheat sheet is part of the Orthanc Book.

An earlier, manually crafted version from August 2019, is still available, but is not up-to-date anymore (source).

Source code in pyorthanc/client.py
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
class Orthanc(httpx.Client):
    """Orthanc API

    version 1.12.4
    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)).

    """

    def __init__(
        self,
        url: str,
        username: Optional[str] = None,
        password: Optional[str] = None,
        return_raw_response: bool = False,
        *args,
        **kwargs,
    ):
        """
        Parameters
        ----------
        url
            server's URL
        username
            Orthanc's username
        password
            Orthanc's password
        return_raw_response
            All Orthanc's methods will return a raw httpx.Response rather than the serialized result
        *args, **kwargs
            Parameters passed to the httpx.Client (headers, timeout, etc.)
        """
        super().__init__(*args, **kwargs)
        self.url = url
        self.version = "1.12.4"
        self.return_raw_response = return_raw_response

        if username and password:
            self.setup_credentials(username, password)

    def setup_credentials(self, username: str, password: str) -> None:
        """Set credentials needed for HTTP requests"""
        self._auth = httpx.BasicAuth(username, password)

    def _get(
        self,
        route: str,
        params: Optional[QueryParamTypes] = None,
        headers: Optional[HeaderTypes] = None,
        cookies: Optional[CookieTypes] = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """GET request with specified route

        Parameters
        ----------
        route
            HTTP route.
        params
            Parameters for the HTTP request.
        headers
            Headers for the HTTP request.
        cookies

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Serialized response of the HTTP GET request or httpx.Response.
        """
        response = self.get(url=route, params=params, headers=headers, cookies=cookies)

        if self.return_raw_response:
            return response

        if 200 <= response.status_code < 300:
            if "application/json" in response.headers["content-type"]:
                return response.json()
            elif "text/plain" in response.headers["content-type"]:
                return response.text
            else:
                return response.content

        raise httpx.HTTPError(
            f"HTTP code: {response.status_code}, with content: {response.text}"
        )

    def _delete(
        self,
        route: str,
        params: Optional[QueryParamTypes] = None,
        headers: Optional[HeaderTypes] = None,
        cookies: Optional[CookieTypes] = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """DELETE to specified route

        Parameters
        ----------
        route
            HTTP route.
        params
            Parameters for the HTTP request.
        headers
            Headers for the HTTP request.
        cookies

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Serialized response of the HTTP DELETE request or httpx.Response.
        """
        response = self.delete(route, params=params, headers=headers, cookies=cookies)

        if self.return_raw_response:
            return response

        if 200 <= response.status_code < 300:
            if "application/json" in response.headers["content-type"]:
                return response.json()
            elif "text/plain" in response.headers["content-type"]:
                return response.text
            else:
                return response.content

        raise httpx.HTTPError(
            f"HTTP code: {response.status_code}, with content: {response.text}"
        )

    def _post(
        self,
        route: str,
        content: Optional[RequestContent] = None,
        data: Optional[RequestData] = None,
        files: Optional[RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[QueryParamTypes] = None,
        headers: Optional[HeaderTypes] = None,
        cookies: Optional[CookieTypes] = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """POST to specified route

        Parameters
        ----------
        route
            HTTP route.
        content
        data
            Dictionary to send in the body of request.
        files
        json
        params
        headers
        cookies

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Serialized response of the HTTP POST request or httpx.Response.
        """
        response = self.post(
            route,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
        )

        if self.return_raw_response:
            return response

        if 200 <= response.status_code < 300:
            if "application/json" in response.headers["content-type"]:
                return response.json()
            elif "text/plain" in response.headers["content-type"]:
                return response.text
            else:
                return response.content

        raise httpx.HTTPError(
            f"HTTP code: {response.status_code}, with text: {response.text}"
        )

    def _put(
        self,
        route: str,
        content: RequestContent = None,
        data: RequestData = None,
        files: Optional[RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[QueryParamTypes] = None,
        headers: Optional[HeaderTypes] = None,
        cookies: Optional[CookieTypes] = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """PUT to specified route

        Parameters
        ----------
        route
            HTTP route.
        content
        data
            Dictionary to send in the body of request.
        files
        json
        params
        headers
        cookies

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Serialized response of the HTTP PUT request or httpx.Response.
        """
        response = self.put(
            route,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
        )

        if self.return_raw_response:
            return response

        if 200 <= response.status_code < 300:
            if "application/json" in response.headers["content-type"]:
                return response.json()
            elif "text/plain" in response.headers["content-type"]:
                return response.text
            else:
                return response.content

        raise httpx.HTTPError(
            f"HTTP code: {response.status_code}, with text: {response.text}"
        )

    def delete_changes(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Clear changes

        Clear the full history stored in the changes log
        Tags: Tracking changes

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/changes",
        )

    def get_changes(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List changes

        Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called _Changes Log_. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality.
        Tags: Tracking changes

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "limit" (float): Limit the number of results
                "since" (float): Show only the resources since the provided index

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The list of changes
        """
        return self._get(
            route=f"{self.url}/changes",
            params=params,
        )

    def delete_exports(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Clear exports

        Clear the full history stored in the exports log
        Tags: Tracking changes

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/exports",
        )

    def get_exports(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List exports

        For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting the option `LogExportedResources` to `false` in the configuration file, or periodically clear this log by `DELETE`-ing this URI. This route might be removed in future versions of Orthanc.
        Tags: Tracking changes

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "limit" (float): Limit the number of results
                "since" (float): Show only the resources since the provided index

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The list of exports
        """
        return self._get(
            route=f"{self.url}/exports",
            params=params,
        )

    def get_instances(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List the available instances

        List the Orthanc identifiers of all the available DICOM instances
        Tags: Instances

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual instances
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "limit" (float): Limit the number of results
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "since" (float): Show only the resources since the provided index

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/instances",
            params=params,
        )

    def post_instances(
        self,
        content: RequestContent = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Upload DICOM instances

        Upload DICOM instances
        Tags: Instances

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the uploaded instance, or list of information for each uploaded instance in the case of ZIP archive
        """
        return self._post(
            route=f"{self.url}/instances",
            content=content,
        )

    def delete_instances_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete some instance

        Delete the DICOM instance whose Orthanc identifier is provided in the URL
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/instances/{id_}",
        )

    def get_instances_id(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get information about some instance

        Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM instance
        """
        return self._get(
            route=f"{self.url}/instances/{id_}",
            params=params,
        )

    def post_instances_id_anonymize(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Anonymize instance

        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
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        json
            Dictionary with the following keys:
              "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
              "KeepLabels": Keep the labels of all resources level (defaults to `false`)
              "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of additional tags to be removed from 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).
              "Replace": 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).
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The anonymized DICOM instance
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/instances/{id_}/anonymize",
            json=json,
        )

    def get_instances_id_attachments(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List attachments

        Get the list of attachments that are associated with the given instance
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "full" (str): If present, retrieve the attachments list and their numerical ids

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the attachments
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments",
            params=params,
        )

    def delete_instances_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete attachment

        Delete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/instances/{id_}/attachments/{name}",
            headers=headers,
        )

    def get_instances_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on attachments

        Get the list of the operations that are available for attachments associated with the given instance
        Tags: Other

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}",
            headers=headers,
        )

    def put_instances_id_attachments_name(
        self,
        id_: str,
        name: str,
        content: RequestContent = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set attachment

        Attach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        content
                - (Content-Type: "application/octet-stream") Binary data containing the attachment
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._put(
            route=f"{self.url}/instances/{id_}/attachments/{name}",
            content=content,
            headers=headers,
        )

    def post_instances_id_attachments_name_compress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Compress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/instances/{id_}/attachments/{name}/compress",
        )

    def get_instances_id_attachments_name_compressed_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment (no decompression)

        Get the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if `StorageCompression` is `true`.
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/compressed-data",
            headers=headers,
        )

    def get_instances_id_attachments_name_compressed_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment on disk

        Get the MD5 hash of one attachment associated with the given instance, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/compressed-md5",
            headers=headers,
        )

    def get_instances_id_attachments_name_compressed_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment on disk

        Get the size of one attachment associated with the given instance, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/compressed-size",
            headers=headers,
        )

    def get_instances_id_attachments_name_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment

        Get the (binary) content of one attachment associated with the given instance
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/data",
            headers=headers,
        )

    def get_instances_id_attachments_name_info(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get info about the attachment

        Get all the information about the attachment associated with the given instance
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the information about the attachment
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/info",
            headers=headers,
        )

    def get_instances_id_attachments_name_is_compressed(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Is attachment compressed?

        Test whether the attachment has been stored as a compressed file on the disk.
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `0` if the attachment was stored uncompressed, `1` if it was compressed
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/is-compressed",
            headers=headers,
        )

    def get_instances_id_attachments_name_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment

        Get the MD5 hash of one attachment associated with the given instance
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/md5",
            headers=headers,
        )

    def get_instances_id_attachments_name_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment

        Get the size of one attachment associated with the given instance
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/attachments/{name}/size",
            headers=headers,
        )

    def post_instances_id_attachments_name_uncompress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Uncompress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/instances/{id_}/attachments/{name}/uncompress",
        )

    def post_instances_id_attachments_name_verify_md5(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Verify attachment

        Verify that the attachment is not corrupted, by validating its MD5 hash
        Tags: Instances

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            On success, a valid JSON object is returned
        """
        return self._post(
            route=f"{self.url}/instances/{id_}/attachments/{name}/verify-md5",
        )

    def get_instances_id_content_path(
        self,
        id_: str,
        path: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get raw tag

        Get the raw content of one DICOM tag in the hierarchy of DICOM dataset
        Tags: Instances

        Parameters
        ----------
        path
            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`
        id_
            Orthanc identifier of the DICOM instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The raw value of the tag of intereset (binary data, whose memory layout depends on the underlying transfer syntax), or JSON array containing the list of available tags if accessing a dataset
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/content/{path}",
        )

    def post_instances_id_export(
        self,
        id_: str,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Write DICOM onto filesystem

        Write the DICOM file onto the filesystem where Orthanc is running.  This is insecure for Orthanc servers that are remotely accessible since one could overwrite any system file.  Since Orthanc 1.12.0, this route is disabled by default, but can be enabled using the `RestApiWriteToFileSystemEnabled` configuration option.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        data
            Target path on the filesystem

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/instances/{id_}/export",
            data=data,
        )

    def get_instances_id_file(
        self,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Download DICOM

        Download one DICOM instance
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "transcode" (str): If present, the DICOM file will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
        headers
            Dictionary of optional headers:
                "Accept" (str): This HTTP header can be set to retrieve the DICOM instance in DICOMweb format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The DICOM instance
            The DICOM instance, in DICOMweb JSON format
            The DICOM instance, in DICOMweb XML format
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/file",
            params=params,
            headers=headers,
        )

    def get_instances_id_frames(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List available frames

        List the frames that are available in the DICOM instance of interest
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The list of the indices of the available frames
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames",
        )

    def get_instances_id_frames_frame(
        self,
        frame: str,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations

        List the available operations under URI `/instances/{id}/frames/{frame}/`
        Tags: Other

        Parameters
        ----------
        frame

        id_


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}",
        )

    def get_instances_id_frames_frame_image_int16(
        self,
        frame: float,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode a frame (int16)

        Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/image-int16",
            params=params,
            headers=headers,
        )

    def get_instances_id_frames_frame_image_uint16(
        self,
        frame: float,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode a frame (uint16)

        Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/image-uint16",
            params=params,
            headers=headers,
        )

    def get_instances_id_frames_frame_image_uint8(
        self,
        frame: float,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode a frame (uint8)

        Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/image-uint8",
            params=params,
            headers=headers,
        )

    def get_instances_id_frames_frame_matlab(
        self,
        frame: float,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode frame for Matlab

        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
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Octave/Matlab matrix
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/matlab",
        )

    def get_instances_id_frames_frame_numpy(
        self,
        frame: float,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode frame for numpy

        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).
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM resource of interest
        params
            Dictionary of optional parameters:
                "compress" (bool): Compress the file as `.npz`
                "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/numpy",
            params=params,
        )

    def get_instances_id_frames_frame_preview(
        self,
        frame: float,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode a frame (preview)

        Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/preview",
            params=params,
            headers=headers,
        )

    def get_instances_id_frames_frame_raw(
        self,
        frame: float,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Access raw frame

        Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes.
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The raw frame
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/raw",
        )

    def get_instances_id_frames_frame_raw_gz(
        self,
        frame: float,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Access raw frame (compressed)

        Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. The image is compressed using gzip
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The raw frame, compressed using gzip
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/raw.gz",
        )

    def get_instances_id_frames_frame_rendered(
        self,
        frame: float,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Render a frame

        Render one frame of interest from the given DICOM instance. This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), and can be used to resize the resulting image. Color images are not affected by windowing.
        Tags: Instances

        Parameters
        ----------
        frame
            Index of the frame (starts at `0`)
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "height" (float): Height of the resized image
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
                "smooth" (bool): Whether to smooth image on resize
                "width" (float): Width of the resized image
                "window-center" (float): Windowing center
                "window-width" (float): Windowing width
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/frames/{frame}/rendered",
            params=params,
            headers=headers,
        )

    def get_instances_id_header(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get DICOM meta-header

        Get the DICOM tags in the meta-header of the DICOM instance. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the DICOM tags and their associated value
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/header",
            params=params,
        )

    def get_instances_id_image_int16(
        self,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode an image (int16)

        Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/image-int16",
            params=params,
            headers=headers,
        )

    def get_instances_id_image_uint16(
        self,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode an image (uint16)

        Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/image-uint16",
            params=params,
            headers=headers,
        )

    def get_instances_id_image_uint8(
        self,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode an image (uint8)

        Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/image-uint8",
            params=params,
            headers=headers,
        )

    def get_instances_id_labels(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List labels

        Get the labels that are associated with the given instance (new in Orthanc 1.12.0)
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the labels
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/labels",
        )

    def delete_instances_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Remove label

        Remove a label associated with a instance
        Tags: Instances

        Parameters
        ----------
        label
            The label to be removed
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/instances/{id_}/labels/{label}",
        )

    def get_instances_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Test label

        Test whether the instance is associated with the given label
        Tags: Instances

        Parameters
        ----------
        label
            The label of interest
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty string is returned in the case of presence, error 404 in the case of absence
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/labels/{label}",
        )

    def put_instances_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Add label

        Associate a label with a instance
        Tags: Instances

        Parameters
        ----------
        label
            The label to be added
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/instances/{id_}/labels/{label}",
        )

    def get_instances_id_matlab(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode frame for Matlab

        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
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Octave/Matlab matrix
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/matlab",
        )

    def get_instances_id_metadata(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List metadata

        Get the list of metadata that are associated with the given instance
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If present, also retrieve the value of the individual metadata
                "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/metadata",
            params=params,
        )

    def delete_instances_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete metadata

        Delete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
        Tags: Instances

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/instances/{id_}/metadata/{name}",
            headers=headers,
        )

    def get_instances_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get metadata

        Get the value of a metadata that is associated with the given instance
        Tags: Instances

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the instance of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Value of the metadata
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/metadata/{name}",
            headers=headers,
        )

    def put_instances_id_metadata_name(
        self,
        id_: str,
        name: str,
        data: RequestData = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set metadata

        Set the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
        Tags: Instances

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the instance of interest
        data
            String value of the metadata
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/instances/{id_}/metadata/{name}",
            data=data,
            headers=headers,
        )

    def post_instances_id_modify(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Modify instance

        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
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        json
            Dictionary with the following keys:
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of tags that must be removed from 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).
              "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
              "Replace": 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).
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The modified DICOM instance
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/instances/{id_}/modify",
            json=json,
        )

    def get_instances_id_module(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get instance module

        Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM instance
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/module",
            params=params,
        )

    def get_instances_id_numpy(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode instance for numpy

        Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM resource of interest
        params
            Dictionary of optional parameters:
                "compress" (bool): Compress the file as `.npz`
                "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/numpy",
            params=params,
        )

    def get_instances_id_patient(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get parent patient

        Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the parent DICOM patient
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/patient",
            params=params,
        )

    def get_instances_id_pdf(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get embedded PDF

        Get the PDF file that is embedded in one DICOM instance. If the DICOM instance doesn't contain the `EncapsulatedDocument` tag or if the `MIMETypeOfEncapsulatedDocument` tag doesn't correspond to the PDF type, a `404` HTTP error is raised.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            PDF file
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/pdf",
        )

    def get_instances_id_preview(
        self,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode an image (preview)

        Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/preview",
            params=params,
            headers=headers,
        )

    def post_instances_id_reconstruct(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Reconstruct tags & optionally files of instance

        Reconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        json
            Dictionary with the following keys:
              "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
              "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/instances/{id_}/reconstruct",
            json=json,
        )

    def get_instances_id_rendered(
        self,
        id_: str,
        params: QueryParamTypes = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Render an image

        Render the first frame of the given DICOM instance. This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), and can be used to resize the resulting image. Color images are not affected by windowing.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "height" (float): Height of the resized image
                "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
                "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
                "smooth" (bool): Whether to smooth image on resize
                "width" (float): Width of the resized image
                "window-center" (float): Windowing center
                "window-width" (float): Windowing width
        headers
            Dictionary of optional headers:
                "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JPEG image
            PNG image
            PAM image (Portable Arbitrary Map)
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/rendered",
            params=params,
            headers=headers,
        )

    def get_instances_id_series(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get parent series

        Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the parent DICOM series
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/series",
            params=params,
        )

    def get_instances_id_simplified_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get human-readable tags

        Get the DICOM tags in human-readable format (same as the `/instances/{id}/tags?simplify` route)
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "whole" (bool): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the DICOM tags and their associated value
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/simplified-tags",
            params=params,
        )

    def get_instances_id_statistics(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get instance statistics

        Get statistics about the given instance
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/instances/{id_}/statistics",
        )

    def get_instances_id_study(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get parent study

        Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the instance of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the parent DICOM study
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/study",
            params=params,
        )

    def get_instances_id_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get DICOM tags

        Get the DICOM tags in the specified format. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.
        Tags: Instances

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM instance of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
                "whole" (bool): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the DICOM tags and their associated value
        """
        return self._get(
            route=f"{self.url}/instances/{id_}/tags",
            params=params,
        )

    def get_jobs(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List jobs

        List all the available jobs
        Tags: Jobs

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual jobs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/jobs",
            params=params,
        )

    def delete_jobs_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete a job from history

        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.
        Tags: Jobs

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/jobs/{id_}",
        )

    def get_jobs_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get job

        Retrieve detailed information about the job whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
        Tags: Jobs

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object detailing the job
        """
        return self._get(
            route=f"{self.url}/jobs/{id_}",
        )

    def post_jobs_id_cancel(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Cancel job

        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
        Tags: Jobs

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._post(
            route=f"{self.url}/jobs/{id_}/cancel",
        )

    def post_jobs_id_pause(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Pause job

        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
        Tags: Jobs

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._post(
            route=f"{self.url}/jobs/{id_}/pause",
        )

    def post_jobs_id_resubmit(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Resubmit job

        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
        Tags: Jobs

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._post(
            route=f"{self.url}/jobs/{id_}/resubmit",
        )

    def post_jobs_id_resume(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Resume job

        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
        Tags: Jobs

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._post(
            route=f"{self.url}/jobs/{id_}/resume",
        )

    def delete_jobs_id_key(
        self,
        id_: str,
        key: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete a job output

        Delete the output produced by a job. As of Orthanc 1.12.1, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).
        Tags: Jobs

        Parameters
        ----------
        key
            Name of the output of interest
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/jobs/{id_}/{key}",
        )

    def get_jobs_id_key(
        self,
        id_: str,
        key: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get job output

        Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).
        Tags: Jobs

        Parameters
        ----------
        key
            Name of the output of interest
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Content of the output of the job
        """
        return self._get(
            route=f"{self.url}/jobs/{id_}/{key}",
        )

    def get_modalities(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List DICOM modalities

        List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the `DicomModalities` configuration option, or to the information stored in the database if `DicomModalitiesInDatabase` is `true`.
        Tags: Networking

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual DICOM modalities

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the identifiers of the modalities, or detailed information about the modalities (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/modalities",
            params=params,
        )

    def delete_modalities_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete DICOM modality

        Delete one DICOM modality. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the DICOM modality of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/modalities/{id_}",
        )

    def get_modalities_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on modality

        List the operations that are available for a DICOM modality.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the DICOM modality of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/modalities/{id_}",
        )

    def put_modalities_id(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Update DICOM modality

        Define a new DICOM modality, or update an existing one. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the new/updated DICOM modality
        json
            Dictionary with the following keys:
              "AET": AET of the remote DICOM modality
              "AllowEcho": Whether to accept C-ECHO SCU commands issued by the remote modality
              "AllowFind": Whether to accept C-FIND SCU commands issued by the remote modality
              "AllowFindWorklist": Whether to accept C-FIND SCU commands for worklists issued by the remote modality
              "AllowGet": Whether to accept C-GET SCU commands issued by the remote modality
              "AllowMove": Whether to accept C-MOVE SCU commands issued by the remote modality
              "AllowStorageCommitment": Whether to accept storage commitment requests issued by the remote modality
              "AllowStore": Whether to accept C-STORE SCU commands issued by the remote modality
              "AllowTranscoding": Whether to allow transcoding for operations initiated by this modality. This option applies to Orthanc C-GET SCP and to Orthanc C-STORE SCU. It only has an effect if the global option `EnableTranscoding` is set to `true`.
              "Host": Host address of the remote DICOM modality (typically, an IP address)
              "LocalAet": Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality
              "Manufacturer": Manufacturer of the remote DICOM modality (check configuration option `DicomModalities` for possible values
              "Port": TCP port of the remote DICOM modality
              "Timeout": Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality
              "UseDicomTls": Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._put(
            route=f"{self.url}/modalities/{id_}",
            json=json,
        )

    def get_modalities_id_configuration(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get modality configuration

        Get detailed information about the configuration of some DICOM modality
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Configuration of the modality
        """
        return self._get(
            route=f"{self.url}/modalities/{id_}/configuration",
        )

    def post_modalities_id_echo(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Trigger C-ECHO SCU

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "CheckFind": Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` configuration option. New in Orthanc 1.8.1.
              "Timeout": Timeout for the C-ECHO command, in seconds


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/echo",
            json=json,
        )

    def post_modalities_id_find(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Hierarchical C-FIND SCU

        Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of matching patients/studies/series. Deprecated in favor of `/modalities/{id}/query`.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array describing the DICOM tags of the matching patients, embedding the matching studies, then the matching series.
        """
        warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/find",
            json=json,
        )

    def post_modalities_id_find_instance(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """C-FIND SCU for instances

        Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of `/modalities/{id}/query`.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array describing the DICOM tags of the matching instances
        """
        warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/find-instance",
            json=json,
        )

    def post_modalities_id_find_patient(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """C-FIND SCU for patients

        Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of `/modalities/{id}/query`.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array describing the DICOM tags of the matching patients
        """
        warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/find-patient",
            json=json,
        )

    def post_modalities_id_find_series(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """C-FIND SCU for series

        Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of `/modalities/{id}/query`.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array describing the DICOM tags of the matching series
        """
        warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/find-series",
            json=json,
        )

    def post_modalities_id_find_study(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """C-FIND SCU for studies

        Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of `/modalities/{id}/query`.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array describing the DICOM tags of the matching studies
        """
        warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/find-study",
            json=json,
        )

    def post_modalities_id_find_worklist(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """C-FIND SCU for worklist

        Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
              "Query": Associative array containing the filter on the values of the DICOM tags
              "Short": If set to `true`, report the DICOM tags in hexadecimal format


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array describing the DICOM tags of the matching worklists
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/find-worklist",
            json=json,
        )

    def post_modalities_id_move(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Trigger C-MOVE SCU

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Level": Level of the query (`Patient`, `Study`, `Series` or `Instance`)
              "LocalAet": Local AET that is used for this commands, defaults to `DicomAet` configuration option. Ignored if `DicomModalities` already sets `LocalAet` for this modality.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": List of queries identifying all the DICOM resources to be sent
              "Synchronous": 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.
              "TargetAet": Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU commands, defaults to `DicomAet` configuration option in order to do a simple query/retrieve
              "Timeout": Timeout for the C-MOVE command, in seconds


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/move",
            json=json,
        )

    def post_modalities_id_query(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Trigger C-FIND SCU

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "Level": Level of the query (`Patient`, `Study`, `Series` or `Instance`)
              "LocalAet": Local AET that is used for this commands, defaults to `DicomAet` configuration option. Ignored if `DicomModalities` already sets `LocalAet` for this modality.
              "Normalize": Whether to normalize the query, i.e. whether to wipe out from the query, the DICOM tags that are not applicable for the query-retrieve level of interest
              "Query": Associative array containing the filter on the values of the DICOM tags
              "Timeout": Timeout for the C-FIND command and subsequent C-MOVE retrievals, in seconds (new in Orthanc 1.9.1)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/query",
            json=json,
        )

    def post_modalities_id_storage_commitment(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Trigger storage commitment request

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "DicomInstances": List of DICOM resources that are not necessarily stored within Orthanc, but that must be checked by storage commitment. This is a list of JSON objects that must contain the `SOPClassUID` and `SOPInstanceUID` fields.
              "Resources": List of the Orthanc identifiers of the DICOM resources to be checked by storage commitment
              "Timeout": Timeout for the storage commitment command (new in Orthanc 1.9.1)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/storage-commitment",
            json=json,
        )

    def post_modalities_id_store(
        self,
        id_: str,
        data: RequestData = None,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Trigger C-STORE SCU

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "CalledAet": Called AET that is used for this commands, defaults to `AET` configuration option. Allows you to overwrite the destination AET for a specific operation.
              "Host": Host that is used for this commands, defaults to `Host` configuration option. Allows you to overwrite the destination host for a specific operation.
              "LocalAet": Local AET that is used for this commands, defaults to `DicomAet` configuration option. Ignored if `DicomModalities` already sets `LocalAet` for this modality.
              "MoveOriginatorAet": Move originator AET that is used for this commands, in order to fake a C-MOVE SCU
              "MoveOriginatorID": Move originator ID that is used for this commands, in order to fake a C-MOVE SCU
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Port": Port that is used for this command, defaults to `Port` configuration option. Allows you to overwrite the destination port for a specific operation.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": List of the Orthanc identifiers of all the DICOM resources to be sent
              "StorageCommitment": 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
              "Synchronous": 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.
              "Timeout": Timeout for the C-STORE command, in seconds

        data
            The Orthanc identifier of one resource to be sent

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/modalities/{id_}/store",
            data=data,
            json=json,
        )

    def post_modalities_id_store_straight(
        self,
        id_: str,
        content: RequestContent = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Straight C-STORE SCU

        Synchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `storescu` from DCMTK or dcm4che.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        content
                - (Content-Type: "application/dicom") DICOM instance to be sent

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._post(
            route=f"{self.url}/modalities/{id_}/store-straight",
            content=content,
        )

    def get_patients(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List the available patients

        List the Orthanc identifiers of all the available DICOM patients
        Tags: Patients

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual patients
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "limit" (float): Limit the number of results
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "since" (float): Show only the resources since the provided index

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the Orthanc identifiers, or detailed information about the reported patients (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/patients",
            params=params,
        )

    def delete_patients_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete some patient

        Delete the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/patients/{id_}",
        )

    def get_patients_id(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get information about some patient

        Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM patient
        """
        return self._get(
            route=f"{self.url}/patients/{id_}",
            params=params,
        )

    def post_patients_id_anonymize(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Anonymize patient

        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
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
              "KeepLabels": Keep the labels of all resources level (defaults to `false`)
              "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of additional tags to be removed from 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).
              "Replace": 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).
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/patients/{id_}/anonymize",
            json=json,
        )

    def get_patients_id_archive(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Synchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
                "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            ZIP file containing the archive
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/archive",
            params=params,
        )

    def post_patients_id_archive(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/patients/{id_}/archive",
            json=json,
        )

    def get_patients_id_attachments(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List attachments

        Get the list of attachments that are associated with the given patient
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "full" (str): If present, retrieve the attachments list and their numerical ids

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the attachments
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments",
            params=params,
        )

    def delete_patients_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete attachment

        Delete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/patients/{id_}/attachments/{name}",
            headers=headers,
        )

    def get_patients_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on attachments

        Get the list of the operations that are available for attachments associated with the given patient
        Tags: Other

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}",
            headers=headers,
        )

    def put_patients_id_attachments_name(
        self,
        id_: str,
        name: str,
        content: RequestContent = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set attachment

        Attach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        content
                - (Content-Type: "application/octet-stream") Binary data containing the attachment
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._put(
            route=f"{self.url}/patients/{id_}/attachments/{name}",
            content=content,
            headers=headers,
        )

    def post_patients_id_attachments_name_compress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Compress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/patients/{id_}/attachments/{name}/compress",
        )

    def get_patients_id_attachments_name_compressed_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment (no decompression)

        Get the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if `StorageCompression` is `true`.
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/compressed-data",
            headers=headers,
        )

    def get_patients_id_attachments_name_compressed_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment on disk

        Get the MD5 hash of one attachment associated with the given patient, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/compressed-md5",
            headers=headers,
        )

    def get_patients_id_attachments_name_compressed_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment on disk

        Get the size of one attachment associated with the given patient, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/compressed-size",
            headers=headers,
        )

    def get_patients_id_attachments_name_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment

        Get the (binary) content of one attachment associated with the given patient
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/data",
            headers=headers,
        )

    def get_patients_id_attachments_name_info(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get info about the attachment

        Get all the information about the attachment associated with the given patient
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the information about the attachment
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/info",
            headers=headers,
        )

    def get_patients_id_attachments_name_is_compressed(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Is attachment compressed?

        Test whether the attachment has been stored as a compressed file on the disk.
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `0` if the attachment was stored uncompressed, `1` if it was compressed
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/is-compressed",
            headers=headers,
        )

    def get_patients_id_attachments_name_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment

        Get the MD5 hash of one attachment associated with the given patient
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/md5",
            headers=headers,
        )

    def get_patients_id_attachments_name_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment

        Get the size of one attachment associated with the given patient
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/attachments/{name}/size",
            headers=headers,
        )

    def post_patients_id_attachments_name_uncompress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Uncompress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/patients/{id_}/attachments/{name}/uncompress",
        )

    def post_patients_id_attachments_name_verify_md5(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Verify attachment

        Verify that the attachment is not corrupted, by validating its MD5 hash
        Tags: Patients

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            On success, a valid JSON object is returned
        """
        return self._post(
            route=f"{self.url}/patients/{id_}/attachments/{name}/verify-md5",
        )

    def get_patients_id_instances(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get child instances

        Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If false or missing, only retrieve the list of child instances
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing information about the child DICOM instances
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/instances",
            params=params,
        )

    def get_patients_id_instances_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get tags of instances

        Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/instances-tags",
            params=params,
        )

    def get_patients_id_labels(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List labels

        Get the labels that are associated with the given patient (new in Orthanc 1.12.0)
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the labels
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/labels",
        )

    def delete_patients_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Remove label

        Remove a label associated with a patient
        Tags: Patients

        Parameters
        ----------
        label
            The label to be removed
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/patients/{id_}/labels/{label}",
        )

    def get_patients_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Test label

        Test whether the patient is associated with the given label
        Tags: Patients

        Parameters
        ----------
        label
            The label of interest
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty string is returned in the case of presence, error 404 in the case of absence
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/labels/{label}",
        )

    def put_patients_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Add label

        Associate a label with a patient
        Tags: Patients

        Parameters
        ----------
        label
            The label to be added
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/patients/{id_}/labels/{label}",
        )

    def get_patients_id_media(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Synchronously create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "extended" (str): If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*
                "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
                "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            ZIP file containing the archive
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/media",
            params=params,
        )

    def post_patients_id_media(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/patients/{id_}/media",
            json=json,
        )

    def get_patients_id_metadata(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List metadata

        Get the list of metadata that are associated with the given patient
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If present, also retrieve the value of the individual metadata
                "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/metadata",
            params=params,
        )

    def delete_patients_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete metadata

        Delete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
        Tags: Patients

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/patients/{id_}/metadata/{name}",
            headers=headers,
        )

    def get_patients_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get metadata

        Get the value of a metadata that is associated with the given patient
        Tags: Patients

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the patient of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Value of the metadata
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/metadata/{name}",
            headers=headers,
        )

    def put_patients_id_metadata_name(
        self,
        id_: str,
        name: str,
        data: RequestData = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set metadata

        Set the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
        Tags: Patients

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the patient of interest
        data
            String value of the metadata
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/patients/{id_}/metadata/{name}",
            data=data,
            headers=headers,
        )

    def post_patients_id_modify(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Modify patient

        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
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of tags that must be removed from 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).
              "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
              "Replace": 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).
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/patients/{id_}/modify",
            json=json,
        )

    def get_patients_id_module(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get patient module

        Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM patient
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/module",
            params=params,
        )

    def get_patients_id_protected(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Is the patient protected against recycling?

        Is the patient protected against recycling?
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `1` if protected, `0` if not protected
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/protected",
        )

    def put_patients_id_protected(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Protect/Unprotect a patient against recycling

        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
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/patients/{id_}/protected",
        )

    def post_patients_id_reconstruct(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Reconstruct tags & optionally files of patient

        Reconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        json
            Dictionary with the following keys:
              "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
              "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/patients/{id_}/reconstruct",
            json=json,
        )

    def get_patients_id_series(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get child series

        Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If false or missing, only retrieve the list of child series
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing information about the child DICOM series
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/series",
            params=params,
        )

    def get_patients_id_shared_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get shared tags

        Extract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the values of the DICOM tags
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/shared-tags",
            params=params,
        )

    def get_patients_id_statistics(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get patient statistics

        Get statistics about the given patient
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/patients/{id_}/statistics",
        )

    def get_patients_id_studies(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get child studies

        Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL
        Tags: Patients

        Parameters
        ----------
        id_
            Orthanc identifier of the patient of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If false or missing, only retrieve the list of child studies
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing information about the child DICOM studies
        """
        return self._get(
            route=f"{self.url}/patients/{id_}/studies",
            params=params,
        )

    def get_peers(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List Orthanc peers

        List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the `OrthancPeers` configuration option, or to the information stored in the database if `OrthancPeersInDatabase` is `true`.
        Tags: Networking

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual Orthanc peers

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the identifiers of the peers, or detailed information about the peers (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/peers",
            params=params,
        )

    def delete_peers_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete Orthanc peer

        Delete one Orthanc peer. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the Orthanc peer of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/peers/{id_}",
        )

    def get_peers_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on peer

        List the operations that are available for an Orthanc peer.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the peer of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/peers/{id_}",
        )

    def put_peers_id(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Update Orthanc peer

        Define a new Orthanc peer, or update an existing one. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the new/updated Orthanc peer
        json
            Dictionary with the following keys:
              "CertificateFile": SSL certificate for the HTTPS connections
              "CertificateKeyFile": Key file for the SSL certificate for the HTTPS connections
              "CertificateKeyPassword": Key password for the SSL certificate for the HTTPS connections
              "HttpHeaders": HTTP headers to be used for the connections to the remote peer
              "Password": Password for the credentials
              "URL": URL of the root of the REST API of the remote Orthanc peer, for instance `http://localhost:8042/`
              "Username": Username for the credentials


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._put(
            route=f"{self.url}/peers/{id_}",
            json=json,
        )

    def get_peers_id_configuration(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get peer configuration

        Get detailed information about the configuration of some Orthanc peer
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the peer of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Configuration of the peer
        """
        return self._get(
            route=f"{self.url}/peers/{id_}/configuration",
        )

    def post_peers_id_store(
        self,
        id_: str,
        data: RequestData = None,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Send to Orthanc peer

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Compress": Whether to compress the DICOM instances using gzip before the actual sending
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": List of the Orthanc identifiers of all the DICOM resources to be sent
              "Synchronous": 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.
              "Transcode": Transcode to the provided DICOM transfer syntax before the actual sending

        data
            The Orthanc identifier of one resource to be sent

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/peers/{id_}/store",
            data=data,
            json=json,
        )

    def post_peers_id_store_straight(
        self,
        id_: str,
        content: RequestContent = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Straight store to peer

        Synchronously send the DICOM instance in the POST body to the Orthanc peer whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `curl`.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the modality of interest
        content
                - (Content-Type: "application/dicom") DICOM instance to be sent

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._post(
            route=f"{self.url}/peers/{id_}/store-straight",
            content=content,
        )

    def get_peers_id_system(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get peer system information

        Get system information about some Orthanc peer. This corresponds to doing a `GET` request against the `/system` URI of the remote peer. This route can be used to test connectivity.
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the peer of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            System information about the peer
        """
        return self._get(
            route=f"{self.url}/peers/{id_}/system",
        )

    def get_plugins(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List plugins

        List all the installed plugins
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the identifiers of the installed plugins
        """
        return self._get(
            route=f"{self.url}/plugins",
        )

    def get_plugins_explorer_js(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """JavaScript extensions to Orthanc Explorer

        Get the JavaScript extensions that are installed by all the plugins using the `OrthancPluginExtendOrthancExplorer()` function of the plugin SDK. This route is for internal use of Orthanc Explorer.
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The JavaScript extensions
        """
        return self._get(
            route=f"{self.url}/plugins/explorer.js",
        )

    def get_plugins_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get plugin

        Get system information about the plugin whose identifier is provided in the URL
        Tags: System

        Parameters
        ----------
        id_
            Identifier of the job of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing information about the plugin
        """
        return self._get(
            route=f"{self.url}/plugins/{id_}",
        )

    def get_queries(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List query/retrieve operations

        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
        Tags: Networking

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the identifiers
        """
        return self._get(
            route=f"{self.url}/queries",
        )

    def delete_queries_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete a query

        Delete the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/queries/{id_}",
        )

    def get_queries_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on a query

        List the available operations for the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the list of operations
        """
        return self._get(
            route=f"{self.url}/queries/{id_}",
        )

    def get_queries_id_answers(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List answers to a query

        List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual answers
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the indices of the answers, or detailed information about the reported answers (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/queries/{id_}/answers",
            params=params,
        )

    def get_queries_id_answers_index(
        self,
        id_: str,
        index: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on an answer

        List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        index
            Index of the answer
        id_
            Identifier of the query of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the list of operations
        """
        return self._get(
            route=f"{self.url}/queries/{id_}/answers/{index}",
        )

    def get_queries_id_answers_index_content(
        self,
        id_: str,
        index: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get one answer

        Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        index
            Index of the answer
        id_
            Identifier of the query of interest
        params
            Dictionary of optional parameters:
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the DICOM tags of the answer
        """
        return self._get(
            route=f"{self.url}/queries/{id_}/answers/{index}/content",
            params=params,
        )

    def post_queries_id_answers_index_query_instances(
        self,
        id_: str,
        index: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Query the child instances of an answer

        Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
        Tags: Networking

        Parameters
        ----------
        index
            Index of the answer
        id_
            Identifier of the query of interest
        json
            Dictionary with the following keys:
              "Query": Associative array containing the filter on the values of the DICOM tags
              "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/queries/{id_}/answers/{index}/query-instances",
            json=json,
        )

    def post_queries_id_answers_index_query_series(
        self,
        id_: str,
        index: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Query the child series of an answer

        Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
        Tags: Networking

        Parameters
        ----------
        index
            Index of the answer
        id_
            Identifier of the query of interest
        json
            Dictionary with the following keys:
              "Query": Associative array containing the filter on the values of the DICOM tags
              "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/queries/{id_}/answers/{index}/query-series",
            json=json,
        )

    def post_queries_id_answers_index_query_studies(
        self,
        id_: str,
        index: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Query the child studies of an answer

        Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
        Tags: Networking

        Parameters
        ----------
        index
            Index of the answer
        id_
            Identifier of the query of interest
        json
            Dictionary with the following keys:
              "Query": Associative array containing the filter on the values of the DICOM tags
              "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/queries/{id_}/answers/{index}/query-studies",
            json=json,
        )

    def post_queries_id_answers_index_retrieve(
        self,
        id_: str,
        index: str,
        data: RequestData = None,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Retrieve one answer

        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
        Tags: Networking

        Parameters
        ----------
        index
            Index of the answer
        id_
            Identifier of the query of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Simplify": If set to `true`, report the DICOM tags in human-readable format (using the symbolic name of the tags)
              "Synchronous": 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.
              "TargetAet": AET of the target modality. By default, the AET of Orthanc is used, as defined in the `DicomAet` configuration option.
              "Timeout": Timeout for the C-MOVE command, in seconds

        data
            AET of the target modality

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/queries/{id_}/answers/{index}/retrieve",
            data=data,
            json=json,
        )

    def get_queries_id_level(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get level of original query

        Get the query level (value of the `QueryRetrieveLevel` tag) of the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The level
        """
        return self._get(
            route=f"{self.url}/queries/{id_}/level",
        )

    def get_queries_id_modality(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get modality of original query

        Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The identifier of the DICOM modality
        """
        return self._get(
            route=f"{self.url}/queries/{id_}/modality",
        )

    def get_queries_id_query(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get original query arguments

        Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest
        params
            Dictionary of optional parameters:
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Content of the original query
        """
        return self._get(
            route=f"{self.url}/queries/{id_}/query",
            params=params,
        )

    def post_queries_id_retrieve(
        self,
        id_: str,
        data: RequestData = None,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Retrieve all answers

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the query of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Simplify": If set to `true`, report the DICOM tags in human-readable format (using the symbolic name of the tags)
              "Synchronous": 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.
              "TargetAet": AET of the target modality. By default, the AET of Orthanc is used, as defined in the `DicomAet` configuration option.
              "Timeout": Timeout for the C-MOVE command, in seconds

        data
            AET of the target modality

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/queries/{id_}/retrieve",
            data=data,
            json=json,
        )

    def get_series(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List the available series

        List the Orthanc identifiers of all the available DICOM series
        Tags: Series

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual series
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "limit" (float): Limit the number of results
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "since" (float): Show only the resources since the provided index

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the Orthanc identifiers, or detailed information about the reported series (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/series",
            params=params,
        )

    def delete_series_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete some series

        Delete the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/series/{id_}",
        )

    def get_series_id(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get information about some series

        Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM series
        """
        return self._get(
            route=f"{self.url}/series/{id_}",
            params=params,
        )

    def post_series_id_anonymize(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Anonymize series

        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
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
              "KeepLabels": Keep the labels of all resources level (defaults to `false`)
              "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of additional tags to be removed from 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).
              "Replace": 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).
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/series/{id_}/anonymize",
            json=json,
        )

    def get_series_id_archive(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Synchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
                "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            ZIP file containing the archive
        """
        return self._get(
            route=f"{self.url}/series/{id_}/archive",
            params=params,
        )

    def post_series_id_archive(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/series/{id_}/archive",
            json=json,
        )

    def get_series_id_attachments(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List attachments

        Get the list of attachments that are associated with the given series
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "full" (str): If present, retrieve the attachments list and their numerical ids

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the attachments
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments",
            params=params,
        )

    def delete_series_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete attachment

        Delete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/series/{id_}/attachments/{name}",
            headers=headers,
        )

    def get_series_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on attachments

        Get the list of the operations that are available for attachments associated with the given series
        Tags: Other

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}",
            headers=headers,
        )

    def put_series_id_attachments_name(
        self,
        id_: str,
        name: str,
        content: RequestContent = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set attachment

        Attach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        content
                - (Content-Type: "application/octet-stream") Binary data containing the attachment
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._put(
            route=f"{self.url}/series/{id_}/attachments/{name}",
            content=content,
            headers=headers,
        )

    def post_series_id_attachments_name_compress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Compress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/series/{id_}/attachments/{name}/compress",
        )

    def get_series_id_attachments_name_compressed_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment (no decompression)

        Get the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if `StorageCompression` is `true`.
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/compressed-data",
            headers=headers,
        )

    def get_series_id_attachments_name_compressed_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment on disk

        Get the MD5 hash of one attachment associated with the given series, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/compressed-md5",
            headers=headers,
        )

    def get_series_id_attachments_name_compressed_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment on disk

        Get the size of one attachment associated with the given series, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/compressed-size",
            headers=headers,
        )

    def get_series_id_attachments_name_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment

        Get the (binary) content of one attachment associated with the given series
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/data",
            headers=headers,
        )

    def get_series_id_attachments_name_info(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get info about the attachment

        Get all the information about the attachment associated with the given series
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the information about the attachment
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/info",
            headers=headers,
        )

    def get_series_id_attachments_name_is_compressed(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Is attachment compressed?

        Test whether the attachment has been stored as a compressed file on the disk.
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `0` if the attachment was stored uncompressed, `1` if it was compressed
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/is-compressed",
            headers=headers,
        )

    def get_series_id_attachments_name_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment

        Get the MD5 hash of one attachment associated with the given series
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/md5",
            headers=headers,
        )

    def get_series_id_attachments_name_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment

        Get the size of one attachment associated with the given series
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment
        """
        return self._get(
            route=f"{self.url}/series/{id_}/attachments/{name}/size",
            headers=headers,
        )

    def post_series_id_attachments_name_uncompress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Uncompress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/series/{id_}/attachments/{name}/uncompress",
        )

    def post_series_id_attachments_name_verify_md5(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Verify attachment

        Verify that the attachment is not corrupted, by validating its MD5 hash
        Tags: Series

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            On success, a valid JSON object is returned
        """
        return self._post(
            route=f"{self.url}/series/{id_}/attachments/{name}/verify-md5",
        )

    def get_series_id_instances(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get child instances

        Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If false or missing, only retrieve the list of child instances
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing information about the child DICOM instances
        """
        return self._get(
            route=f"{self.url}/series/{id_}/instances",
            params=params,
        )

    def get_series_id_instances_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get tags of instances

        Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags
        """
        return self._get(
            route=f"{self.url}/series/{id_}/instances-tags",
            params=params,
        )

    def get_series_id_labels(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List labels

        Get the labels that are associated with the given series (new in Orthanc 1.12.0)
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the labels
        """
        return self._get(
            route=f"{self.url}/series/{id_}/labels",
        )

    def delete_series_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Remove label

        Remove a label associated with a series
        Tags: Series

        Parameters
        ----------
        label
            The label to be removed
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/series/{id_}/labels/{label}",
        )

    def get_series_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Test label

        Test whether the series is associated with the given label
        Tags: Series

        Parameters
        ----------
        label
            The label of interest
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty string is returned in the case of presence, error 404 in the case of absence
        """
        return self._get(
            route=f"{self.url}/series/{id_}/labels/{label}",
        )

    def put_series_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Add label

        Associate a label with a series
        Tags: Series

        Parameters
        ----------
        label
            The label to be added
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/series/{id_}/labels/{label}",
        )

    def get_series_id_media(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Synchronously create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "extended" (str): If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*
                "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
                "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            ZIP file containing the archive
        """
        return self._get(
            route=f"{self.url}/series/{id_}/media",
            params=params,
        )

    def post_series_id_media(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/series/{id_}/media",
            json=json,
        )

    def get_series_id_metadata(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List metadata

        Get the list of metadata that are associated with the given series
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If present, also retrieve the value of the individual metadata
                "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/series/{id_}/metadata",
            params=params,
        )

    def delete_series_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete metadata

        Delete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
        Tags: Series

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/series/{id_}/metadata/{name}",
            headers=headers,
        )

    def get_series_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get metadata

        Get the value of a metadata that is associated with the given series
        Tags: Series

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the series of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Value of the metadata
        """
        return self._get(
            route=f"{self.url}/series/{id_}/metadata/{name}",
            headers=headers,
        )

    def put_series_id_metadata_name(
        self,
        id_: str,
        name: str,
        data: RequestData = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set metadata

        Set the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
        Tags: Series

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the series of interest
        data
            String value of the metadata
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/series/{id_}/metadata/{name}",
            data=data,
            headers=headers,
        )

    def post_series_id_modify(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Modify series

        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
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of tags that must be removed from 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).
              "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
              "Replace": 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).
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/series/{id_}/modify",
            json=json,
        )

    def get_series_id_module(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get series module

        Get the series module of the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM series
        """
        return self._get(
            route=f"{self.url}/series/{id_}/module",
            params=params,
        )

    def get_series_id_numpy(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Decode series for numpy

        Decode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the DICOM resource of interest
        params
            Dictionary of optional parameters:
                "compress" (bool): Compress the file as `.npz`
                "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html
        """
        return self._get(
            route=f"{self.url}/series/{id_}/numpy",
            params=params,
        )

    def get_series_id_ordered_slices(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Order the slices

        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.
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
        return self._get(
            route=f"{self.url}/series/{id_}/ordered-slices",
        )

    def get_series_id_patient(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get parent patient

        Get detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the parent DICOM patient
        """
        return self._get(
            route=f"{self.url}/series/{id_}/patient",
            params=params,
        )

    def post_series_id_reconstruct(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Reconstruct tags & optionally files of series

        Reconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        json
            Dictionary with the following keys:
              "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
              "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/series/{id_}/reconstruct",
            json=json,
        )

    def get_series_id_shared_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get shared tags

        Extract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the values of the DICOM tags
        """
        return self._get(
            route=f"{self.url}/series/{id_}/shared-tags",
            params=params,
        )

    def get_series_id_statistics(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get series statistics

        Get statistics about the given series
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/series/{id_}/statistics",
        )

    def get_series_id_study(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get parent study

        Get detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL
        Tags: Series

        Parameters
        ----------
        id_
            Orthanc identifier of the series of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the parent DICOM study
        """
        return self._get(
            route=f"{self.url}/series/{id_}/study",
            params=params,
        )

    def get_statistics(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get database statistics

        Get statistics related to the database of Orthanc
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/statistics",
        )

    def get_storage_commitment_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get storage commitment report

        Get the storage commitment report whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the storage commitment report

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/storage-commitment/{id_}",
        )

    def post_storage_commitment_id_remove(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Remove after storage commitment

        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
        Tags: Networking

        Parameters
        ----------
        id_
            Identifier of the storage commitment report

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/storage-commitment/{id_}/remove",
        )

    def get_studies(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List the available studies

        List the Orthanc identifiers of all the available DICOM studies
        Tags: Studies

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "expand" (str): If present, retrieve detailed information about the individual studies
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "limit" (float): Limit the number of results
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "since" (float): Show only the resources since the provided index

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the Orthanc identifiers, or detailed information about the reported studies (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/studies",
            params=params,
        )

    def delete_studies_id(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete some study

        Delete the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/studies/{id_}",
        )

    def get_studies_id(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get information about some study

        Get detailed information about the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM study
        """
        return self._get(
            route=f"{self.url}/studies/{id_}",
            params=params,
        )

    def post_studies_id_anonymize(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Anonymize study

        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
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
              "KeepLabels": Keep the labels of all resources level (defaults to `false`)
              "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of additional tags to be removed from 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).
              "Replace": 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).
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/anonymize",
            json=json,
        )

    def get_studies_id_archive(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Synchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
                "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            ZIP file containing the archive
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/archive",
            params=params,
        )

    def post_studies_id_archive(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/archive",
            json=json,
        )

    def get_studies_id_attachments(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List attachments

        Get the list of attachments that are associated with the given study
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "full" (str): If present, retrieve the attachments list and their numerical ids

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the attachments
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments",
            params=params,
        )

    def delete_studies_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete attachment

        Delete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/studies/{id_}/attachments/{name}",
            headers=headers,
        )

    def get_studies_id_attachments_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations on attachments

        Get the list of the operations that are available for attachments associated with the given study
        Tags: Other

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}",
            headers=headers,
        )

    def put_studies_id_attachments_name(
        self,
        id_: str,
        name: str,
        content: RequestContent = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set attachment

        Attach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        content
                - (Content-Type: "application/octet-stream") Binary data containing the attachment
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty JSON object in the case of a success
        """
        return self._put(
            route=f"{self.url}/studies/{id_}/attachments/{name}",
            content=content,
            headers=headers,
        )

    def post_studies_id_attachments_name_compress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Compress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/studies/{id_}/attachments/{name}/compress",
        )

    def get_studies_id_attachments_name_compressed_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment (no decompression)

        Get the (binary) content of one attachment associated with the given study. The attachment will not be decompressed if `StorageCompression` is `true`.
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/compressed-data",
            headers=headers,
        )

    def get_studies_id_attachments_name_compressed_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment on disk

        Get the MD5 hash of one attachment associated with the given study, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/compressed-md5",
            headers=headers,
        )

    def get_studies_id_attachments_name_compressed_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment on disk

        Get the size of one attachment associated with the given study, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment, as stored on the disk
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/compressed-size",
            headers=headers,
        )

    def get_studies_id_attachments_name_data(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get attachment

        Get the (binary) content of one attachment associated with the given study
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The attachment
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/data",
            headers=headers,
        )

    def get_studies_id_attachments_name_info(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get info about the attachment

        Get all the information about the attachment associated with the given study
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the information about the attachment
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/info",
            headers=headers,
        )

    def get_studies_id_attachments_name_is_compressed(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Is attachment compressed?

        Test whether the attachment has been stored as a compressed file on the disk.
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `0` if the attachment was stored uncompressed, `1` if it was compressed
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/is-compressed",
            headers=headers,
        )

    def get_studies_id_attachments_name_md5(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get MD5 of attachment

        Get the MD5 hash of one attachment associated with the given study
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The MD5 of the attachment
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/md5",
            headers=headers,
        )

    def get_studies_id_attachments_name_size(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get size of attachment

        Get the size of one attachment associated with the given study
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The size of the attachment
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/attachments/{name}/size",
            headers=headers,
        )

    def post_studies_id_attachments_name_uncompress(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Uncompress attachment

        Change the compression scheme that is used to store an attachment.
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/studies/{id_}/attachments/{name}/uncompress",
        )

    def post_studies_id_attachments_name_verify_md5(
        self,
        id_: str,
        name: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Verify attachment

        Verify that the attachment is not corrupted, by validating its MD5 hash
        Tags: Studies

        Parameters
        ----------
        name
            The name of the attachment, or its index (cf. `UserContentType` configuration option)
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            On success, a valid JSON object is returned
        """
        return self._post(
            route=f"{self.url}/studies/{id_}/attachments/{name}/verify-md5",
        )

    def get_studies_id_instances(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get child instances

        Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If false or missing, only retrieve the list of child instances
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing information about the child DICOM instances
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/instances",
            params=params,
        )

    def get_studies_id_instances_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get tags of instances

        Get the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/instances-tags",
            params=params,
        )

    def get_studies_id_labels(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List labels

        Get the labels that are associated with the given study (new in Orthanc 1.12.0)
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the labels
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/labels",
        )

    def delete_studies_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Remove label

        Remove a label associated with a study
        Tags: Studies

        Parameters
        ----------
        label
            The label to be removed
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/studies/{id_}/labels/{label}",
        )

    def get_studies_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Test label

        Test whether the study is associated with the given label
        Tags: Studies

        Parameters
        ----------
        label
            The label of interest
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Empty string is returned in the case of presence, error 404 in the case of absence
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/labels/{label}",
        )

    def put_studies_id_labels_label(
        self,
        id_: str,
        label: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Add label

        Associate a label with a study
        Tags: Studies

        Parameters
        ----------
        label
            The label to be added
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/studies/{id_}/labels/{label}",
        )

    def get_studies_id_media(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Synchronously create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "extended" (str): If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*
                "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
                "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            ZIP file containing the archive
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/media",
            params=params,
        )

    def post_studies_id_media(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/media",
            json=json,
        )

    def post_studies_id_merge(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Merge study

        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
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "KeepSource": If set to `true`, instructs Orthanc to keep a copy of the original resources in their source study. By default, the original resources are deleted from Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": The list of DICOM resources (studies, series, and/or instances) to be merged into the study of interest (mandatory option)
              "Synchronous": 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.


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/merge",
            json=json,
        )

    def get_studies_id_metadata(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List metadata

        Get the list of metadata that are associated with the given study
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If present, also retrieve the value of the individual metadata
                "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/metadata",
            params=params,
        )

    def delete_studies_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete metadata

        Delete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
        Tags: Studies

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._delete(
            route=f"{self.url}/studies/{id_}/metadata/{name}",
            headers=headers,
        )

    def get_studies_id_metadata_name(
        self,
        id_: str,
        name: str,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get metadata

        Get the value of a metadata that is associated with the given study
        Tags: Studies

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the study of interest
        headers
            Dictionary of optional headers:
                "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Value of the metadata
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/metadata/{name}",
            headers=headers,
        )

    def put_studies_id_metadata_name(
        self,
        id_: str,
        name: str,
        data: RequestData = None,
        headers: HeaderTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set metadata

        Set the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
        Tags: Studies

        Parameters
        ----------
        name
            The name of the metadata, or its index (cf. `UserMetadata` configuration option)
        id_
            Orthanc identifier of the study of interest
        data
            String value of the metadata
        headers
            Dictionary of optional headers:
                "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/studies/{id_}/metadata/{name}",
            data=data,
            headers=headers,
        )

    def post_studies_id_modify(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Modify study

        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
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of tags that must be removed from 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).
              "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
              "Replace": 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).
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/modify",
            json=json,
        )

    def get_studies_id_module(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get study module

        Get the study module of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM study
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/module",
            params=params,
        )

    def get_studies_id_module_patient(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get patient module of study

        Get the patient module of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the DICOM study
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/module-patient",
            params=params,
        )

    def get_studies_id_patient(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get parent patient

        Get detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Information about the parent DICOM patient
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/patient",
            params=params,
        )

    def post_studies_id_reconstruct(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Reconstruct tags & optionally files of study

        Reconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
              "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/reconstruct",
            json=json,
        )

    def get_studies_id_series(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get child series

        Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "expand" (str): If false or missing, only retrieve the list of child series
                "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
                "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
                "short" (bool): If present, report the DICOM tags in hexadecimal format

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing information about the child DICOM series
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/series",
            params=params,
        )

    def get_studies_id_shared_tags(
        self,
        id_: str,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get shared tags

        Extract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        params
            Dictionary of optional parameters:
                "short" (bool): If present, report the DICOM tags in hexadecimal format
                "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON object containing the values of the DICOM tags
        """
        return self._get(
            route=f"{self.url}/studies/{id_}/shared-tags",
            params=params,
        )

    def post_studies_id_split(
        self,
        id_: str,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Split study

        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
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Instances": The list of instances to be separated from the parent study. These instances must all be children of the same source study, that is specified in the URI.
              "KeepLabels": Keep the labels of all resources level (defaults to `false`)
              "KeepSource": If set to `true`, instructs Orthanc to keep a copy of the original series/instances in the source study. By default, the original series/instances are deleted from Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Remove": List of tags that must be removed in the new study (from the same modules as in the `Replace` option)
              "Replace": Associative array to change the value of some DICOM tags in the new study. These tags must be part of the "Patient Module Attributes" or the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3.
              "Series": The list of series to be separated from the parent study. These series must all be children of the same source study, that is specified in the URI.
              "Synchronous": 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.


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/studies/{id_}/split",
            json=json,
        )

    def get_studies_id_statistics(
        self,
        id_: str,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get study statistics

        Get statistics about the given study
        Tags: Studies

        Parameters
        ----------
        id_
            Orthanc identifier of the study of interest

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/studies/{id_}/statistics",
        )

    def get_system(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get system information

        Get system information about Orthanc
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        return self._get(
            route=f"{self.url}/system",
        )

    def get_tools(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """List operations

        List the available operations under URI `/tools/`
        Tags: Other

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            List of the available operations
        """
        return self._get(
            route=f"{self.url}/tools",
        )

    def get_tools_accepted_transfer_syntaxes(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get accepted transfer syntaxes

        Get the list of UIDs of the DICOM transfer syntaxes that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options `AcceptedTransferSyntaxes` and `XXXTransferSyntaxAccepted`.
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the transfer syntax UIDs
        """
        return self._get(
            route=f"{self.url}/tools/accepted-transfer-syntaxes",
        )

    def put_tools_accepted_transfer_syntaxes(
        self,
        data: RequestData = None,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set accepted transfer syntaxes

        Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:

        data
            UID of the transfer syntax to be accepted. Wildcards `?` and `*` are accepted.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the now-accepted transfer syntax UIDs
        """
        if json is None:
            json = {}
        return self._put(
            route=f"{self.url}/tools/accepted-transfer-syntaxes",
            data=data,
            json=json,
        )

    def post_tools_bulk_anonymize(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Anonymize a set of resources

        Start a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
              "KeepLabels": Keep the labels of all resources level (defaults to `false`)
              "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of additional tags to be removed from 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).
              "Replace": 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).
              "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The list of all the resources that have been created by this anonymization
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/bulk-anonymize",
            json=json,
        )

    def post_tools_bulk_content(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Describe a set of resources

        Get the content all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field, in one single call.
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
              "Level": This optional argument specifies the level of interest (can be `Patient`, `Study`, `Series` or `Instance`). Orthanc will loop over the items inside `Resources`, and explore upward or downward in the DICOM hierarchy in order to find the level of interest.
              "Metadata": If set to `true` (default value), the metadata associated with the resources will also be retrieved.
              "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.
              "Short": If set to `true`, report the DICOM tags in hexadecimal format


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/bulk-content",
            json=json,
        )

    def post_tools_bulk_delete(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Delete a set of resources

        Delete all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/bulk-delete",
            json=json,
        )

    def post_tools_bulk_modify(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Modify a set of resources

        Start a job that will modify all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
              "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
              "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
              "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
              "Level": Level of the modification (`Patient`, `Study`, `Series` or `Instance`). If absent, the level defaults to `Instance`, but is set to `Patient` if `PatientID` is modified, to `Study` if `StudyInstanceUID` is modified, or to `Series` if `SeriesInstancesUID` is modified. (new in Orthanc 1.9.7)
              "Permissive": If `true`, ignore errors during the individual steps of the job.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "PrivateCreator": The private creator to be used for private tags in `Replace`
              "Remove": List of tags that must be removed from 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).
              "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
              "Replace": 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).
              "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.
              "Synchronous": 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.
              "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The list of all the resources that have been altered by this modification
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/bulk-modify",
            json=json,
        )

    def get_tools_create_archive(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
        Tags: System

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "resources" (str): A comma separated list of Orthanc resource identifiers to include in the ZIP archive.
                "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._get(
            route=f"{self.url}/tools/create-archive",
            params=params,
        )

    def post_tools_create_archive(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create ZIP archive

        Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": The list of Orthanc identifiers of interest.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/create-archive",
            json=json,
        )

    def post_tools_create_dicom(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create one DICOM instance

        Create one DICOM instance, and store it into Orthanc
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Content": This field can be used to embed an image (pixel data encoded as PNG or JPEG), a PDF, or a 3D manufactoring model (MTL/OBJ/STL) inside the created DICOM instance. The file to be encapsulated must be provided using its [data URI scheme encoding](https://en.wikipedia.org/wiki/Data_URI_scheme). This field can possibly contain a JSON array, in which case a DICOM series is created containing one DICOM instance for each item in the `Content` field.
              "Force": Avoid the consistency checks for the DICOM tags that enforce the DICOM model of the real-world. You can notably use this flag if you need to manually set the tags `StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`. Be careful with this feature.
              "InterpretBinaryTags": If some value in the `Tags` associative array is formatted according to some [data URI scheme encoding](https://en.wikipedia.org/wiki/Data_URI_scheme), whether this value is decoded to a binary value or kept as such (`true` by default)
              "Parent": If present, the newly created instance will be attached to the parent DICOM resource whose Orthanc identifier is contained in this field. The DICOM tags of the parent modules in the DICOM hierarchy will be automatically copied to the newly created instance.
              "PrivateCreator": The private creator to be used for private tags in `Tags`
              "Tags": Associative array containing the tags of the new instance to be created


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]

        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/create-dicom",
            json=json,
        )

    def get_tools_create_media(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
        Tags: System

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "resources" (str): A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media.
                "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._get(
            route=f"{self.url}/tools/create-media",
            params=params,
        )

    def post_tools_create_media(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": The list of Orthanc identifiers of interest.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/create-media",
            json=json,
        )

    def get_tools_create_media_extended(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
        Tags: System

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "resources" (str): A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media.
                "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._get(
            route=f"{self.url}/tools/create-media-extended",
            params=params,
        )

    def post_tools_create_media_extended(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Create DICOMDIR media

        Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
              "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `true`.
              "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
              "Resources": The list of Orthanc identifiers of interest.
              "Synchronous": 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.
              "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            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
            In synchronous mode, the ZIP file containing the archive
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/create-media-extended",
            json=json,
        )

    def get_tools_default_encoding(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get default encoding

        Get the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The name of the encoding
        """
        return self._get(
            route=f"{self.url}/tools/default-encoding",
        )

    def put_tools_default_encoding(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set default encoding

        Change the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.
        Tags: System

        Parameters
        ----------
        data
            The name of the encoding. Check out configuration option `DefaultEncoding` for the allowed values.

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/default-encoding",
            data=data,
        )

    def get_tools_dicom_conformance(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get DICOM conformance

        Get the DICOM conformance statement of Orthanc
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The DICOM conformance statement
        """
        return self._get(
            route=f"{self.url}/tools/dicom-conformance",
        )

    def post_tools_dicom_echo(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Trigger C-ECHO SCU

        Trigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some `/modalities/{id}` (new in Orthanc 1.8.1)
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "AET": AET of the remote DICOM modality
              "CheckFind": Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` configuration option. New in Orthanc 1.8.1.
              "Host": Host address of the remote DICOM modality (typically, an IP address)
              "LocalAet": Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality
              "Manufacturer": Manufacturer of the remote DICOM modality (check configuration option `DicomModalities` for possible values
              "Port": TCP port of the remote DICOM modality
              "Timeout": Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality
              "UseDicomTls": Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/dicom-echo",
            json=json,
        )

    def post_tools_execute_script(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Execute Lua script

        Execute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible.  Since Orthanc 1.5.8, this route is disabled by default and can be enabled thanks to the `ExecuteLuaEnabled` configuration.
        Tags: System

        Parameters
        ----------
        data
            The Lua script to be executed

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Output of the Lua script
        """
        return self._post(
            route=f"{self.url}/tools/execute-script",
            data=data,
        )

    def post_tools_find(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Look for local resources

        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
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "CaseSensitive": Enable case-sensitive search for PN value representations (defaults to configuration option `CaseSensitivePN`)
              "Expand": Also retrieve the content of the matching resources, not only their Orthanc identifiers
              "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
              "Labels": List of strings specifying which labels to look for in the resources (new in Orthanc 1.12.0)
              "LabelsConstraint": Constraint on the labels, can be `All`, `Any`, or `None` (defaults to `All`, new in Orthanc 1.12.0)
              "Level": Level of the query (`Patient`, `Study`, `Series` or `Instance`)
              "Limit": Limit the number of reported resources
              "Query": Associative array containing the filter on the values of the DICOM tags
              "RequestedTags": A list of DICOM tags to include in the response (applicable only if "Expand" is set to true).  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
              "Short": If set to `true`, report the DICOM tags in hexadecimal format
              "Since": Show only the resources since the provided index (in conjunction with `Limit`)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing either the Orthanc identifiers, or detailed information about the reported resources (if `Expand` argument is `true`)
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/find",
            json=json,
        )

    def get_tools_generate_uid(
        self,
        params: QueryParamTypes = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Generate an identifier

        Generate a random DICOM identifier
        Tags: System

        Parameters
        ----------
        params
            Dictionary of optional parameters:
                "level" (str): Type of DICOM resource among: `patient`, `study`, `series` or `instance`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The generated identifier
        """
        return self._get(
            route=f"{self.url}/tools/generate-uid_",
            params=params,
        )

    def post_tools_invalid_ate_tags(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Invalidate DICOM-as-JSON summaries

        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
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/tools/invalid_ate-tags",
        )

    def get_tools_labels(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get all the used labels

        List all the labels that are associated with any resource of the Orthanc database
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing the labels
        """
        return self._get(
            route=f"{self.url}/tools/labels",
        )

    def get_tools_log_level(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get main log level

        Get the main log level of Orthanc
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level",
        )

    def put_tools_log_level(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set main log level

        Set the main log level of Orthanc
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level",
            data=data,
        )

    def get_tools_log_level_dicom(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `dicom`

        Get the log level of the log category `dicom`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-dicom",
        )

    def put_tools_log_level_dicom(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `dicom`

        Set the log level of the log category `dicom`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-dicom",
            data=data,
        )

    def get_tools_log_level_generic(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `generic`

        Get the log level of the log category `generic`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-generic",
        )

    def put_tools_log_level_generic(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `generic`

        Set the log level of the log category `generic`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-generic",
            data=data,
        )

    def get_tools_log_level_http(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `http`

        Get the log level of the log category `http`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-http",
        )

    def put_tools_log_level_http(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `http`

        Set the log level of the log category `http`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-http",
            data=data,
        )

    def get_tools_log_level_jobs(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `jobs`

        Get the log level of the log category `jobs`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-jobs",
        )

    def put_tools_log_level_jobs(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `jobs`

        Set the log level of the log category `jobs`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-jobs",
            data=data,
        )

    def get_tools_log_level_lua(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `lua`

        Get the log level of the log category `lua`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-lua",
        )

    def put_tools_log_level_lua(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `lua`

        Set the log level of the log category `lua`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-lua",
            data=data,
        )

    def get_tools_log_level_plugins(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `plugins`

        Get the log level of the log category `plugins`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-plugins",
        )

    def put_tools_log_level_plugins(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `plugins`

        Set the log level of the log category `plugins`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-plugins",
            data=data,
        )

    def get_tools_log_level_sqlite(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get log level for `sqlite`

        Get the log level of the log category `sqlite`
        Tags: Logs

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            Possible values: `default`, `verbose` or `trace`
        """
        return self._get(
            route=f"{self.url}/tools/log-level-sqlite",
        )

    def put_tools_log_level_sqlite(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set log level for `sqlite`

        Set the log level of the log category `sqlite`
        Tags: Logs

        Parameters
        ----------
        data
            Possible values: `default`, `verbose` or `trace`

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/log-level-sqlite",
            data=data,
        )

    def post_tools_lookup(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Look for DICOM identifiers

        This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources
        Tags: System

        Parameters
        ----------
        data
            The DICOM identifier of interest (i.e. the value of `PatientID`, `StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`)

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            JSON array containing a list of matching Orthanc resources, each item in the list corresponding to a JSON object with the fields `Type`, `ID` and `Path` identifying one DICOM resource that is stored by Orthanc
        """
        return self._post(
            route=f"{self.url}/tools/lookup",
            data=data,
        )

    def get_tools_metrics(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Are metrics collected?

        Returns a Boolean specifying whether Prometheus metrics are collected and exposed at `/tools/metrics-prometheus`
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `1` if metrics are collected, `0` if metrics are disabled
        """
        return self._get(
            route=f"{self.url}/tools/metrics",
        )

    def put_tools_metrics(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Enable collection of metrics

        Enable or disable the collection and publication of metrics at `/tools/metrics-prometheus`
        Tags: System

        Parameters
        ----------
        data
            `1` if metrics are collected, `0` if metrics are disabled

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/metrics",
            data=data,
        )

    def get_tools_metrics_prometheus(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get usage metrics

        Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            No description
        """
        return self._get(
            route=f"{self.url}/tools/metrics-prometheus",
        )

    def get_tools_now(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get UTC time

        Get UTC time
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The UTC time
        """
        return self._get(
            route=f"{self.url}/tools/now",
        )

    def get_tools_now_local(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Get local time

        Get local time
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            The local time
        """
        return self._get(
            route=f"{self.url}/tools/now-local",
        )

    def post_tools_reconstruct(
        self,
        json: Any = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Reconstruct all the index

        Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource
        Tags: System

        Parameters
        ----------
        json
            Dictionary with the following keys:
              "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        if json is None:
            json = {}
        return self._post(
            route=f"{self.url}/tools/reconstruct",
            json=json,
        )

    def post_tools_reset(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Restart Orthanc

        Restart Orthanc
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/tools/reset",
        )

    def post_tools_shutdown(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Shutdown Orthanc

        Shutdown Orthanc
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._post(
            route=f"{self.url}/tools/shutdown",
        )

    def get_tools_unknown_sop_class_accepted(
        self,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Is unknown SOP class accepted?

        Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?
        Tags: System

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
            `1` if accepted, `0` if not accepted
        """
        return self._get(
            route=f"{self.url}/tools/unknown-sop-class-accepted",
        )

    def put_tools_unknown_sop_class_accepted(
        self,
        data: RequestData = None,
    ) -> Union[Dict, List, str, bytes, int, httpx.Response]:
        """Set unknown SOP class accepted

        Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID
        Tags: System

        Parameters
        ----------
        data
            `1` if accepted, `0` if not accepted

        Returns
        -------
        Union[Dict, List, str, bytes, int, httpx.Response]
        """
        return self._put(
            route=f"{self.url}/tools/unknown-sop-class-accepted",
            data=data,
        )

__init__(url, username=None, password=None, return_raw_response=False, *args, **kwargs)

Parameters:

Name Type Description Default
url str

server's URL

required
username Optional[str]

Orthanc's username

None
password Optional[str]

Orthanc's password

None
return_raw_response bool

All Orthanc's methods will return a raw httpx.Response rather than the serialized result

False
*args

Parameters passed to the httpx.Client (headers, timeout, etc.)

()
**kwargs

Parameters passed to the httpx.Client (headers, timeout, etc.)

()
Source code in pyorthanc/client.py
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def __init__(
    self,
    url: str,
    username: Optional[str] = None,
    password: Optional[str] = None,
    return_raw_response: bool = False,
    *args,
    **kwargs,
):
    """
    Parameters
    ----------
    url
        server's URL
    username
        Orthanc's username
    password
        Orthanc's password
    return_raw_response
        All Orthanc's methods will return a raw httpx.Response rather than the serialized result
    *args, **kwargs
        Parameters passed to the httpx.Client (headers, timeout, etc.)
    """
    super().__init__(*args, **kwargs)
    self.url = url
    self.version = "1.12.4"
    self.return_raw_response = return_raw_response

    if username and password:
        self.setup_credentials(username, password)

delete_changes()

Clear changes

Clear the full history stored in the changes log Tags: Tracking changes

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def delete_changes(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Clear changes

    Clear the full history stored in the changes log
    Tags: Tracking changes

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/changes",
    )

delete_exports()

Clear exports

Clear the full history stored in the exports log Tags: Tracking changes

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
def delete_exports(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Clear exports

    Clear the full history stored in the exports log
    Tags: Tracking changes

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/exports",
    )

delete_instances_id(id_)

Delete some instance

Delete the DICOM instance whose Orthanc identifier is provided in the URL Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
def delete_instances_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete some instance

    Delete the DICOM instance whose Orthanc identifier is provided in the URL
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/instances/{id_}",
    )

delete_instances_id_attachments_name(id_, name, headers=None)

Delete attachment

Delete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024). Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
def delete_instances_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete attachment

    Delete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/instances/{id_}/attachments/{name}",
        headers=headers,
    )

delete_instances_id_labels_label(id_, label)

Remove label

Remove a label associated with a instance Tags: Instances

Parameters:

Name Type Description Default
label str

The label to be removed

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
def delete_instances_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Remove label

    Remove a label associated with a instance
    Tags: Instances

    Parameters
    ----------
    label
        The label to be removed
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/instances/{id_}/labels/{label}",
    )

delete_instances_id_metadata_name(id_, name, headers=None)

Delete metadata

Delete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024). Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
def delete_instances_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete metadata

    Delete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
    Tags: Instances

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/instances/{id_}/metadata/{name}",
        headers=headers,
    )

delete_jobs_id(id_)

Delete a job from history

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. Tags: Jobs

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
def delete_jobs_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete a job from history

    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.
    Tags: Jobs

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/jobs/{id_}",
    )

delete_jobs_id_key(id_, key)

Delete a job output

Delete the output produced by a job. As of Orthanc 1.12.1, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with key equals to archive). Tags: Jobs

Parameters:

Name Type Description Default
key str

Name of the output of interest

required
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
def delete_jobs_id_key(
    self,
    id_: str,
    key: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete a job output

    Delete the output produced by a job. As of Orthanc 1.12.1, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).
    Tags: Jobs

    Parameters
    ----------
    key
        Name of the output of interest
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/jobs/{id_}/{key}",
    )

delete_modalities_id(id_)

Delete DICOM modality

Delete one DICOM modality. This change is permanent iff. DicomModalitiesInDatabase is true, otherwise it is lost at the next restart of Orthanc. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the DICOM modality of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
def delete_modalities_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete DICOM modality

    Delete one DICOM modality. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the DICOM modality of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/modalities/{id_}",
    )

delete_patients_id(id_)

Delete some patient

Delete the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
def delete_patients_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete some patient

    Delete the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/patients/{id_}",
    )

delete_patients_id_attachments_name(id_, name, headers=None)

Delete attachment

Delete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024). Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
def delete_patients_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete attachment

    Delete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/patients/{id_}/attachments/{name}",
        headers=headers,
    )

delete_patients_id_labels_label(id_, label)

Remove label

Remove a label associated with a patient Tags: Patients

Parameters:

Name Type Description Default
label str

The label to be removed

required
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
def delete_patients_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Remove label

    Remove a label associated with a patient
    Tags: Patients

    Parameters
    ----------
    label
        The label to be removed
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/patients/{id_}/labels/{label}",
    )

delete_patients_id_metadata_name(id_, name, headers=None)

Delete metadata

Delete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024). Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
def delete_patients_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete metadata

    Delete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
    Tags: Patients

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/patients/{id_}/metadata/{name}",
        headers=headers,
    )

delete_peers_id(id_)

Delete Orthanc peer

Delete one Orthanc peer. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart of Orthanc. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the Orthanc peer of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
def delete_peers_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete Orthanc peer

    Delete one Orthanc peer. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the Orthanc peer of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/peers/{id_}",
    )

delete_queries_id(id_)

Delete a query

Delete the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
def delete_queries_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete a query

    Delete the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/queries/{id_}",
    )

delete_series_id(id_)

Delete some series

Delete the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
def delete_series_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete some series

    Delete the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/series/{id_}",
    )

delete_series_id_attachments_name(id_, name, headers=None)

Delete attachment

Delete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024). Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
def delete_series_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete attachment

    Delete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/series/{id_}/attachments/{name}",
        headers=headers,
    )

delete_series_id_labels_label(id_, label)

Remove label

Remove a label associated with a series Tags: Series

Parameters:

Name Type Description Default
label str

The label to be removed

required
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
def delete_series_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Remove label

    Remove a label associated with a series
    Tags: Series

    Parameters
    ----------
    label
        The label to be removed
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/series/{id_}/labels/{label}",
    )

delete_series_id_metadata_name(id_, name, headers=None)

Delete metadata

Delete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024). Tags: Series

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
def delete_series_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete metadata

    Delete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
    Tags: Series

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/series/{id_}/metadata/{name}",
        headers=headers,
    )

delete_studies_id(id_)

Delete some study

Delete the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
def delete_studies_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete some study

    Delete the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/studies/{id_}",
    )

delete_studies_id_attachments_name(id_, name, headers=None)

Delete attachment

Delete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024). Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
def delete_studies_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete attachment

    Delete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/studies/{id_}/attachments/{name}",
        headers=headers,
    )

delete_studies_id_labels_label(id_, label)

Remove label

Remove a label associated with a study Tags: Studies

Parameters:

Name Type Description Default
label str

The label to be removed

required
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
def delete_studies_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Remove label

    Remove a label associated with a study
    Tags: Studies

    Parameters
    ----------
    label
        The label to be removed
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/studies/{id_}/labels/{label}",
    )

delete_studies_id_metadata_name(id_, name, headers=None)

Delete metadata

Delete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024). Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if CheckRevisions option is true.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
def delete_studies_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete metadata

    Delete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
    Tags: Studies

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option is `true`.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._delete(
        route=f"{self.url}/studies/{id_}/metadata/{name}",
        headers=headers,
    )

get_changes(params=None)

List changes

Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called Changes Log. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality. Tags: Tracking changes

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "limit" (float): Limit the number of results "since" (float): Show only the resources since the provided index

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The list of changes

Source code in pyorthanc/client.py
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
def get_changes(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List changes

    Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called _Changes Log_. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality.
    Tags: Tracking changes

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "limit" (float): Limit the number of results
            "since" (float): Show only the resources since the provided index

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The list of changes
    """
    return self._get(
        route=f"{self.url}/changes",
        params=params,
    )

get_exports(params=None)

List exports

For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting the option LogExportedResources to false in the configuration file, or periodically clear this log by DELETE-ing this URI. This route might be removed in future versions of Orthanc. Tags: Tracking changes

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "limit" (float): Limit the number of results "since" (float): Show only the resources since the provided index

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The list of exports

Source code in pyorthanc/client.py
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
def get_exports(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List exports

    For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting the option `LogExportedResources` to `false` in the configuration file, or periodically clear this log by `DELETE`-ing this URI. This route might be removed in future versions of Orthanc.
    Tags: Tracking changes

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "limit" (float): Limit the number of results
            "since" (float): Show only the resources since the provided index

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The list of exports
    """
    return self._get(
        route=f"{self.url}/exports",
        params=params,
    )

get_instances(params=None)

List the available instances

List the Orthanc identifiers of all the available DICOM instances Tags: Instances

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual instances "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "limit" (float): Limit the number of results "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format "since" (float): Show only the resources since the provided index

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if expand argument is provided)

Source code in pyorthanc/client.py
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
def get_instances(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List the available instances

    List the Orthanc identifiers of all the available DICOM instances
    Tags: Instances

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual instances
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "limit" (float): Limit the number of results
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "since" (float): Show only the resources since the provided index

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/instances",
        params=params,
    )

get_instances_id(id_, params=None)

Get information about some instance

Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM instance

Source code in pyorthanc/client.py
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
def get_instances_id(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get information about some instance

    Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM instance
    """
    return self._get(
        route=f"{self.url}/instances/{id_}",
        params=params,
    )

get_instances_id_attachments(id_, params=None)

List attachments

Get the list of attachments that are associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (str): If present, retrieve the attachments list and their numerical ids

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the attachments

Source code in pyorthanc/client.py
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
def get_instances_id_attachments(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List attachments

    Get the list of attachments that are associated with the given instance
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "full" (str): If present, retrieve the attachments list and their numerical ids

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the attachments
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments",
        params=params,
    )

get_instances_id_attachments_name(id_, name, headers=None)

List operations on attachments

Get the list of the operations that are available for attachments associated with the given instance Tags: Other

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
def get_instances_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on attachments

    Get the list of the operations that are available for attachments associated with the given instance
    Tags: Other

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}",
        headers=headers,
    )

get_instances_id_attachments_name_compressed_data(id_, name, headers=None)

Get attachment (no decompression)

Get the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if StorageCompression is true. Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
def get_instances_id_attachments_name_compressed_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment (no decompression)

    Get the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if `StorageCompression` is `true`.
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/compressed-data",
        headers=headers,
    )

get_instances_id_attachments_name_compressed_md5(id_, name, headers=None)

Get MD5 of attachment on disk

Get the MD5 hash of one attachment associated with the given instance, as stored on the disk. This is different from .../md5 iff EnableStorage is true. Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment, as stored on the disk

Source code in pyorthanc/client.py
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
def get_instances_id_attachments_name_compressed_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment on disk

    Get the MD5 hash of one attachment associated with the given instance, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/compressed-md5",
        headers=headers,
    )

get_instances_id_attachments_name_compressed_size(id_, name, headers=None)

Get size of attachment on disk

Get the size of one attachment associated with the given instance, as stored on the disk. This is different from .../size iff EnableStorage is true. Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment, as stored on the disk

Source code in pyorthanc/client.py
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
def get_instances_id_attachments_name_compressed_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment on disk

    Get the size of one attachment associated with the given instance, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/compressed-size",
        headers=headers,
    )

get_instances_id_attachments_name_data(id_, name, headers=None)

Get attachment

Get the (binary) content of one attachment associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
def get_instances_id_attachments_name_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment

    Get the (binary) content of one attachment associated with the given instance
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/data",
        headers=headers,
    )

get_instances_id_attachments_name_info(id_, name, headers=None)

Get info about the attachment

Get all the information about the attachment associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the information about the attachment

Source code in pyorthanc/client.py
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
def get_instances_id_attachments_name_info(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get info about the attachment

    Get all the information about the attachment associated with the given instance
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the information about the attachment
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/info",
        headers=headers,
    )

get_instances_id_attachments_name_is_compressed(id_, name, headers=None)

Is attachment compressed?

Test whether the attachment has been stored as a compressed file on the disk. Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

0 if the attachment was stored uncompressed, 1 if it was compressed

Source code in pyorthanc/client.py
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
def get_instances_id_attachments_name_is_compressed(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Is attachment compressed?

    Test whether the attachment has been stored as a compressed file on the disk.
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `0` if the attachment was stored uncompressed, `1` if it was compressed
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/is-compressed",
        headers=headers,
    )

get_instances_id_attachments_name_md5(id_, name, headers=None)

Get MD5 of attachment

Get the MD5 hash of one attachment associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment

Source code in pyorthanc/client.py
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
def get_instances_id_attachments_name_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment

    Get the MD5 hash of one attachment associated with the given instance
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/md5",
        headers=headers,
    )

get_instances_id_attachments_name_size(id_, name, headers=None)

Get size of attachment

Get the size of one attachment associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment

Source code in pyorthanc/client.py
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
def get_instances_id_attachments_name_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment

    Get the size of one attachment associated with the given instance
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/attachments/{name}/size",
        headers=headers,
    )

get_instances_id_content_path(id_, path)

Get raw tag

Get the raw content of one DICOM tag in the hierarchy of DICOM dataset Tags: Instances

Parameters:

Name Type Description Default
path str

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

required
id_ str

Orthanc identifier of the DICOM instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The raw value of the tag of intereset (binary data, whose memory layout depends on the underlying transfer syntax), or JSON array containing the list of available tags if accessing a dataset

Source code in pyorthanc/client.py
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
def get_instances_id_content_path(
    self,
    id_: str,
    path: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get raw tag

    Get the raw content of one DICOM tag in the hierarchy of DICOM dataset
    Tags: Instances

    Parameters
    ----------
    path
        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`
    id_
        Orthanc identifier of the DICOM instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The raw value of the tag of intereset (binary data, whose memory layout depends on the underlying transfer syntax), or JSON array containing the list of available tags if accessing a dataset
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/content/{path}",
    )

get_instances_id_file(id_, params=None, headers=None)

Download DICOM

Download one DICOM instance Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "transcode" (str): If present, the DICOM file will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): This HTTP header can be set to retrieve the DICOM instance in DICOMweb format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The DICOM instance The DICOM instance, in DICOMweb JSON format The DICOM instance, in DICOMweb XML format

Source code in pyorthanc/client.py
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
def get_instances_id_file(
    self,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Download DICOM

    Download one DICOM instance
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "transcode" (str): If present, the DICOM file will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
    headers
        Dictionary of optional headers:
            "Accept" (str): This HTTP header can be set to retrieve the DICOM instance in DICOMweb format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The DICOM instance
        The DICOM instance, in DICOMweb JSON format
        The DICOM instance, in DICOMweb XML format
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/file",
        params=params,
        headers=headers,
    )

get_instances_id_frames(id_)

List available frames

List the frames that are available in the DICOM instance of interest Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The list of the indices of the available frames

Source code in pyorthanc/client.py
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
def get_instances_id_frames(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List available frames

    List the frames that are available in the DICOM instance of interest
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The list of the indices of the available frames
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames",
    )

get_instances_id_frames_frame(frame, id_)

List operations

List the available operations under URI /instances/{id}/frames/{frame}/ Tags: Other

Parameters:

Name Type Description Default
frame str
required
id_ str
required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
def get_instances_id_frames_frame(
    self,
    frame: str,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations

    List the available operations under URI `/instances/{id}/frames/{frame}/`
    Tags: Other

    Parameters
    ----------
    frame

    id_


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}",
    )

get_instances_id_frames_frame_image_int16(frame, id_, params=None, headers=None)

Decode a frame (int16)

Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement. Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
def get_instances_id_frames_frame_image_int16(
    self,
    frame: float,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode a frame (int16)

    Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/image-int16",
        params=params,
        headers=headers,
    )

get_instances_id_frames_frame_image_uint16(frame, id_, params=None, headers=None)

Decode a frame (uint16)

Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range. Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
def get_instances_id_frames_frame_image_uint16(
    self,
    frame: float,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode a frame (uint16)

    Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/image-uint16",
        params=params,
        headers=headers,
    )

get_instances_id_frames_frame_image_uint8(frame, id_, params=None, headers=None)

Decode a frame (uint8)

Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range. Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
def get_instances_id_frames_frame_image_uint8(
    self,
    frame: float,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode a frame (uint8)

    Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/image-uint8",
        params=params,
        headers=headers,
    )

get_instances_id_frames_frame_matlab(frame, id_)

Decode frame for Matlab

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 Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Octave/Matlab matrix

Source code in pyorthanc/client.py
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
def get_instances_id_frames_frame_matlab(
    self,
    frame: float,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode frame for Matlab

    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
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Octave/Matlab matrix
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/matlab",
    )

get_instances_id_frames_frame_numpy(frame, id_, params=None)

Decode frame for numpy

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). Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM resource of interest

required
params QueryParamTypes

Dictionary of optional parameters: "compress" (bool): Compress the file as .npz "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html

Source code in pyorthanc/client.py
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
def get_instances_id_frames_frame_numpy(
    self,
    frame: float,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode frame for numpy

    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).
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM resource of interest
    params
        Dictionary of optional parameters:
            "compress" (bool): Compress the file as `.npz`
            "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/numpy",
        params=params,
    )

get_instances_id_frames_frame_preview(frame, id_, params=None, headers=None)

Decode a frame (preview)

Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range. Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
def get_instances_id_frames_frame_preview(
    self,
    frame: float,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode a frame (preview)

    Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/preview",
        params=params,
        headers=headers,
    )

get_instances_id_frames_frame_raw(frame, id_)

Access raw frame

Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The raw frame

Source code in pyorthanc/client.py
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
def get_instances_id_frames_frame_raw(
    self,
    frame: float,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Access raw frame

    Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes.
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The raw frame
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/raw",
    )

get_instances_id_frames_frame_raw_gz(frame, id_)

Access raw frame (compressed)

Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. The image is compressed using gzip Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The raw frame, compressed using gzip

Source code in pyorthanc/client.py
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
def get_instances_id_frames_frame_raw_gz(
    self,
    frame: float,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Access raw frame (compressed)

    Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. The image is compressed using gzip
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The raw frame, compressed using gzip
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/raw.gz",
    )

get_instances_id_frames_frame_rendered(frame, id_, params=None, headers=None)

Render a frame

Render one frame of interest from the given DICOM instance. This function takes scaling into account (RescaleSlope and RescaleIntercept tags), as well as the default windowing stored in the DICOM file (WindowCenter and WindowWidthtags), and can be used to resize the resulting image. Color images are not affected by windowing. Tags: Instances

Parameters:

Name Type Description Default
frame float

Index of the frame (starts at 0)

required
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "height" (float): Height of the resized image "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) "smooth" (bool): Whether to smooth image on resize "width" (float): Width of the resized image "window-center" (float): Windowing center "window-width" (float): Windowing width

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
def get_instances_id_frames_frame_rendered(
    self,
    frame: float,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Render a frame

    Render one frame of interest from the given DICOM instance. This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), and can be used to resize the resulting image. Color images are not affected by windowing.
    Tags: Instances

    Parameters
    ----------
    frame
        Index of the frame (starts at `0`)
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "height" (float): Height of the resized image
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
            "smooth" (bool): Whether to smooth image on resize
            "width" (float): Width of the resized image
            "window-center" (float): Windowing center
            "window-width" (float): Windowing width
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/frames/{frame}/rendered",
        params=params,
        headers=headers,
    )

get_instances_id_header(id_, params=None)

Get DICOM meta-header

Get the DICOM tags in the meta-header of the DICOM instance. By default, the full format is used, which combines hexadecimal tags with human-readable description. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the DICOM tags and their associated value

Source code in pyorthanc/client.py
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
def get_instances_id_header(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get DICOM meta-header

    Get the DICOM tags in the meta-header of the DICOM instance. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the DICOM tags and their associated value
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/header",
        params=params,
    )

get_instances_id_image_int16(id_, params=None, headers=None)

Decode an image (int16)

Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
def get_instances_id_image_int16(
    self,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode an image (int16)

    Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/image-int16",
        params=params,
        headers=headers,
    )

get_instances_id_image_uint16(id_, params=None, headers=None)

Decode an image (uint16)

Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
def get_instances_id_image_uint16(
    self,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode an image (uint16)

    Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/image-uint16",
        params=params,
        headers=headers,
    )

get_instances_id_image_uint8(id_, params=None, headers=None)

Decode an image (uint8)

Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
def get_instances_id_image_uint8(
    self,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode an image (uint8)

    Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/image-uint8",
        params=params,
        headers=headers,
    )

get_instances_id_labels(id_)

List labels

Get the labels that are associated with the given instance (new in Orthanc 1.12.0) Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the labels

Source code in pyorthanc/client.py
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
def get_instances_id_labels(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List labels

    Get the labels that are associated with the given instance (new in Orthanc 1.12.0)
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the labels
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/labels",
    )

get_instances_id_labels_label(id_, label)

Test label

Test whether the instance is associated with the given label Tags: Instances

Parameters:

Name Type Description Default
label str

The label of interest

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty string is returned in the case of presence, error 404 in the case of absence

Source code in pyorthanc/client.py
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
def get_instances_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Test label

    Test whether the instance is associated with the given label
    Tags: Instances

    Parameters
    ----------
    label
        The label of interest
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty string is returned in the case of presence, error 404 in the case of absence
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/labels/{label}",
    )

get_instances_id_matlab(id_)

Decode frame for Matlab

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 Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Octave/Matlab matrix

Source code in pyorthanc/client.py
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
def get_instances_id_matlab(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode frame for Matlab

    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
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Octave/Matlab matrix
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/matlab",
    )

get_instances_id_metadata(id_, params=None)

List metadata

Get the list of metadata that are associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, also retrieve the value of the individual metadata "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if expand argument is provided)

Source code in pyorthanc/client.py
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
def get_instances_id_metadata(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List metadata

    Get the list of metadata that are associated with the given instance
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If present, also retrieve the value of the individual metadata
            "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/metadata",
        params=params,
    )

get_instances_id_metadata_name(id_, name, headers=None)

Get metadata

Get the value of a metadata that is associated with the given instance Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Value of the metadata

Source code in pyorthanc/client.py
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
def get_instances_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get metadata

    Get the value of a metadata that is associated with the given instance
    Tags: Instances

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the instance of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Value of the metadata
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/metadata/{name}",
        headers=headers,
    )

get_instances_id_module(id_, params=None)

Get instance module

Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM instance

Source code in pyorthanc/client.py
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
def get_instances_id_module(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get instance module

    Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM instance
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/module",
        params=params,
    )

get_instances_id_numpy(id_, params=None)

Decode instance for numpy

Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel). Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM resource of interest

required
params QueryParamTypes

Dictionary of optional parameters: "compress" (bool): Compress the file as .npz "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html

Source code in pyorthanc/client.py
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
def get_instances_id_numpy(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode instance for numpy

    Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM resource of interest
    params
        Dictionary of optional parameters:
            "compress" (bool): Compress the file as `.npz`
            "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/numpy",
        params=params,
    )

get_instances_id_patient(id_, params=None)

Get parent patient

Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the parent DICOM patient

Source code in pyorthanc/client.py
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
def get_instances_id_patient(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get parent patient

    Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the parent DICOM patient
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/patient",
        params=params,
    )

get_instances_id_pdf(id_)

Get embedded PDF

Get the PDF file that is embedded in one DICOM instance. If the DICOM instance doesn't contain the EncapsulatedDocument tag or if the MIMETypeOfEncapsulatedDocument tag doesn't correspond to the PDF type, a 404 HTTP error is raised. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

PDF file

Source code in pyorthanc/client.py
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
def get_instances_id_pdf(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get embedded PDF

    Get the PDF file that is embedded in one DICOM instance. If the DICOM instance doesn't contain the `EncapsulatedDocument` tag or if the `MIMETypeOfEncapsulatedDocument` tag doesn't correspond to the PDF type, a `404` HTTP error is raised.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        PDF file
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/pdf",
    )

get_instances_id_preview(id_, params=None, headers=None)

Decode an image (preview)

Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
def get_instances_id_preview(
    self,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode an image (preview)

    Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/preview",
        params=params,
        headers=headers,
    )

get_instances_id_rendered(id_, params=None, headers=None)

Render an image

Render the first frame of the given DICOM instance. This function takes scaling into account (RescaleSlope and RescaleIntercept tags), as well as the default windowing stored in the DICOM file (WindowCenter and WindowWidthtags), and can be used to resize the resulting image. Color images are not affected by windowing. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "height" (float): Height of the resized image "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90) "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) "smooth" (bool): Whether to smooth image on resize "width" (float): Width of the resized image "window-center" (float): Windowing center "window-width" (float): Windowing width

None
headers HeaderTypes

Dictionary of optional headers: "Accept" (str): Format of the resulting image. Can be image/png (default), image/jpeg or image/x-portable-arbitrarymap

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JPEG image PNG image PAM image (Portable Arbitrary Map)

Source code in pyorthanc/client.py
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
def get_instances_id_rendered(
    self,
    id_: str,
    params: QueryParamTypes = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Render an image

    Render the first frame of the given DICOM instance. This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), and can be used to resize the resulting image. Color images are not affected by windowing.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "height" (float): Height of the resized image
            "quality" (float): Quality for JPEG images (between 1 and 100, defaults to 90)
            "returnUnsupportedImage" (bool): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)
            "smooth" (bool): Whether to smooth image on resize
            "width" (float): Width of the resized image
            "window-center" (float): Windowing center
            "window-width" (float): Windowing width
    headers
        Dictionary of optional headers:
            "Accept" (str): Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JPEG image
        PNG image
        PAM image (Portable Arbitrary Map)
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/rendered",
        params=params,
        headers=headers,
    )

get_instances_id_series(id_, params=None)

Get parent series

Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the parent DICOM series

Source code in pyorthanc/client.py
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
def get_instances_id_series(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get parent series

    Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the parent DICOM series
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/series",
        params=params,
    )

get_instances_id_simplified_tags(id_, params=None)

Get human-readable tags

Get the DICOM tags in human-readable format (same as the /instances/{id}/tags?simplify route) Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "whole" (bool): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the DICOM tags and their associated value

Source code in pyorthanc/client.py
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
def get_instances_id_simplified_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get human-readable tags

    Get the DICOM tags in human-readable format (same as the `/instances/{id}/tags?simplify` route)
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "whole" (bool): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the DICOM tags and their associated value
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/simplified-tags",
        params=params,
    )

get_instances_id_statistics(id_)

Get instance statistics

Get statistics about the given instance Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
def get_instances_id_statistics(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get instance statistics

    Get statistics about the given instance
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/instances/{id_}/statistics",
    )

get_instances_id_study(id_, params=None)

Get parent study

Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the parent DICOM study

Source code in pyorthanc/client.py
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
def get_instances_id_study(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get parent study

    Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the parent DICOM study
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/study",
        params=params,
    )

get_instances_id_tags(id_, params=None)

Get DICOM tags

Get the DICOM tags in the specified format. By default, the full format is used, which combines hexadecimal tags with human-readable description. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) "whole" (bool): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the DICOM tags and their associated value

Source code in pyorthanc/client.py
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
def get_instances_id_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get DICOM tags

    Get the DICOM tags in the specified format. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
            "whole" (bool): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the DICOM tags and their associated value
    """
    return self._get(
        route=f"{self.url}/instances/{id_}/tags",
        params=params,
    )

get_jobs(params=None)

List jobs

List all the available jobs Tags: Jobs

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual jobs

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if expand argument is provided)

Source code in pyorthanc/client.py
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
def get_jobs(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List jobs

    List all the available jobs
    Tags: Jobs

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual jobs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/jobs",
        params=params,
    )

get_jobs_id(id_)

Get job

Retrieve detailed information about the job whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs Tags: Jobs

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object detailing the job

Source code in pyorthanc/client.py
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
def get_jobs_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get job

    Retrieve detailed information about the job whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
    Tags: Jobs

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object detailing the job
    """
    return self._get(
        route=f"{self.url}/jobs/{id_}",
    )

get_jobs_id_key(id_, key)

Get job output

Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with key equals to archive). Tags: Jobs

Parameters:

Name Type Description Default
key str

Name of the output of interest

required
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Content of the output of the job

Source code in pyorthanc/client.py
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
def get_jobs_id_key(
    self,
    id_: str,
    key: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get job output

    Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).
    Tags: Jobs

    Parameters
    ----------
    key
        Name of the output of interest
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Content of the output of the job
    """
    return self._get(
        route=f"{self.url}/jobs/{id_}/{key}",
    )

get_modalities(params=None)

List DICOM modalities

List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the DicomModalities configuration option, or to the information stored in the database if DicomModalitiesInDatabase is true. Tags: Networking

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual DICOM modalities

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the identifiers of the modalities, or detailed information about the modalities (if expand argument is provided)

Source code in pyorthanc/client.py
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
def get_modalities(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List DICOM modalities

    List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the `DicomModalities` configuration option, or to the information stored in the database if `DicomModalitiesInDatabase` is `true`.
    Tags: Networking

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual DICOM modalities

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the identifiers of the modalities, or detailed information about the modalities (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/modalities",
        params=params,
    )

get_modalities_id(id_)

List operations on modality

List the operations that are available for a DICOM modality. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the DICOM modality of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
def get_modalities_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on modality

    List the operations that are available for a DICOM modality.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the DICOM modality of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/modalities/{id_}",
    )

get_modalities_id_configuration(id_)

Get modality configuration

Get detailed information about the configuration of some DICOM modality Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Configuration of the modality

Source code in pyorthanc/client.py
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
def get_modalities_id_configuration(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get modality configuration

    Get detailed information about the configuration of some DICOM modality
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Configuration of the modality
    """
    return self._get(
        route=f"{self.url}/modalities/{id_}/configuration",
    )

get_patients(params=None)

List the available patients

List the Orthanc identifiers of all the available DICOM patients Tags: Patients

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual patients "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "limit" (float): Limit the number of results "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format "since" (float): Show only the resources since the provided index

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the Orthanc identifiers, or detailed information about the reported patients (if expand argument is provided)

Source code in pyorthanc/client.py
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
def get_patients(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List the available patients

    List the Orthanc identifiers of all the available DICOM patients
    Tags: Patients

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual patients
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "limit" (float): Limit the number of results
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "since" (float): Show only the resources since the provided index

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the Orthanc identifiers, or detailed information about the reported patients (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/patients",
        params=params,
    )

get_patients_id(id_, params=None)

Get information about some patient

Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM patient

Source code in pyorthanc/client.py
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
def get_patients_id(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get information about some patient

    Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM patient
    """
    return self._get(
        route=f"{self.url}/patients/{id_}",
        params=params,
    )

get_patients_id_archive(id_, params=None)

Create ZIP archive

Synchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method. Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension) "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

ZIP file containing the archive

Source code in pyorthanc/client.py
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
def get_patients_id_archive(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Synchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
            "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        ZIP file containing the archive
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/archive",
        params=params,
    )

get_patients_id_attachments(id_, params=None)

List attachments

Get the list of attachments that are associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (str): If present, retrieve the attachments list and their numerical ids

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the attachments

Source code in pyorthanc/client.py
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
def get_patients_id_attachments(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List attachments

    Get the list of attachments that are associated with the given patient
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "full" (str): If present, retrieve the attachments list and their numerical ids

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the attachments
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments",
        params=params,
    )

get_patients_id_attachments_name(id_, name, headers=None)

List operations on attachments

Get the list of the operations that are available for attachments associated with the given patient Tags: Other

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
def get_patients_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on attachments

    Get the list of the operations that are available for attachments associated with the given patient
    Tags: Other

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}",
        headers=headers,
    )

get_patients_id_attachments_name_compressed_data(id_, name, headers=None)

Get attachment (no decompression)

Get the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if StorageCompression is true. Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
def get_patients_id_attachments_name_compressed_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment (no decompression)

    Get the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if `StorageCompression` is `true`.
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/compressed-data",
        headers=headers,
    )

get_patients_id_attachments_name_compressed_md5(id_, name, headers=None)

Get MD5 of attachment on disk

Get the MD5 hash of one attachment associated with the given patient, as stored on the disk. This is different from .../md5 iff EnableStorage is true. Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment, as stored on the disk

Source code in pyorthanc/client.py
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
def get_patients_id_attachments_name_compressed_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment on disk

    Get the MD5 hash of one attachment associated with the given patient, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/compressed-md5",
        headers=headers,
    )

get_patients_id_attachments_name_compressed_size(id_, name, headers=None)

Get size of attachment on disk

Get the size of one attachment associated with the given patient, as stored on the disk. This is different from .../size iff EnableStorage is true. Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment, as stored on the disk

Source code in pyorthanc/client.py
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
def get_patients_id_attachments_name_compressed_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment on disk

    Get the size of one attachment associated with the given patient, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/compressed-size",
        headers=headers,
    )

get_patients_id_attachments_name_data(id_, name, headers=None)

Get attachment

Get the (binary) content of one attachment associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
def get_patients_id_attachments_name_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment

    Get the (binary) content of one attachment associated with the given patient
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/data",
        headers=headers,
    )

get_patients_id_attachments_name_info(id_, name, headers=None)

Get info about the attachment

Get all the information about the attachment associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the information about the attachment

Source code in pyorthanc/client.py
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
def get_patients_id_attachments_name_info(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get info about the attachment

    Get all the information about the attachment associated with the given patient
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the information about the attachment
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/info",
        headers=headers,
    )

get_patients_id_attachments_name_is_compressed(id_, name, headers=None)

Is attachment compressed?

Test whether the attachment has been stored as a compressed file on the disk. Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

0 if the attachment was stored uncompressed, 1 if it was compressed

Source code in pyorthanc/client.py
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
def get_patients_id_attachments_name_is_compressed(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Is attachment compressed?

    Test whether the attachment has been stored as a compressed file on the disk.
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `0` if the attachment was stored uncompressed, `1` if it was compressed
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/is-compressed",
        headers=headers,
    )

get_patients_id_attachments_name_md5(id_, name, headers=None)

Get MD5 of attachment

Get the MD5 hash of one attachment associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment

Source code in pyorthanc/client.py
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
def get_patients_id_attachments_name_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment

    Get the MD5 hash of one attachment associated with the given patient
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/md5",
        headers=headers,
    )

get_patients_id_attachments_name_size(id_, name, headers=None)

Get size of attachment

Get the size of one attachment associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment

Source code in pyorthanc/client.py
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
def get_patients_id_attachments_name_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment

    Get the size of one attachment associated with the given patient
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/attachments/{name}/size",
        headers=headers,
    )

get_patients_id_instances(id_, params=None)

Get child instances

Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If false or missing, only retrieve the list of child instances "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing information about the child DICOM instances

Source code in pyorthanc/client.py
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
def get_patients_id_instances(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get child instances

    Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If false or missing, only retrieve the list of child instances
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing information about the child DICOM instances
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/instances",
        params=params,
    )

get_patients_id_instances_tags(id_, params=None)

Get tags of instances

Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags

Source code in pyorthanc/client.py
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
def get_patients_id_instances_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get tags of instances

    Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/instances-tags",
        params=params,
    )

get_patients_id_labels(id_)

List labels

Get the labels that are associated with the given patient (new in Orthanc 1.12.0) Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the labels

Source code in pyorthanc/client.py
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
def get_patients_id_labels(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List labels

    Get the labels that are associated with the given patient (new in Orthanc 1.12.0)
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the labels
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/labels",
    )

get_patients_id_labels_label(id_, label)

Test label

Test whether the patient is associated with the given label Tags: Patients

Parameters:

Name Type Description Default
label str

The label of interest

required
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty string is returned in the case of presence, error 404 in the case of absence

Source code in pyorthanc/client.py
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
def get_patients_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Test label

    Test whether the patient is associated with the given label
    Tags: Patients

    Parameters
    ----------
    label
        The label of interest
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty string is returned in the case of presence, error 404 in the case of absence
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/labels/{label}",
    )

get_patients_id_media(id_, params=None)

Create DICOMDIR media

Synchronously create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method. Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "extended" (str): If present, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension) "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

ZIP file containing the archive

Source code in pyorthanc/client.py
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
def get_patients_id_media(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Synchronously create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "extended" (str): If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*
            "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
            "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        ZIP file containing the archive
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/media",
        params=params,
    )

get_patients_id_metadata(id_, params=None)

List metadata

Get the list of metadata that are associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, also retrieve the value of the individual metadata "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if expand argument is provided)

Source code in pyorthanc/client.py
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
def get_patients_id_metadata(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List metadata

    Get the list of metadata that are associated with the given patient
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If present, also retrieve the value of the individual metadata
            "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/metadata",
        params=params,
    )

get_patients_id_metadata_name(id_, name, headers=None)

Get metadata

Get the value of a metadata that is associated with the given patient Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Value of the metadata

Source code in pyorthanc/client.py
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
def get_patients_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get metadata

    Get the value of a metadata that is associated with the given patient
    Tags: Patients

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the patient of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Value of the metadata
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/metadata/{name}",
        headers=headers,
    )

get_patients_id_module(id_, params=None)

Get patient module

Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM patient

Source code in pyorthanc/client.py
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
def get_patients_id_module(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get patient module

    Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM patient
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/module",
        params=params,
    )

get_patients_id_protected(id_)

Is the patient protected against recycling?

Is the patient protected against recycling? Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

1 if protected, 0 if not protected

Source code in pyorthanc/client.py
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
def get_patients_id_protected(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Is the patient protected against recycling?

    Is the patient protected against recycling?
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `1` if protected, `0` if not protected
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/protected",
    )

get_patients_id_series(id_, params=None)

Get child series

Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If false or missing, only retrieve the list of child series "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing information about the child DICOM series

Source code in pyorthanc/client.py
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
def get_patients_id_series(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get child series

    Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If false or missing, only retrieve the list of child series
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing information about the child DICOM series
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/series",
        params=params,
    )

get_patients_id_shared_tags(id_, params=None)

Get shared tags

Extract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the values of the DICOM tags

Source code in pyorthanc/client.py
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
def get_patients_id_shared_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get shared tags

    Extract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the values of the DICOM tags
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/shared-tags",
        params=params,
    )

get_patients_id_statistics(id_)

Get patient statistics

Get statistics about the given patient Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
def get_patients_id_statistics(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get patient statistics

    Get statistics about the given patient
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/patients/{id_}/statistics",
    )

get_patients_id_studies(id_, params=None)

Get child studies

Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If false or missing, only retrieve the list of child studies "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing information about the child DICOM studies

Source code in pyorthanc/client.py
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
def get_patients_id_studies(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get child studies

    Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If false or missing, only retrieve the list of child studies
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing information about the child DICOM studies
    """
    return self._get(
        route=f"{self.url}/patients/{id_}/studies",
        params=params,
    )

get_peers(params=None)

List Orthanc peers

List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the OrthancPeers configuration option, or to the information stored in the database if OrthancPeersInDatabase is true. Tags: Networking

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual Orthanc peers

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the identifiers of the peers, or detailed information about the peers (if expand argument is provided)

Source code in pyorthanc/client.py
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
def get_peers(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List Orthanc peers

    List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the `OrthancPeers` configuration option, or to the information stored in the database if `OrthancPeersInDatabase` is `true`.
    Tags: Networking

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual Orthanc peers

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the identifiers of the peers, or detailed information about the peers (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/peers",
        params=params,
    )

get_peers_id(id_)

List operations on peer

List the operations that are available for an Orthanc peer. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the peer of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
def get_peers_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on peer

    List the operations that are available for an Orthanc peer.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the peer of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/peers/{id_}",
    )

get_peers_id_configuration(id_)

Get peer configuration

Get detailed information about the configuration of some Orthanc peer Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the peer of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Configuration of the peer

Source code in pyorthanc/client.py
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
def get_peers_id_configuration(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get peer configuration

    Get detailed information about the configuration of some Orthanc peer
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the peer of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Configuration of the peer
    """
    return self._get(
        route=f"{self.url}/peers/{id_}/configuration",
    )

get_peers_id_system(id_)

Get peer system information

Get system information about some Orthanc peer. This corresponds to doing a GET request against the /system URI of the remote peer. This route can be used to test connectivity. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the peer of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

System information about the peer

Source code in pyorthanc/client.py
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
def get_peers_id_system(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get peer system information

    Get system information about some Orthanc peer. This corresponds to doing a `GET` request against the `/system` URI of the remote peer. This route can be used to test connectivity.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the peer of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        System information about the peer
    """
    return self._get(
        route=f"{self.url}/peers/{id_}/system",
    )

get_plugins()

List plugins

List all the installed plugins Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the identifiers of the installed plugins

Source code in pyorthanc/client.py
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
def get_plugins(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List plugins

    List all the installed plugins
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the identifiers of the installed plugins
    """
    return self._get(
        route=f"{self.url}/plugins",
    )

get_plugins_explorer_js()

JavaScript extensions to Orthanc Explorer

Get the JavaScript extensions that are installed by all the plugins using the OrthancPluginExtendOrthancExplorer() function of the plugin SDK. This route is for internal use of Orthanc Explorer. Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The JavaScript extensions

Source code in pyorthanc/client.py
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
def get_plugins_explorer_js(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """JavaScript extensions to Orthanc Explorer

    Get the JavaScript extensions that are installed by all the plugins using the `OrthancPluginExtendOrthancExplorer()` function of the plugin SDK. This route is for internal use of Orthanc Explorer.
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The JavaScript extensions
    """
    return self._get(
        route=f"{self.url}/plugins/explorer.js",
    )

get_plugins_id(id_)

Get plugin

Get system information about the plugin whose identifier is provided in the URL Tags: System

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing information about the plugin

Source code in pyorthanc/client.py
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
def get_plugins_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get plugin

    Get system information about the plugin whose identifier is provided in the URL
    Tags: System

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing information about the plugin
    """
    return self._get(
        route=f"{self.url}/plugins/{id_}",
    )

get_queries()

List query/retrieve operations

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 Tags: Networking

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the identifiers

Source code in pyorthanc/client.py
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
def get_queries(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List query/retrieve operations

    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
    Tags: Networking

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the identifiers
    """
    return self._get(
        route=f"{self.url}/queries",
    )

get_queries_id(id_)

List operations on a query

List the available operations for the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the list of operations

Source code in pyorthanc/client.py
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
def get_queries_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on a query

    List the available operations for the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the list of operations
    """
    return self._get(
        route=f"{self.url}/queries/{id_}",
    )

get_queries_id_answers(id_, params=None)

List answers to a query

List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual answers "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the indices of the answers, or detailed information about the reported answers (if expand argument is provided)

Source code in pyorthanc/client.py
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
def get_queries_id_answers(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List answers to a query

    List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual answers
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the indices of the answers, or detailed information about the reported answers (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/queries/{id_}/answers",
        params=params,
    )

get_queries_id_answers_index(id_, index)

List operations on an answer

List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
index str

Index of the answer

required
id_ str

Identifier of the query of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the list of operations

Source code in pyorthanc/client.py
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
def get_queries_id_answers_index(
    self,
    id_: str,
    index: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on an answer

    List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    index
        Index of the answer
    id_
        Identifier of the query of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the list of operations
    """
    return self._get(
        route=f"{self.url}/queries/{id_}/answers/{index}",
    )

get_queries_id_answers_index_content(id_, index, params=None)

Get one answer

Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
index str

Index of the answer

required
id_ str

Identifier of the query of interest

required
params QueryParamTypes

Dictionary of optional parameters: "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the DICOM tags of the answer

Source code in pyorthanc/client.py
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
def get_queries_id_answers_index_content(
    self,
    id_: str,
    index: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get one answer

    Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    index
        Index of the answer
    id_
        Identifier of the query of interest
    params
        Dictionary of optional parameters:
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the DICOM tags of the answer
    """
    return self._get(
        route=f"{self.url}/queries/{id_}/answers/{index}/content",
        params=params,
    )

get_queries_id_level(id_)

Get level of original query

Get the query level (value of the QueryRetrieveLevel tag) of the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The level

Source code in pyorthanc/client.py
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
def get_queries_id_level(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get level of original query

    Get the query level (value of the `QueryRetrieveLevel` tag) of the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The level
    """
    return self._get(
        route=f"{self.url}/queries/{id_}/level",
    )

get_queries_id_modality(id_)

Get modality of original query

Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The identifier of the DICOM modality

Source code in pyorthanc/client.py
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
def get_queries_id_modality(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get modality of original query

    Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The identifier of the DICOM modality
    """
    return self._get(
        route=f"{self.url}/queries/{id_}/modality",
    )

get_queries_id_query(id_, params=None)

Get original query arguments

Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required
params QueryParamTypes

Dictionary of optional parameters: "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Content of the original query

Source code in pyorthanc/client.py
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
def get_queries_id_query(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get original query arguments

    Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest
    params
        Dictionary of optional parameters:
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Content of the original query
    """
    return self._get(
        route=f"{self.url}/queries/{id_}/query",
        params=params,
    )

get_series(params=None)

List the available series

List the Orthanc identifiers of all the available DICOM series Tags: Series

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual series "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "limit" (float): Limit the number of results "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format "since" (float): Show only the resources since the provided index

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the Orthanc identifiers, or detailed information about the reported series (if expand argument is provided)

Source code in pyorthanc/client.py
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
def get_series(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List the available series

    List the Orthanc identifiers of all the available DICOM series
    Tags: Series

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual series
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "limit" (float): Limit the number of results
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "since" (float): Show only the resources since the provided index

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the Orthanc identifiers, or detailed information about the reported series (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/series",
        params=params,
    )

get_series_id(id_, params=None)

Get information about some series

Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM series

Source code in pyorthanc/client.py
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
def get_series_id(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get information about some series

    Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM series
    """
    return self._get(
        route=f"{self.url}/series/{id_}",
        params=params,
    )

get_series_id_archive(id_, params=None)

Create ZIP archive

Synchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method. Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension) "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

ZIP file containing the archive

Source code in pyorthanc/client.py
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
def get_series_id_archive(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Synchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
            "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        ZIP file containing the archive
    """
    return self._get(
        route=f"{self.url}/series/{id_}/archive",
        params=params,
    )

get_series_id_attachments(id_, params=None)

List attachments

Get the list of attachments that are associated with the given series Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (str): If present, retrieve the attachments list and their numerical ids

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the attachments

Source code in pyorthanc/client.py
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
def get_series_id_attachments(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List attachments

    Get the list of attachments that are associated with the given series
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "full" (str): If present, retrieve the attachments list and their numerical ids

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the attachments
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments",
        params=params,
    )

get_series_id_attachments_name(id_, name, headers=None)

List operations on attachments

Get the list of the operations that are available for attachments associated with the given series Tags: Other

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
def get_series_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on attachments

    Get the list of the operations that are available for attachments associated with the given series
    Tags: Other

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}",
        headers=headers,
    )

get_series_id_attachments_name_compressed_data(id_, name, headers=None)

Get attachment (no decompression)

Get the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if StorageCompression is true. Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
def get_series_id_attachments_name_compressed_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment (no decompression)

    Get the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if `StorageCompression` is `true`.
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/compressed-data",
        headers=headers,
    )

get_series_id_attachments_name_compressed_md5(id_, name, headers=None)

Get MD5 of attachment on disk

Get the MD5 hash of one attachment associated with the given series, as stored on the disk. This is different from .../md5 iff EnableStorage is true. Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment, as stored on the disk

Source code in pyorthanc/client.py
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
def get_series_id_attachments_name_compressed_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment on disk

    Get the MD5 hash of one attachment associated with the given series, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/compressed-md5",
        headers=headers,
    )

get_series_id_attachments_name_compressed_size(id_, name, headers=None)

Get size of attachment on disk

Get the size of one attachment associated with the given series, as stored on the disk. This is different from .../size iff EnableStorage is true. Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment, as stored on the disk

Source code in pyorthanc/client.py
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
def get_series_id_attachments_name_compressed_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment on disk

    Get the size of one attachment associated with the given series, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/compressed-size",
        headers=headers,
    )

get_series_id_attachments_name_data(id_, name, headers=None)

Get attachment

Get the (binary) content of one attachment associated with the given series Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
def get_series_id_attachments_name_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment

    Get the (binary) content of one attachment associated with the given series
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/data",
        headers=headers,
    )

get_series_id_attachments_name_info(id_, name, headers=None)

Get info about the attachment

Get all the information about the attachment associated with the given series Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the information about the attachment

Source code in pyorthanc/client.py
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
def get_series_id_attachments_name_info(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get info about the attachment

    Get all the information about the attachment associated with the given series
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the information about the attachment
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/info",
        headers=headers,
    )

get_series_id_attachments_name_is_compressed(id_, name, headers=None)

Is attachment compressed?

Test whether the attachment has been stored as a compressed file on the disk. Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

0 if the attachment was stored uncompressed, 1 if it was compressed

Source code in pyorthanc/client.py
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
def get_series_id_attachments_name_is_compressed(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Is attachment compressed?

    Test whether the attachment has been stored as a compressed file on the disk.
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `0` if the attachment was stored uncompressed, `1` if it was compressed
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/is-compressed",
        headers=headers,
    )

get_series_id_attachments_name_md5(id_, name, headers=None)

Get MD5 of attachment

Get the MD5 hash of one attachment associated with the given series Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment

Source code in pyorthanc/client.py
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
def get_series_id_attachments_name_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment

    Get the MD5 hash of one attachment associated with the given series
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/md5",
        headers=headers,
    )

get_series_id_attachments_name_size(id_, name, headers=None)

Get size of attachment

Get the size of one attachment associated with the given series Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment

Source code in pyorthanc/client.py
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
def get_series_id_attachments_name_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment

    Get the size of one attachment associated with the given series
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment
    """
    return self._get(
        route=f"{self.url}/series/{id_}/attachments/{name}/size",
        headers=headers,
    )

get_series_id_instances(id_, params=None)

Get child instances

Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If false or missing, only retrieve the list of child instances "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing information about the child DICOM instances

Source code in pyorthanc/client.py
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
def get_series_id_instances(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get child instances

    Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If false or missing, only retrieve the list of child instances
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing information about the child DICOM instances
    """
    return self._get(
        route=f"{self.url}/series/{id_}/instances",
        params=params,
    )

get_series_id_instances_tags(id_, params=None)

Get tags of instances

Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags

Source code in pyorthanc/client.py
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
def get_series_id_instances_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get tags of instances

    Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags
    """
    return self._get(
        route=f"{self.url}/series/{id_}/instances-tags",
        params=params,
    )

get_series_id_labels(id_)

List labels

Get the labels that are associated with the given series (new in Orthanc 1.12.0) Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the labels

Source code in pyorthanc/client.py
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
def get_series_id_labels(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List labels

    Get the labels that are associated with the given series (new in Orthanc 1.12.0)
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the labels
    """
    return self._get(
        route=f"{self.url}/series/{id_}/labels",
    )

get_series_id_labels_label(id_, label)

Test label

Test whether the series is associated with the given label Tags: Series

Parameters:

Name Type Description Default
label str

The label of interest

required
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty string is returned in the case of presence, error 404 in the case of absence

Source code in pyorthanc/client.py
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
def get_series_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Test label

    Test whether the series is associated with the given label
    Tags: Series

    Parameters
    ----------
    label
        The label of interest
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty string is returned in the case of presence, error 404 in the case of absence
    """
    return self._get(
        route=f"{self.url}/series/{id_}/labels/{label}",
    )

get_series_id_media(id_, params=None)

Create DICOMDIR media

Synchronously create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method. Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "extended" (str): If present, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension) "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

ZIP file containing the archive

Source code in pyorthanc/client.py
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
def get_series_id_media(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Synchronously create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "extended" (str): If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*
            "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
            "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        ZIP file containing the archive
    """
    return self._get(
        route=f"{self.url}/series/{id_}/media",
        params=params,
    )

get_series_id_metadata(id_, params=None)

List metadata

Get the list of metadata that are associated with the given series Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, also retrieve the value of the individual metadata "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if expand argument is provided)

Source code in pyorthanc/client.py
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
def get_series_id_metadata(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List metadata

    Get the list of metadata that are associated with the given series
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If present, also retrieve the value of the individual metadata
            "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/series/{id_}/metadata",
        params=params,
    )

get_series_id_metadata_name(id_, name, headers=None)

Get metadata

Get the value of a metadata that is associated with the given series Tags: Series

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Value of the metadata

Source code in pyorthanc/client.py
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
def get_series_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get metadata

    Get the value of a metadata that is associated with the given series
    Tags: Series

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the series of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Value of the metadata
    """
    return self._get(
        route=f"{self.url}/series/{id_}/metadata/{name}",
        headers=headers,
    )

get_series_id_module(id_, params=None)

Get series module

Get the series module of the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM series

Source code in pyorthanc/client.py
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
def get_series_id_module(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get series module

    Get the series module of the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM series
    """
    return self._get(
        route=f"{self.url}/series/{id_}/module",
        params=params,
    )

get_series_id_numpy(id_, params=None)

Decode series for numpy

Decode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel). Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM resource of interest

required
params QueryParamTypes

Dictionary of optional parameters: "compress" (bool): Compress the file as .npz "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html

Source code in pyorthanc/client.py
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
def get_series_id_numpy(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Decode series for numpy

    Decode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM resource of interest
    params
        Dictionary of optional parameters:
            "compress" (bool): Compress the file as `.npz`
            "rescale" (bool): On grayscale images, apply the rescaling and return floating-point values

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html
    """
    return self._get(
        route=f"{self.url}/series/{id_}/numpy",
        params=params,
    )

get_series_id_ordered_slices(id_)

Order the slices

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. Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
def get_series_id_ordered_slices(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Order the slices

    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.
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
    return self._get(
        route=f"{self.url}/series/{id_}/ordered-slices",
    )

get_series_id_patient(id_, params=None)

Get parent patient

Get detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the parent DICOM patient

Source code in pyorthanc/client.py
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
def get_series_id_patient(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get parent patient

    Get detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the parent DICOM patient
    """
    return self._get(
        route=f"{self.url}/series/{id_}/patient",
        params=params,
    )

get_series_id_shared_tags(id_, params=None)

Get shared tags

Extract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the values of the DICOM tags

Source code in pyorthanc/client.py
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
def get_series_id_shared_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get shared tags

    Extract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the values of the DICOM tags
    """
    return self._get(
        route=f"{self.url}/series/{id_}/shared-tags",
        params=params,
    )

get_series_id_statistics(id_)

Get series statistics

Get statistics about the given series Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
def get_series_id_statistics(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get series statistics

    Get statistics about the given series
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/series/{id_}/statistics",
    )

get_series_id_study(id_, params=None)

Get parent study

Get detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the parent DICOM study

Source code in pyorthanc/client.py
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
def get_series_id_study(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get parent study

    Get detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the parent DICOM study
    """
    return self._get(
        route=f"{self.url}/series/{id_}/study",
        params=params,
    )

get_statistics()

Get database statistics

Get statistics related to the database of Orthanc Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
def get_statistics(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get database statistics

    Get statistics related to the database of Orthanc
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/statistics",
    )

get_storage_commitment_id(id_)

Get storage commitment report

Get the storage commitment report whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the storage commitment report

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
def get_storage_commitment_id(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get storage commitment report

    Get the storage commitment report whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the storage commitment report

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/storage-commitment/{id_}",
    )

get_studies(params=None)

List the available studies

List the Orthanc identifiers of all the available DICOM studies Tags: Studies

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, retrieve detailed information about the individual studies "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "limit" (float): Limit the number of results "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format "since" (float): Show only the resources since the provided index

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the Orthanc identifiers, or detailed information about the reported studies (if expand argument is provided)

Source code in pyorthanc/client.py
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
def get_studies(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List the available studies

    List the Orthanc identifiers of all the available DICOM studies
    Tags: Studies

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "expand" (str): If present, retrieve detailed information about the individual studies
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "limit" (float): Limit the number of results
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "since" (float): Show only the resources since the provided index

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the Orthanc identifiers, or detailed information about the reported studies (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/studies",
        params=params,
    )

get_studies_id(id_, params=None)

Get information about some study

Get detailed information about the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM study

Source code in pyorthanc/client.py
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
def get_studies_id(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get information about some study

    Get detailed information about the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM study
    """
    return self._get(
        route=f"{self.url}/studies/{id_}",
        params=params,
    )

get_studies_id_archive(id_, params=None)

Create ZIP archive

Synchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method. Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension) "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

ZIP file containing the archive

Source code in pyorthanc/client.py
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
def get_studies_id_archive(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Synchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
            "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        ZIP file containing the archive
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/archive",
        params=params,
    )

get_studies_id_attachments(id_, params=None)

List attachments

Get the list of attachments that are associated with the given study Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (str): If present, retrieve the attachments list and their numerical ids

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the attachments

Source code in pyorthanc/client.py
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
def get_studies_id_attachments(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List attachments

    Get the list of attachments that are associated with the given study
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "full" (str): If present, retrieve the attachments list and their numerical ids

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the attachments
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments",
        params=params,
    )

get_studies_id_attachments_name(id_, name, headers=None)

List operations on attachments

Get the list of the operations that are available for attachments associated with the given study Tags: Other

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
def get_studies_id_attachments_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations on attachments

    Get the list of the operations that are available for attachments associated with the given study
    Tags: Other

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}",
        headers=headers,
    )

get_studies_id_attachments_name_compressed_data(id_, name, headers=None)

Get attachment (no decompression)

Get the (binary) content of one attachment associated with the given study. The attachment will not be decompressed if StorageCompression is true. Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
def get_studies_id_attachments_name_compressed_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment (no decompression)

    Get the (binary) content of one attachment associated with the given study. The attachment will not be decompressed if `StorageCompression` is `true`.
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/compressed-data",
        headers=headers,
    )

get_studies_id_attachments_name_compressed_md5(id_, name, headers=None)

Get MD5 of attachment on disk

Get the MD5 hash of one attachment associated with the given study, as stored on the disk. This is different from .../md5 iff EnableStorage is true. Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment, as stored on the disk

Source code in pyorthanc/client.py
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
def get_studies_id_attachments_name_compressed_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment on disk

    Get the MD5 hash of one attachment associated with the given study, as stored on the disk. This is different from `.../md5` iff `EnableStorage` is `true`.
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/compressed-md5",
        headers=headers,
    )

get_studies_id_attachments_name_compressed_size(id_, name, headers=None)

Get size of attachment on disk

Get the size of one attachment associated with the given study, as stored on the disk. This is different from .../size iff EnableStorage is true. Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment, as stored on the disk

Source code in pyorthanc/client.py
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
def get_studies_id_attachments_name_compressed_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment on disk

    Get the size of one attachment associated with the given study, as stored on the disk. This is different from `.../size` iff `EnableStorage` is `true`.
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment, as stored on the disk
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/compressed-size",
        headers=headers,
    )

get_studies_id_attachments_name_data(id_, name, headers=None)

Get attachment

Get the (binary) content of one attachment associated with the given study Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The attachment

Source code in pyorthanc/client.py
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
def get_studies_id_attachments_name_data(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get attachment

    Get the (binary) content of one attachment associated with the given study
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The attachment
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/data",
        headers=headers,
    )

get_studies_id_attachments_name_info(id_, name, headers=None)

Get info about the attachment

Get all the information about the attachment associated with the given study Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the information about the attachment

Source code in pyorthanc/client.py
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
def get_studies_id_attachments_name_info(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get info about the attachment

    Get all the information about the attachment associated with the given study
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the information about the attachment
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/info",
        headers=headers,
    )

get_studies_id_attachments_name_is_compressed(id_, name, headers=None)

Is attachment compressed?

Test whether the attachment has been stored as a compressed file on the disk. Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

0 if the attachment was stored uncompressed, 1 if it was compressed

Source code in pyorthanc/client.py
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
def get_studies_id_attachments_name_is_compressed(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Is attachment compressed?

    Test whether the attachment has been stored as a compressed file on the disk.
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `0` if the attachment was stored uncompressed, `1` if it was compressed
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/is-compressed",
        headers=headers,
    )

get_studies_id_attachments_name_md5(id_, name, headers=None)

Get MD5 of attachment

Get the MD5 hash of one attachment associated with the given study Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The MD5 of the attachment

Source code in pyorthanc/client.py
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
def get_studies_id_attachments_name_md5(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get MD5 of attachment

    Get the MD5 hash of one attachment associated with the given study
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The MD5 of the attachment
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/md5",
        headers=headers,
    )

get_studies_id_attachments_name_size(id_, name, headers=None)

Get size of attachment

Get the size of one attachment associated with the given study Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The size of the attachment

Source code in pyorthanc/client.py
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
def get_studies_id_attachments_name_size(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get size of attachment

    Get the size of one attachment associated with the given study
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the attachment, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The size of the attachment
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/attachments/{name}/size",
        headers=headers,
    )

get_studies_id_instances(id_, params=None)

Get child instances

Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If false or missing, only retrieve the list of child instances "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing information about the child DICOM instances

Source code in pyorthanc/client.py
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
def get_studies_id_instances(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get child instances

    Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If false or missing, only retrieve the list of child instances
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing information about the child DICOM instances
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/instances",
        params=params,
    )

get_studies_id_instances_tags(id_, params=None)

Get tags of instances

Get the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags

Source code in pyorthanc/client.py
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
def get_studies_id_instances_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get tags of instances

    Get the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/instances-tags",
        params=params,
    )

get_studies_id_labels(id_)

List labels

Get the labels that are associated with the given study (new in Orthanc 1.12.0) Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the labels

Source code in pyorthanc/client.py
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
def get_studies_id_labels(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List labels

    Get the labels that are associated with the given study (new in Orthanc 1.12.0)
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the labels
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/labels",
    )

get_studies_id_labels_label(id_, label)

Test label

Test whether the study is associated with the given label Tags: Studies

Parameters:

Name Type Description Default
label str

The label of interest

required
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty string is returned in the case of presence, error 404 in the case of absence

Source code in pyorthanc/client.py
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
def get_studies_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Test label

    Test whether the study is associated with the given label
    Tags: Studies

    Parameters
    ----------
    label
        The label of interest
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty string is returned in the case of presence, error 404 in the case of absence
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/labels/{label}",
    )

get_studies_id_media(id_, params=None)

Create DICOMDIR media

Synchronously create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method. Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "extended" (str): If present, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension) "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

ZIP file containing the archive

Source code in pyorthanc/client.py
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
def get_studies_id_media(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Synchronously create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might *not* be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using `POST` method.
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "extended" (str): If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*
            "filename" (str): Filename to set in the "Content-Disposition" HTTP header (including file extension)
            "transcode" (str): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        ZIP file containing the archive
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/media",
        params=params,
    )

get_studies_id_metadata(id_, params=None)

List metadata

Get the list of metadata that are associated with the given study Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If present, also retrieve the value of the individual metadata "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if expand argument is provided)

Source code in pyorthanc/client.py
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
def get_studies_id_metadata(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List metadata

    Get the list of metadata that are associated with the given study
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If present, also retrieve the value of the individual metadata
            "numeric" (str): If present, use the numeric identifier of the metadata instead of its symbolic name

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the names of the available metadata, or JSON associative array mapping metadata to their values (if `expand` argument is provided)
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/metadata",
        params=params,
    )

get_studies_id_metadata_name(id_, name, headers=None)

Get metadata

Get the value of a metadata that is associated with the given study Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
headers HeaderTypes

Dictionary of optional headers: "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Value of the metadata

Source code in pyorthanc/client.py
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
def get_studies_id_metadata_name(
    self,
    id_: str,
    name: str,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get metadata

    Get the value of a metadata that is associated with the given study
    Tags: Studies

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the study of interest
    headers
        Dictionary of optional headers:
            "If-None-Match" (str): Optional revision of the metadata, to check if its content has changed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Value of the metadata
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/metadata/{name}",
        headers=headers,
    )

get_studies_id_module(id_, params=None)

Get study module

Get the study module of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM study

Source code in pyorthanc/client.py
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
def get_studies_id_module(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get study module

    Get the study module of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM study
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/module",
        params=params,
    )

get_studies_id_module_patient(id_, params=None)

Get patient module of study

Get the patient module of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the DICOM study

Source code in pyorthanc/client.py
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
def get_studies_id_module_patient(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get patient module of study

    Get the patient module of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "ignore-length" (List): Also include the DICOM tags that are provided in this list, even if their associated value is long
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the DICOM study
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/module-patient",
        params=params,
    )

get_studies_id_patient(id_, params=None)

Get parent patient

Get detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the parent DICOM patient

Source code in pyorthanc/client.py
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
def get_studies_id_patient(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get parent patient

    Get detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the parent DICOM patient
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/patient",
        params=params,
    )

get_studies_id_series(id_, params=None)

Get child series

Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "expand" (str): If false or missing, only retrieve the list of child series "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "requested-tags" (str): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "short" (bool): If present, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing information about the child DICOM series

Source code in pyorthanc/client.py
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
def get_studies_id_series(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get child series

    Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "expand" (str): If false or missing, only retrieve the list of child series
            "full" (bool): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
            "requested-tags" (str): If present, list the DICOM Tags you want to list in the response.  This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'.  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return
            "short" (bool): If present, report the DICOM tags in hexadecimal format

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing information about the child DICOM series
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/series",
        params=params,
    )

get_studies_id_shared_tags(id_, params=None)

Get shared tags

Extract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
params QueryParamTypes

Dictionary of optional parameters: "short" (bool): If present, report the DICOM tags in hexadecimal format "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON object containing the values of the DICOM tags

Source code in pyorthanc/client.py
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
def get_studies_id_shared_tags(
    self,
    id_: str,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get shared tags

    Extract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    params
        Dictionary of optional parameters:
            "short" (bool): If present, report the DICOM tags in hexadecimal format
            "simplify" (bool): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON object containing the values of the DICOM tags
    """
    return self._get(
        route=f"{self.url}/studies/{id_}/shared-tags",
        params=params,
    )

get_studies_id_statistics(id_)

Get study statistics

Get statistics about the given study Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
def get_studies_id_statistics(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get study statistics

    Get statistics about the given study
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/studies/{id_}/statistics",
    )

get_system()

Get system information

Get system information about Orthanc Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
def get_system(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get system information

    Get system information about Orthanc
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._get(
        route=f"{self.url}/system",
    )

get_tools()

List operations

List the available operations under URI /tools/ Tags: Other

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

List of the available operations

Source code in pyorthanc/client.py
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
def get_tools(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """List operations

    List the available operations under URI `/tools/`
    Tags: Other

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        List of the available operations
    """
    return self._get(
        route=f"{self.url}/tools",
    )

get_tools_accepted_transfer_syntaxes()

Get accepted transfer syntaxes

Get the list of UIDs of the DICOM transfer syntaxes that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options AcceptedTransferSyntaxes and XXXTransferSyntaxAccepted. Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the transfer syntax UIDs

Source code in pyorthanc/client.py
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
def get_tools_accepted_transfer_syntaxes(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get accepted transfer syntaxes

    Get the list of UIDs of the DICOM transfer syntaxes that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options `AcceptedTransferSyntaxes` and `XXXTransferSyntaxAccepted`.
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the transfer syntax UIDs
    """
    return self._get(
        route=f"{self.url}/tools/accepted-transfer-syntaxes",
    )

get_tools_create_archive(params=None)

Create ZIP archive

Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument Tags: System

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "resources" (str): A comma separated list of Orthanc resource identifiers to include in the ZIP archive. "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
def get_tools_create_archive(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
    Tags: System

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "resources" (str): A comma separated list of Orthanc resource identifiers to include in the ZIP archive.
            "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._get(
        route=f"{self.url}/tools/create-archive",
        params=params,
    )

get_tools_create_media(params=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument Tags: System

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "resources" (str): A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media. "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
def get_tools_create_media(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
    Tags: System

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "resources" (str): A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media.
            "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._get(
        route=f"{self.url}/tools/create-media",
        params=params,
    )

get_tools_create_media_extended(params=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument Tags: System

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "resources" (str): A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media. "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
def get_tools_create_media_extended(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
    Tags: System

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "resources" (str): A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media.
            "transcode" (str): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._get(
        route=f"{self.url}/tools/create-media-extended",
        params=params,
    )

get_tools_default_encoding()

Get default encoding

Get the default encoding that is used by Orthanc if parsing a DICOM instance without the SpecificCharacterEncoding tag, or during C-FIND. This corresponds to the configuration option DefaultEncoding. Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The name of the encoding

Source code in pyorthanc/client.py
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
def get_tools_default_encoding(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get default encoding

    Get the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The name of the encoding
    """
    return self._get(
        route=f"{self.url}/tools/default-encoding",
    )

get_tools_dicom_conformance()

Get DICOM conformance

Get the DICOM conformance statement of Orthanc Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The DICOM conformance statement

Source code in pyorthanc/client.py
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
def get_tools_dicom_conformance(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get DICOM conformance

    Get the DICOM conformance statement of Orthanc
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The DICOM conformance statement
    """
    return self._get(
        route=f"{self.url}/tools/dicom-conformance",
    )

get_tools_generate_uid(params=None)

Generate an identifier

Generate a random DICOM identifier Tags: System

Parameters:

Name Type Description Default
params QueryParamTypes

Dictionary of optional parameters: "level" (str): Type of DICOM resource among: patient, study, series or instance

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The generated identifier

Source code in pyorthanc/client.py
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
def get_tools_generate_uid(
    self,
    params: QueryParamTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Generate an identifier

    Generate a random DICOM identifier
    Tags: System

    Parameters
    ----------
    params
        Dictionary of optional parameters:
            "level" (str): Type of DICOM resource among: `patient`, `study`, `series` or `instance`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The generated identifier
    """
    return self._get(
        route=f"{self.url}/tools/generate-uid_",
        params=params,
    )

get_tools_labels()

Get all the used labels

List all the labels that are associated with any resource of the Orthanc database Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the labels

Source code in pyorthanc/client.py
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
def get_tools_labels(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get all the used labels

    List all the labels that are associated with any resource of the Orthanc database
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the labels
    """
    return self._get(
        route=f"{self.url}/tools/labels",
    )

get_tools_log_level()

Get main log level

Get the main log level of Orthanc Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
def get_tools_log_level(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get main log level

    Get the main log level of Orthanc
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level",
    )

get_tools_log_level_dicom()

Get log level for dicom

Get the log level of the log category dicom Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
def get_tools_log_level_dicom(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `dicom`

    Get the log level of the log category `dicom`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-dicom",
    )

get_tools_log_level_generic()

Get log level for generic

Get the log level of the log category generic Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
def get_tools_log_level_generic(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `generic`

    Get the log level of the log category `generic`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-generic",
    )

get_tools_log_level_http()

Get log level for http

Get the log level of the log category http Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
def get_tools_log_level_http(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `http`

    Get the log level of the log category `http`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-http",
    )

get_tools_log_level_jobs()

Get log level for jobs

Get the log level of the log category jobs Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
def get_tools_log_level_jobs(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `jobs`

    Get the log level of the log category `jobs`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-jobs",
    )

get_tools_log_level_lua()

Get log level for lua

Get the log level of the log category lua Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
def get_tools_log_level_lua(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `lua`

    Get the log level of the log category `lua`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-lua",
    )

get_tools_log_level_plugins()

Get log level for plugins

Get the log level of the log category plugins Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
def get_tools_log_level_plugins(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `plugins`

    Get the log level of the log category `plugins`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-plugins",
    )

get_tools_log_level_sqlite()

Get log level for sqlite

Get the log level of the log category sqlite Tags: Logs

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Possible values: default, verbose or trace

Source code in pyorthanc/client.py
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
def get_tools_log_level_sqlite(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get log level for `sqlite`

    Get the log level of the log category `sqlite`
    Tags: Logs

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Possible values: `default`, `verbose` or `trace`
    """
    return self._get(
        route=f"{self.url}/tools/log-level-sqlite",
    )

get_tools_metrics()

Are metrics collected?

Returns a Boolean specifying whether Prometheus metrics are collected and exposed at /tools/metrics-prometheus Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

1 if metrics are collected, 0 if metrics are disabled

Source code in pyorthanc/client.py
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
def get_tools_metrics(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Are metrics collected?

    Returns a Boolean specifying whether Prometheus metrics are collected and exposed at `/tools/metrics-prometheus`
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `1` if metrics are collected, `0` if metrics are disabled
    """
    return self._get(
        route=f"{self.url}/tools/metrics",
    )

get_tools_metrics_prometheus()

Get usage metrics

Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

No description

Source code in pyorthanc/client.py
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
def get_tools_metrics_prometheus(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get usage metrics

    Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        No description
    """
    return self._get(
        route=f"{self.url}/tools/metrics-prometheus",
    )

get_tools_now()

Get UTC time

Get UTC time Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The UTC time

Source code in pyorthanc/client.py
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
def get_tools_now(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get UTC time

    Get UTC time
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The UTC time
    """
    return self._get(
        route=f"{self.url}/tools/now",
    )

get_tools_now_local()

Get local time

Get local time Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The local time

Source code in pyorthanc/client.py
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
def get_tools_now_local(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Get local time

    Get local time
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The local time
    """
    return self._get(
        route=f"{self.url}/tools/now-local",
    )

get_tools_unknown_sop_class_accepted()

Is unknown SOP class accepted?

Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID? Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

1 if accepted, 0 if not accepted

Source code in pyorthanc/client.py
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
def get_tools_unknown_sop_class_accepted(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Is unknown SOP class accepted?

    Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        `1` if accepted, `0` if not accepted
    """
    return self._get(
        route=f"{self.url}/tools/unknown-sop-class-accepted",
    )

post_instances(content=None)

Upload DICOM instances

Upload DICOM instances Tags: Instances

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Information about the uploaded instance, or list of information for each uploaded instance in the case of ZIP archive

Source code in pyorthanc/client.py
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
def post_instances(
    self,
    content: RequestContent = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Upload DICOM instances

    Upload DICOM instances
    Tags: Instances

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Information about the uploaded instance, or list of information for each uploaded instance in the case of ZIP archive
    """
    return self._post(
        route=f"{self.url}/instances",
        content=content,
    )

post_instances_id_anonymize(id_, json=None)

Anonymize instance

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 Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
json Any

Dictionary with the following keys: "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option DeidentifyLogsDicomVersion for possible values. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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). "KeepLabels": Keep the labels of all resources level (defaults to false) "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to false) "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of additional tags to be removed from 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). "Replace": 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). "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The anonymized DICOM instance

Source code in pyorthanc/client.py
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
def post_instances_id_anonymize(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Anonymize instance

    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
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    json
        Dictionary with the following keys:
          "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
          "KeepLabels": Keep the labels of all resources level (defaults to `false`)
          "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of additional tags to be removed from 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).
          "Replace": 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).
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The anonymized DICOM instance
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/instances/{id_}/anonymize",
        json=json,
    )

post_instances_id_attachments_name_compress(id_, name)

Compress attachment

Change the compression scheme that is used to store an attachment. Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
def post_instances_id_attachments_name_compress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Compress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/instances/{id_}/attachments/{name}/compress",
    )

post_instances_id_attachments_name_uncompress(id_, name)

Uncompress attachment

Change the compression scheme that is used to store an attachment. Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
def post_instances_id_attachments_name_uncompress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Uncompress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/instances/{id_}/attachments/{name}/uncompress",
    )

post_instances_id_attachments_name_verify_md5(id_, name)

Verify attachment

Verify that the attachment is not corrupted, by validating its MD5 hash Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

On success, a valid JSON object is returned

Source code in pyorthanc/client.py
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
def post_instances_id_attachments_name_verify_md5(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Verify attachment

    Verify that the attachment is not corrupted, by validating its MD5 hash
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        On success, a valid JSON object is returned
    """
    return self._post(
        route=f"{self.url}/instances/{id_}/attachments/{name}/verify-md5",
    )

post_instances_id_export(id_, data=None)

Write DICOM onto filesystem

Write the DICOM file onto the filesystem where Orthanc is running. This is insecure for Orthanc servers that are remotely accessible since one could overwrite any system file. Since Orthanc 1.12.0, this route is disabled by default, but can be enabled using the RestApiWriteToFileSystemEnabled configuration option. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the DICOM instance of interest

required
data RequestData

Target path on the filesystem

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
def post_instances_id_export(
    self,
    id_: str,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Write DICOM onto filesystem

    Write the DICOM file onto the filesystem where Orthanc is running.  This is insecure for Orthanc servers that are remotely accessible since one could overwrite any system file.  Since Orthanc 1.12.0, this route is disabled by default, but can be enabled using the `RestApiWriteToFileSystemEnabled` configuration option.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the DICOM instance of interest
    data
        Target path on the filesystem

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/instances/{id_}/export",
        data=data,
    )

post_instances_id_modify(id_, json=None)

Modify instance

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 Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
json Any

Dictionary with the following keys: "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": Keep the original value of the specified tags, to be chosen among the StudyInstanceUID, SeriesInstanceUID and SOPInstanceUID tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world. "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of tags that must be removed from 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). "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to false) "Replace": 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). "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The modified DICOM instance

Source code in pyorthanc/client.py
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
def post_instances_id_modify(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Modify instance

    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
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    json
        Dictionary with the following keys:
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of tags that must be removed from 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).
          "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
          "Replace": 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).
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The modified DICOM instance
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/instances/{id_}/modify",
        json=json,
    )

post_instances_id_reconstruct(id_, json=None)

Reconstruct tags & optionally files of instance

Reconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly. Tags: Instances

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the instance of interest

required
json Any

Dictionary with the following keys: "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4) "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
def post_instances_id_reconstruct(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Reconstruct tags & optionally files of instance

    Reconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
    Tags: Instances

    Parameters
    ----------
    id_
        Orthanc identifier of the instance of interest
    json
        Dictionary with the following keys:
          "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
          "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/instances/{id_}/reconstruct",
        json=json,
    )

post_jobs_id_cancel(id_)

Cancel job

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 Tags: Jobs

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
def post_jobs_id_cancel(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Cancel job

    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
    Tags: Jobs

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._post(
        route=f"{self.url}/jobs/{id_}/cancel",
    )

post_jobs_id_pause(id_)

Pause job

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 Tags: Jobs

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
def post_jobs_id_pause(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Pause job

    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
    Tags: Jobs

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._post(
        route=f"{self.url}/jobs/{id_}/pause",
    )

post_jobs_id_resubmit(id_)

Resubmit job

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 Tags: Jobs

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
def post_jobs_id_resubmit(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Resubmit job

    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
    Tags: Jobs

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._post(
        route=f"{self.url}/jobs/{id_}/resubmit",
    )

post_jobs_id_resume(id_)

Resume job

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 Tags: Jobs

Parameters:

Name Type Description Default
id_ str

Identifier of the job of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
def post_jobs_id_resume(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Resume job

    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
    Tags: Jobs

    Parameters
    ----------
    id_
        Identifier of the job of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._post(
        route=f"{self.url}/jobs/{id_}/resume",
    )

post_modalities_id_echo(id_, json=None)

Trigger C-ECHO SCU

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "CheckFind": Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the DicomEchoChecksFind configuration option. New in Orthanc 1.8.1. "Timeout": Timeout for the C-ECHO command, in seconds

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
def post_modalities_id_echo(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Trigger C-ECHO SCU

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "CheckFind": Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` configuration option. New in Orthanc 1.8.1.
          "Timeout": Timeout for the C-ECHO command, in seconds


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/echo",
        json=json,
    )

post_modalities_id_find(id_, json=None)

Hierarchical C-FIND SCU

Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of matching patients/studies/series. Deprecated in favor of /modalities/{id}/query. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys:

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array describing the DICOM tags of the matching patients, embedding the matching studies, then the matching series.

Source code in pyorthanc/client.py
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
def post_modalities_id_find(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Hierarchical C-FIND SCU

    Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of matching patients/studies/series. Deprecated in favor of `/modalities/{id}/query`.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array describing the DICOM tags of the matching patients, embedding the matching studies, then the matching series.
    """
    warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/find",
        json=json,
    )

post_modalities_id_find_instance(id_, json=None)

C-FIND SCU for instances

Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of /modalities/{id}/query. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys:

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array describing the DICOM tags of the matching instances

Source code in pyorthanc/client.py
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
def post_modalities_id_find_instance(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """C-FIND SCU for instances

    Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of `/modalities/{id}/query`.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array describing the DICOM tags of the matching instances
    """
    warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/find-instance",
        json=json,
    )

post_modalities_id_find_patient(id_, json=None)

C-FIND SCU for patients

Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of /modalities/{id}/query. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys:

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array describing the DICOM tags of the matching patients

Source code in pyorthanc/client.py
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
def post_modalities_id_find_patient(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """C-FIND SCU for patients

    Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of `/modalities/{id}/query`.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array describing the DICOM tags of the matching patients
    """
    warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/find-patient",
        json=json,
    )

post_modalities_id_find_series(id_, json=None)

C-FIND SCU for series

Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of /modalities/{id}/query. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys:

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array describing the DICOM tags of the matching series

Source code in pyorthanc/client.py
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
def post_modalities_id_find_series(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """C-FIND SCU for series

    Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of `/modalities/{id}/query`.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array describing the DICOM tags of the matching series
    """
    warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/find-series",
        json=json,
    )

post_modalities_id_find_study(id_, json=None)

C-FIND SCU for studies

Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of /modalities/{id}/query. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys:

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array describing the DICOM tags of the matching studies

Source code in pyorthanc/client.py
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
def post_modalities_id_find_study(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """C-FIND SCU for studies

    Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of `/modalities/{id}/query`.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array describing the DICOM tags of the matching studies
    """
    warnings.warn("This method is deprecated.", DeprecationWarning, stacklevel=2)
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/find-study",
        json=json,
    )

post_modalities_id_find_worklist(id_, json=None)

C-FIND SCU for worklist

Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "Full": If set to true, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "Query": Associative array containing the filter on the values of the DICOM tags "Short": If set to true, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array describing the DICOM tags of the matching worklists

Source code in pyorthanc/client.py
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
def post_modalities_id_find_worklist(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """C-FIND SCU for worklist

    Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
          "Query": Associative array containing the filter on the values of the DICOM tags
          "Short": If set to `true`, report the DICOM tags in hexadecimal format


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array describing the DICOM tags of the matching worklists
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/find-worklist",
        json=json,
    )

post_modalities_id_move(id_, json=None)

Trigger C-MOVE SCU

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Level": Level of the query (Patient, Study, Series or Instance) "LocalAet": Local AET that is used for this commands, defaults to DicomAet configuration option. Ignored if DicomModalities already sets LocalAet for this modality. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": List of queries identifying all the DICOM resources to be sent "Synchronous": 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. "TargetAet": Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU commands, defaults to DicomAet configuration option in order to do a simple query/retrieve "Timeout": Timeout for the C-MOVE command, in seconds

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
def post_modalities_id_move(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Trigger C-MOVE SCU

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Level": Level of the query (`Patient`, `Study`, `Series` or `Instance`)
          "LocalAet": Local AET that is used for this commands, defaults to `DicomAet` configuration option. Ignored if `DicomModalities` already sets `LocalAet` for this modality.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": List of queries identifying all the DICOM resources to be sent
          "Synchronous": 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.
          "TargetAet": Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU commands, defaults to `DicomAet` configuration option in order to do a simple query/retrieve
          "Timeout": Timeout for the C-MOVE command, in seconds


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/move",
        json=json,
    )

post_modalities_id_query(id_, json=None)

Trigger C-FIND SCU

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "Level": Level of the query (Patient, Study, Series or Instance) "LocalAet": Local AET that is used for this commands, defaults to DicomAet configuration option. Ignored if DicomModalities already sets LocalAet for this modality. "Normalize": Whether to normalize the query, i.e. whether to wipe out from the query, the DICOM tags that are not applicable for the query-retrieve level of interest "Query": Associative array containing the filter on the values of the DICOM tags "Timeout": Timeout for the C-FIND command and subsequent C-MOVE retrievals, in seconds (new in Orthanc 1.9.1)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
def post_modalities_id_query(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Trigger C-FIND SCU

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "Level": Level of the query (`Patient`, `Study`, `Series` or `Instance`)
          "LocalAet": Local AET that is used for this commands, defaults to `DicomAet` configuration option. Ignored if `DicomModalities` already sets `LocalAet` for this modality.
          "Normalize": Whether to normalize the query, i.e. whether to wipe out from the query, the DICOM tags that are not applicable for the query-retrieve level of interest
          "Query": Associative array containing the filter on the values of the DICOM tags
          "Timeout": Timeout for the C-FIND command and subsequent C-MOVE retrievals, in seconds (new in Orthanc 1.9.1)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/query",
        json=json,
    )

post_modalities_id_storage_commitment(id_, json=None)

Trigger storage commitment request

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "DicomInstances": List of DICOM resources that are not necessarily stored within Orthanc, but that must be checked by storage commitment. This is a list of JSON objects that must contain the SOPClassUID and SOPInstanceUID fields. "Resources": List of the Orthanc identifiers of the DICOM resources to be checked by storage commitment "Timeout": Timeout for the storage commitment command (new in Orthanc 1.9.1)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
def post_modalities_id_storage_commitment(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Trigger storage commitment request

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "DicomInstances": List of DICOM resources that are not necessarily stored within Orthanc, but that must be checked by storage commitment. This is a list of JSON objects that must contain the `SOPClassUID` and `SOPInstanceUID` fields.
          "Resources": List of the Orthanc identifiers of the DICOM resources to be checked by storage commitment
          "Timeout": Timeout for the storage commitment command (new in Orthanc 1.9.1)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/storage-commitment",
        json=json,
    )

post_modalities_id_store(id_, data=None, json=None)

Trigger C-STORE SCU

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "CalledAet": Called AET that is used for this commands, defaults to AET configuration option. Allows you to overwrite the destination AET for a specific operation. "Host": Host that is used for this commands, defaults to Host configuration option. Allows you to overwrite the destination host for a specific operation. "LocalAet": Local AET that is used for this commands, defaults to DicomAet configuration option. Ignored if DicomModalities already sets LocalAet for this modality. "MoveOriginatorAet": Move originator AET that is used for this commands, in order to fake a C-MOVE SCU "MoveOriginatorID": Move originator ID that is used for this commands, in order to fake a C-MOVE SCU "Permissive": If true, ignore errors during the individual steps of the job. "Port": Port that is used for this command, defaults to Port configuration option. Allows you to overwrite the destination port for a specific operation. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": List of the Orthanc identifiers of all the DICOM resources to be sent "StorageCommitment": 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 "Synchronous": 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. "Timeout": Timeout for the C-STORE command, in seconds

None
data RequestData

The Orthanc identifier of one resource to be sent

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
def post_modalities_id_store(
    self,
    id_: str,
    data: RequestData = None,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Trigger C-STORE SCU

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "CalledAet": Called AET that is used for this commands, defaults to `AET` configuration option. Allows you to overwrite the destination AET for a specific operation.
          "Host": Host that is used for this commands, defaults to `Host` configuration option. Allows you to overwrite the destination host for a specific operation.
          "LocalAet": Local AET that is used for this commands, defaults to `DicomAet` configuration option. Ignored if `DicomModalities` already sets `LocalAet` for this modality.
          "MoveOriginatorAet": Move originator AET that is used for this commands, in order to fake a C-MOVE SCU
          "MoveOriginatorID": Move originator ID that is used for this commands, in order to fake a C-MOVE SCU
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Port": Port that is used for this command, defaults to `Port` configuration option. Allows you to overwrite the destination port for a specific operation.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": List of the Orthanc identifiers of all the DICOM resources to be sent
          "StorageCommitment": 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
          "Synchronous": 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.
          "Timeout": Timeout for the C-STORE command, in seconds

    data
        The Orthanc identifier of one resource to be sent

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/modalities/{id_}/store",
        data=data,
        json=json,
    )

post_modalities_id_store_straight(id_, content=None)

Straight C-STORE SCU

Synchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as storescu from DCMTK or dcm4che. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
content RequestContent
- (Content-Type: "application/dicom") DICOM instance to be sent
None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
def post_modalities_id_store_straight(
    self,
    id_: str,
    content: RequestContent = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Straight C-STORE SCU

    Synchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `storescu` from DCMTK or dcm4che.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    content
            - (Content-Type: "application/dicom") DICOM instance to be sent

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._post(
        route=f"{self.url}/modalities/{id_}/store-straight",
        content=content,
    )

post_patients_id_anonymize(id_, json=None)

Anonymize patient

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 Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option DeidentifyLogsDicomVersion for possible values. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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). "KeepLabels": Keep the labels of all resources level (defaults to false) "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to false) "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of additional tags to be removed from 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). "Replace": 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). "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
def post_patients_id_anonymize(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Anonymize patient

    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
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
          "KeepLabels": Keep the labels of all resources level (defaults to `false`)
          "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of additional tags to be removed from 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).
          "Replace": 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).
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/patients/{id_}/anonymize",
        json=json,
    )

post_patients_id_archive(id_, json=None)

Create ZIP archive

Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
def post_patients_id_archive(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/patients/{id_}/archive",
        json=json,
    )

post_patients_id_attachments_name_compress(id_, name)

Compress attachment

Change the compression scheme that is used to store an attachment. Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
def post_patients_id_attachments_name_compress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Compress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/patients/{id_}/attachments/{name}/compress",
    )

post_patients_id_attachments_name_uncompress(id_, name)

Uncompress attachment

Change the compression scheme that is used to store an attachment. Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
def post_patients_id_attachments_name_uncompress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Uncompress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/patients/{id_}/attachments/{name}/uncompress",
    )

post_patients_id_attachments_name_verify_md5(id_, name)

Verify attachment

Verify that the attachment is not corrupted, by validating its MD5 hash Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

On success, a valid JSON object is returned

Source code in pyorthanc/client.py
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
def post_patients_id_attachments_name_verify_md5(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Verify attachment

    Verify that the attachment is not corrupted, by validating its MD5 hash
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        On success, a valid JSON object is returned
    """
    return self._post(
        route=f"{self.url}/patients/{id_}/attachments/{name}/verify-md5",
    )

post_patients_id_media(id_, json=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Extended": If true, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR. Default value is false. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
def post_patients_id_media(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/patients/{id_}/media",
        json=json,
    )

post_patients_id_modify(id_, json=None)

Modify patient

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 Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": Keep the original value of the specified tags, to be chosen among the StudyInstanceUID, SeriesInstanceUID and SOPInstanceUID tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world. "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of tags that must be removed from 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). "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to false) "Replace": 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). "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
def post_patients_id_modify(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Modify patient

    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
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of tags that must be removed from 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).
          "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
          "Replace": 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).
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/patients/{id_}/modify",
        json=json,
    )

post_patients_id_reconstruct(id_, json=None)

Reconstruct tags & optionally files of patient

Reconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly. Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required
json Any

Dictionary with the following keys: "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4) "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
def post_patients_id_reconstruct(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Reconstruct tags & optionally files of patient

    Reconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest
    json
        Dictionary with the following keys:
          "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
          "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/patients/{id_}/reconstruct",
        json=json,
    )

post_peers_id_store(id_, data=None, json=None)

Send to Orthanc peer

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Compress": Whether to compress the DICOM instances using gzip before the actual sending "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": List of the Orthanc identifiers of all the DICOM resources to be sent "Synchronous": 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. "Transcode": Transcode to the provided DICOM transfer syntax before the actual sending

None
data RequestData

The Orthanc identifier of one resource to be sent

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
def post_peers_id_store(
    self,
    id_: str,
    data: RequestData = None,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Send to Orthanc peer

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Compress": Whether to compress the DICOM instances using gzip before the actual sending
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": List of the Orthanc identifiers of all the DICOM resources to be sent
          "Synchronous": 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.
          "Transcode": Transcode to the provided DICOM transfer syntax before the actual sending

    data
        The Orthanc identifier of one resource to be sent

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/peers/{id_}/store",
        data=data,
        json=json,
    )

post_peers_id_store_straight(id_, content=None)

Straight store to peer

Synchronously send the DICOM instance in the POST body to the Orthanc peer whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as curl. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the modality of interest

required
content RequestContent
- (Content-Type: "application/dicom") DICOM instance to be sent
None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
def post_peers_id_store_straight(
    self,
    id_: str,
    content: RequestContent = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Straight store to peer

    Synchronously send the DICOM instance in the POST body to the Orthanc peer whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `curl`.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the modality of interest
    content
            - (Content-Type: "application/dicom") DICOM instance to be sent

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    return self._post(
        route=f"{self.url}/peers/{id_}/store-straight",
        content=content,
    )

post_queries_id_answers_index_query_instances(id_, index, json=None)

Query the child instances of an answer

Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL Tags: Networking

Parameters:

Name Type Description Default
index str

Index of the answer

required
id_ str

Identifier of the query of interest

required
json Any

Dictionary with the following keys: "Query": Associative array containing the filter on the values of the DICOM tags "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
def post_queries_id_answers_index_query_instances(
    self,
    id_: str,
    index: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Query the child instances of an answer

    Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
    Tags: Networking

    Parameters
    ----------
    index
        Index of the answer
    id_
        Identifier of the query of interest
    json
        Dictionary with the following keys:
          "Query": Associative array containing the filter on the values of the DICOM tags
          "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/queries/{id_}/answers/{index}/query-instances",
        json=json,
    )

post_queries_id_answers_index_query_series(id_, index, json=None)

Query the child series of an answer

Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL Tags: Networking

Parameters:

Name Type Description Default
index str

Index of the answer

required
id_ str

Identifier of the query of interest

required
json Any

Dictionary with the following keys: "Query": Associative array containing the filter on the values of the DICOM tags "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
def post_queries_id_answers_index_query_series(
    self,
    id_: str,
    index: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Query the child series of an answer

    Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
    Tags: Networking

    Parameters
    ----------
    index
        Index of the answer
    id_
        Identifier of the query of interest
    json
        Dictionary with the following keys:
          "Query": Associative array containing the filter on the values of the DICOM tags
          "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/queries/{id_}/answers/{index}/query-series",
        json=json,
    )

post_queries_id_answers_index_query_studies(id_, index, json=None)

Query the child studies of an answer

Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL Tags: Networking

Parameters:

Name Type Description Default
index str

Index of the answer

required
id_ str

Identifier of the query of interest

required
json Any

Dictionary with the following keys: "Query": Associative array containing the filter on the values of the DICOM tags "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
def post_queries_id_answers_index_query_studies(
    self,
    id_: str,
    index: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Query the child studies of an answer

    Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
    Tags: Networking

    Parameters
    ----------
    index
        Index of the answer
    id_
        Identifier of the query of interest
    json
        Dictionary with the following keys:
          "Query": Associative array containing the filter on the values of the DICOM tags
          "Timeout": Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/queries/{id_}/answers/{index}/query-studies",
        json=json,
    )

post_queries_id_answers_index_retrieve(id_, index, data=None, json=None)

Retrieve one answer

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 Tags: Networking

Parameters:

Name Type Description Default
index str

Index of the answer

required
id_ str

Identifier of the query of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Full": If set to true, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Simplify": If set to true, report the DICOM tags in human-readable format (using the symbolic name of the tags) "Synchronous": 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. "TargetAet": AET of the target modality. By default, the AET of Orthanc is used, as defined in the DicomAet configuration option. "Timeout": Timeout for the C-MOVE command, in seconds

None
data RequestData

AET of the target modality

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
def post_queries_id_answers_index_retrieve(
    self,
    id_: str,
    index: str,
    data: RequestData = None,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Retrieve one answer

    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
    Tags: Networking

    Parameters
    ----------
    index
        Index of the answer
    id_
        Identifier of the query of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Simplify": If set to `true`, report the DICOM tags in human-readable format (using the symbolic name of the tags)
          "Synchronous": 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.
          "TargetAet": AET of the target modality. By default, the AET of Orthanc is used, as defined in the `DicomAet` configuration option.
          "Timeout": Timeout for the C-MOVE command, in seconds

    data
        AET of the target modality

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/queries/{id_}/answers/{index}/retrieve",
        data=data,
        json=json,
    )

post_queries_id_retrieve(id_, data=None, json=None)

Retrieve all answers

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the query of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Full": If set to true, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Simplify": If set to true, report the DICOM tags in human-readable format (using the symbolic name of the tags) "Synchronous": 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. "TargetAet": AET of the target modality. By default, the AET of Orthanc is used, as defined in the DicomAet configuration option. "Timeout": Timeout for the C-MOVE command, in seconds

None
data RequestData

AET of the target modality

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
def post_queries_id_retrieve(
    self,
    id_: str,
    data: RequestData = None,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Retrieve all answers

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the query of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Simplify": If set to `true`, report the DICOM tags in human-readable format (using the symbolic name of the tags)
          "Synchronous": 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.
          "TargetAet": AET of the target modality. By default, the AET of Orthanc is used, as defined in the `DicomAet` configuration option.
          "Timeout": Timeout for the C-MOVE command, in seconds

    data
        AET of the target modality

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/queries/{id_}/retrieve",
        data=data,
        json=json,
    )

post_series_id_anonymize(id_, json=None)

Anonymize series

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 Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option DeidentifyLogsDicomVersion for possible values. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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). "KeepLabels": Keep the labels of all resources level (defaults to false) "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to false) "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of additional tags to be removed from 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). "Replace": 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). "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
def post_series_id_anonymize(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Anonymize series

    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
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
          "KeepLabels": Keep the labels of all resources level (defaults to `false`)
          "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of additional tags to be removed from 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).
          "Replace": 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).
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/series/{id_}/anonymize",
        json=json,
    )

post_series_id_archive(id_, json=None)

Create ZIP archive

Create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
def post_series_id_archive(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/series/{id_}/archive",
        json=json,
    )

post_series_id_attachments_name_compress(id_, name)

Compress attachment

Change the compression scheme that is used to store an attachment. Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
def post_series_id_attachments_name_compress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Compress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/series/{id_}/attachments/{name}/compress",
    )

post_series_id_attachments_name_uncompress(id_, name)

Uncompress attachment

Change the compression scheme that is used to store an attachment. Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
def post_series_id_attachments_name_uncompress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Uncompress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/series/{id_}/attachments/{name}/uncompress",
    )

post_series_id_attachments_name_verify_md5(id_, name)

Verify attachment

Verify that the attachment is not corrupted, by validating its MD5 hash Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

On success, a valid JSON object is returned

Source code in pyorthanc/client.py
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
def post_series_id_attachments_name_verify_md5(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Verify attachment

    Verify that the attachment is not corrupted, by validating its MD5 hash
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        On success, a valid JSON object is returned
    """
    return self._post(
        route=f"{self.url}/series/{id_}/attachments/{name}/verify-md5",
    )

post_series_id_media(id_, json=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Extended": If true, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR. Default value is false. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
def post_series_id_media(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/series/{id_}/media",
        json=json,
    )

post_series_id_modify(id_, json=None)

Modify series

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 Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": Keep the original value of the specified tags, to be chosen among the StudyInstanceUID, SeriesInstanceUID and SOPInstanceUID tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world. "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of tags that must be removed from 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). "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to false) "Replace": 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). "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
def post_series_id_modify(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Modify series

    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
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of tags that must be removed from 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).
          "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
          "Replace": 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).
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/series/{id_}/modify",
        json=json,
    )

post_series_id_reconstruct(id_, json=None)

Reconstruct tags & optionally files of series

Reconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly. Tags: Series

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the series of interest

required
json Any

Dictionary with the following keys: "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4) "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
def post_series_id_reconstruct(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Reconstruct tags & optionally files of series

    Reconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
    Tags: Series

    Parameters
    ----------
    id_
        Orthanc identifier of the series of interest
    json
        Dictionary with the following keys:
          "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
          "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/series/{id_}/reconstruct",
        json=json,
    )

post_storage_commitment_id_remove(id_)

Remove after storage commitment

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 Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the storage commitment report

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
def post_storage_commitment_id_remove(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Remove after storage commitment

    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
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the storage commitment report

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/storage-commitment/{id_}/remove",
    )

post_studies_id_anonymize(id_, json=None)

Anonymize study

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 Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option DeidentifyLogsDicomVersion for possible values. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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). "KeepLabels": Keep the labels of all resources level (defaults to false) "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to false) "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of additional tags to be removed from 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). "Replace": 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). "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
def post_studies_id_anonymize(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Anonymize study

    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
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
          "KeepLabels": Keep the labels of all resources level (defaults to `false`)
          "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of additional tags to be removed from 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).
          "Replace": 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).
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/anonymize",
        json=json,
    )

post_studies_id_archive(id_, json=None)

Create ZIP archive

Create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
def post_studies_id_archive(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/archive",
        json=json,
    )

post_studies_id_attachments_name_compress(id_, name)

Compress attachment

Change the compression scheme that is used to store an attachment. Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
def post_studies_id_attachments_name_compress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Compress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/studies/{id_}/attachments/{name}/compress",
    )

post_studies_id_attachments_name_uncompress(id_, name)

Uncompress attachment

Change the compression scheme that is used to store an attachment. Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
def post_studies_id_attachments_name_uncompress(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Uncompress attachment

    Change the compression scheme that is used to store an attachment.
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/studies/{id_}/attachments/{name}/uncompress",
    )

post_studies_id_attachments_name_verify_md5(id_, name)

Verify attachment

Verify that the attachment is not corrupted, by validating its MD5 hash Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

On success, a valid JSON object is returned

Source code in pyorthanc/client.py
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
def post_studies_id_attachments_name_verify_md5(
    self,
    id_: str,
    name: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Verify attachment

    Verify that the attachment is not corrupted, by validating its MD5 hash
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        On success, a valid JSON object is returned
    """
    return self._post(
        route=f"{self.url}/studies/{id_}/attachments/{name}/verify-md5",
    )

post_studies_id_media(id_, json=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Extended": If true, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR. Default value is false. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
def post_studies_id_media(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/media",
        json=json,
    )

post_studies_id_merge(id_, json=None)

Merge study

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 Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "KeepSource": If set to true, instructs Orthanc to keep a copy of the original resources in their source study. By default, the original resources are deleted from Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": The list of DICOM resources (studies, series, and/or instances) to be merged into the study of interest (mandatory option) "Synchronous": 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.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
def post_studies_id_merge(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Merge study

    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
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "KeepSource": If set to `true`, instructs Orthanc to keep a copy of the original resources in their source study. By default, the original resources are deleted from Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": The list of DICOM resources (studies, series, and/or instances) to be merged into the study of interest (mandatory option)
          "Synchronous": 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.


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/merge",
        json=json,
    )

post_studies_id_modify(id_, json=None)

Modify study

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 Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": Keep the original value of the specified tags, to be chosen among the StudyInstanceUID, SeriesInstanceUID and SOPInstanceUID tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world. "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of tags that must be removed from 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). "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to false) "Replace": 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). "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
def post_studies_id_modify(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Modify study

    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
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of tags that must be removed from 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).
          "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
          "Replace": 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).
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/modify",
        json=json,
    )

post_studies_id_reconstruct(id_, json=None)

Reconstruct tags & optionally files of study

Reconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly. Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4) "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
def post_studies_id_reconstruct(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Reconstruct tags & optionally files of study

    Reconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "LimitToThisLevelMainDicomTags": Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is usefull e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
          "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/reconstruct",
        json=json,
    )

post_studies_id_split(id_, json=None)

Split study

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 Tags: Studies

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the study of interest

required
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Instances": The list of instances to be separated from the parent study. These instances must all be children of the same source study, that is specified in the URI. "KeepLabels": Keep the labels of all resources level (defaults to false) "KeepSource": If set to true, instructs Orthanc to keep a copy of the original series/instances in the source study. By default, the original series/instances are deleted from Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Remove": List of tags that must be removed in the new study (from the same modules as in the Replace option) "Replace": Associative array to change the value of some DICOM tags in the new study. These tags must be part of the "Patient Module Attributes" or the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3. "Series": The list of series to be separated from the parent study. These series must all be children of the same source study, that is specified in the URI. "Synchronous": 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.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
def post_studies_id_split(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Split study

    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
    Tags: Studies

    Parameters
    ----------
    id_
        Orthanc identifier of the study of interest
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Instances": The list of instances to be separated from the parent study. These instances must all be children of the same source study, that is specified in the URI.
          "KeepLabels": Keep the labels of all resources level (defaults to `false`)
          "KeepSource": If set to `true`, instructs Orthanc to keep a copy of the original series/instances in the source study. By default, the original series/instances are deleted from Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Remove": List of tags that must be removed in the new study (from the same modules as in the `Replace` option)
          "Replace": Associative array to change the value of some DICOM tags in the new study. These tags must be part of the "Patient Module Attributes" or the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3.
          "Series": The list of series to be separated from the parent study. These series must all be children of the same source study, that is specified in the URI.
          "Synchronous": 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.


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/studies/{id_}/split",
        json=json,
    )

post_tools_bulk_anonymize(json=None)

Anonymize a set of resources

Start a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field. Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option DeidentifyLogsDicomVersion for possible values. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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). "KeepLabels": Keep the labels of all resources level (defaults to false) "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to false) "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of additional tags to be removed from 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). "Replace": 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). "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest. "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The list of all the resources that have been created by this anonymization

Source code in pyorthanc/client.py
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
def post_tools_bulk_anonymize(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Anonymize a set of resources

    Start a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "DicomVersion": Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": List of DICOM tags whose value must not be destroyed by the anonymization. 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).
          "KeepLabels": Keep the labels of all resources level (defaults to `false`)
          "KeepPrivateTags": Keep the private tags from the DICOM instances (defaults to `false`)
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of additional tags to be removed from 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).
          "Replace": 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).
          "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The list of all the resources that have been created by this anonymization
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/bulk-anonymize",
        json=json,
    )

post_tools_bulk_content(json=None)

Describe a set of resources

Get the content all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field, in one single call. Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Full": If set to true, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "Level": This optional argument specifies the level of interest (can be Patient, Study, Series or Instance). Orthanc will loop over the items inside Resources, and explore upward or downward in the DICOM hierarchy in order to find the level of interest. "Metadata": If set to true (default value), the metadata associated with the resources will also be retrieved. "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest. "Short": If set to true, report the DICOM tags in hexadecimal format

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
def post_tools_bulk_content(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Describe a set of resources

    Get the content all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field, in one single call.
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
          "Level": This optional argument specifies the level of interest (can be `Patient`, `Study`, `Series` or `Instance`). Orthanc will loop over the items inside `Resources`, and explore upward or downward in the DICOM hierarchy in order to find the level of interest.
          "Metadata": If set to `true` (default value), the metadata associated with the resources will also be retrieved.
          "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.
          "Short": If set to `true`, report the DICOM tags in hexadecimal format


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/bulk-content",
        json=json,
    )

post_tools_bulk_delete(json=None)

Delete a set of resources

Delete all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field. Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
def post_tools_bulk_delete(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Delete a set of resources

    Delete all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/bulk-delete",
        json=json,
    )

post_tools_bulk_modify(json=None)

Modify a set of resources

Start a job that will modify all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field. Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Asynchronous": If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible. "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world "Keep": Keep the original value of the specified tags, to be chosen among the StudyInstanceUID, SeriesInstanceUID and SOPInstanceUID tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world. "KeepSource": If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. "Level": Level of the modification (Patient, Study, Series or Instance). If absent, the level defaults to Instance, but is set to Patient if PatientID is modified, to Study if StudyInstanceUID is modified, or to Series if SeriesInstancesUID is modified. (new in Orthanc 1.9.7) "Permissive": If true, ignore errors during the individual steps of the job. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "PrivateCreator": The private creator to be used for private tags in Replace "Remove": List of tags that must be removed from 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). "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to false) "Replace": 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). "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest. "Synchronous": 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. "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

The list of all the resources that have been altered by this modification

Source code in pyorthanc/client.py
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
def post_tools_bulk_modify(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Modify a set of resources

    Start a job that will modify all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
          "Force": Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
          "Keep": Keep the original value of the specified tags, to be chosen among the `StudyInstanceUID`, `SeriesInstanceUID` and `SOPInstanceUID` tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.
          "KeepSource": If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
          "Level": Level of the modification (`Patient`, `Study`, `Series` or `Instance`). If absent, the level defaults to `Instance`, but is set to `Patient` if `PatientID` is modified, to `Study` if `StudyInstanceUID` is modified, or to `Series` if `SeriesInstancesUID` is modified. (new in Orthanc 1.9.7)
          "Permissive": If `true`, ignore errors during the individual steps of the job.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "PrivateCreator": The private creator to be used for private tags in `Replace`
          "Remove": List of tags that must be removed from 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).
          "RemovePrivateTags": Remove the private tags from the DICOM instances (defaults to `false`)
          "Replace": 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).
          "Resources": List of the Orthanc identifiers of the patients/studies/series/instances of interest.
          "Synchronous": 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.
          "Transcode": Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        The list of all the resources that have been altered by this modification
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/bulk-modify",
        json=json,
    )

post_tools_create_archive(json=None)

Create ZIP archive

Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": The list of Orthanc identifiers of interest. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
def post_tools_create_archive(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create ZIP archive

    Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": The list of Orthanc identifiers of interest.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/create-archive",
        json=json,
    )

post_tools_create_dicom(json=None)

Create one DICOM instance

Create one DICOM instance, and store it into Orthanc Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Content": This field can be used to embed an image (pixel data encoded as PNG or JPEG), a PDF, or a 3D manufactoring model (MTL/OBJ/STL) inside the created DICOM instance. The file to be encapsulated must be provided using its data URI scheme encoding. This field can possibly contain a JSON array, in which case a DICOM series is created containing one DICOM instance for each item in the Content field. "Force": Avoid the consistency checks for the DICOM tags that enforce the DICOM model of the real-world. You can notably use this flag if you need to manually set the tags StudyInstanceUID, SeriesInstanceUID, or SOPInstanceUID. Be careful with this feature. "InterpretBinaryTags": If some value in the Tags associative array is formatted according to some data URI scheme encoding, whether this value is decoded to a binary value or kept as such (true by default) "Parent": If present, the newly created instance will be attached to the parent DICOM resource whose Orthanc identifier is contained in this field. The DICOM tags of the parent modules in the DICOM hierarchy will be automatically copied to the newly created instance. "PrivateCreator": The private creator to be used for private tags in Tags "Tags": Associative array containing the tags of the new instance to be created

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
def post_tools_create_dicom(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create one DICOM instance

    Create one DICOM instance, and store it into Orthanc
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Content": This field can be used to embed an image (pixel data encoded as PNG or JPEG), a PDF, or a 3D manufactoring model (MTL/OBJ/STL) inside the created DICOM instance. The file to be encapsulated must be provided using its [data URI scheme encoding](https://en.wikipedia.org/wiki/Data_URI_scheme). This field can possibly contain a JSON array, in which case a DICOM series is created containing one DICOM instance for each item in the `Content` field.
          "Force": Avoid the consistency checks for the DICOM tags that enforce the DICOM model of the real-world. You can notably use this flag if you need to manually set the tags `StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`. Be careful with this feature.
          "InterpretBinaryTags": If some value in the `Tags` associative array is formatted according to some [data URI scheme encoding](https://en.wikipedia.org/wiki/Data_URI_scheme), whether this value is decoded to a binary value or kept as such (`true` by default)
          "Parent": If present, the newly created instance will be attached to the parent DICOM resource whose Orthanc identifier is contained in this field. The DICOM tags of the parent modules in the DICOM hierarchy will be automatically copied to the newly created instance.
          "PrivateCreator": The private creator to be used for private tags in `Tags`
          "Tags": Associative array containing the tags of the new instance to be created


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]

    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/create-dicom",
        json=json,
    )

post_tools_create_media(json=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Extended": If true, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR. Default value is false. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": The list of Orthanc identifiers of interest. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
def post_tools_create_media(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": The list of Orthanc identifiers of interest.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/create-media",
        json=json,
    )

post_tools_create_media_extended(json=None)

Create DICOMDIR media

Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "Asynchronous": If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background. "Extended": If true, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR. Default value is true. "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority. "Resources": The list of Orthanc identifiers of interest. "Synchronous": 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. "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

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 In synchronous mode, the ZIP file containing the archive

Source code in pyorthanc/client.py
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
def post_tools_create_media_extended(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Create DICOMDIR media

    Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "Asynchronous": If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
          "Extended": If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `true`.
          "Priority": In asynchronous mode, the priority of the job. The lower the value, the higher the priority.
          "Resources": The list of Orthanc identifiers of interest.
          "Synchronous": 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.
          "Transcode": If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        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
        In synchronous mode, the ZIP file containing the archive
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/create-media-extended",
        json=json,
    )

post_tools_dicom_echo(json=None)

Trigger C-ECHO SCU

Trigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some /modalities/{id} (new in Orthanc 1.8.1) Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "AET": AET of the remote DICOM modality "CheckFind": Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the DicomEchoChecksFind configuration option. New in Orthanc 1.8.1. "Host": Host address of the remote DICOM modality (typically, an IP address) "LocalAet": Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality "Manufacturer": Manufacturer of the remote DICOM modality (check configuration option DicomModalities for possible values "Port": TCP port of the remote DICOM modality "Timeout": Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality "UseDicomTls": Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
def post_tools_dicom_echo(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Trigger C-ECHO SCU

    Trigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some `/modalities/{id}` (new in Orthanc 1.8.1)
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "AET": AET of the remote DICOM modality
          "CheckFind": Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the `DicomEchoChecksFind` configuration option. New in Orthanc 1.8.1.
          "Host": Host address of the remote DICOM modality (typically, an IP address)
          "LocalAet": Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality
          "Manufacturer": Manufacturer of the remote DICOM modality (check configuration option `DicomModalities` for possible values
          "Port": TCP port of the remote DICOM modality
          "Timeout": Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality
          "UseDicomTls": Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/dicom-echo",
        json=json,
    )

post_tools_execute_script(data=None)

Execute Lua script

Execute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible. Since Orthanc 1.5.8, this route is disabled by default and can be enabled thanks to the ExecuteLuaEnabled configuration. Tags: System

Parameters:

Name Type Description Default
data RequestData

The Lua script to be executed

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Output of the Lua script

Source code in pyorthanc/client.py
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
def post_tools_execute_script(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Execute Lua script

    Execute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible.  Since Orthanc 1.5.8, this route is disabled by default and can be enabled thanks to the `ExecuteLuaEnabled` configuration.
    Tags: System

    Parameters
    ----------
    data
        The Lua script to be executed

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Output of the Lua script
    """
    return self._post(
        route=f"{self.url}/tools/execute-script",
        data=data,
    )

post_tools_find(json=None)

Look for local resources

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 Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "CaseSensitive": Enable case-sensitive search for PN value representations (defaults to configuration option CaseSensitivePN) "Expand": Also retrieve the content of the matching resources, not only their Orthanc identifiers "Full": If set to true, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value) "Labels": List of strings specifying which labels to look for in the resources (new in Orthanc 1.12.0) "LabelsConstraint": Constraint on the labels, can be All, Any, or None (defaults to All, new in Orthanc 1.12.0) "Level": Level of the query (Patient, Study, Series or Instance) "Limit": Limit the number of reported resources "Query": Associative array containing the filter on the values of the DICOM tags "RequestedTags": A list of DICOM tags to include in the response (applicable only if "Expand" is set to true). The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0. "Short": If set to true, report the DICOM tags in hexadecimal format "Since": Show only the resources since the provided index (in conjunction with Limit)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing either the Orthanc identifiers, or detailed information about the reported resources (if Expand argument is true)

Source code in pyorthanc/client.py
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
def post_tools_find(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Look for local resources

    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
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "CaseSensitive": Enable case-sensitive search for PN value representations (defaults to configuration option `CaseSensitivePN`)
          "Expand": Also retrieve the content of the matching resources, not only their Orthanc identifiers
          "Full": If set to `true`, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
          "Labels": List of strings specifying which labels to look for in the resources (new in Orthanc 1.12.0)
          "LabelsConstraint": Constraint on the labels, can be `All`, `Any`, or `None` (defaults to `All`, new in Orthanc 1.12.0)
          "Level": Level of the query (`Patient`, `Study`, `Series` or `Instance`)
          "Limit": Limit the number of reported resources
          "Query": Associative array containing the filter on the values of the DICOM tags
          "RequestedTags": A list of DICOM tags to include in the response (applicable only if "Expand" is set to true).  The tags requested tags are returned in the 'RequestedTags' field in the response.  Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files.  If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
          "Short": If set to `true`, report the DICOM tags in hexadecimal format
          "Since": Show only the resources since the provided index (in conjunction with `Limit`)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing either the Orthanc identifiers, or detailed information about the reported resources (if `Expand` argument is `true`)
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/find",
        json=json,
    )

post_tools_invalid_ate_tags()

Invalidate DICOM-as-JSON summaries

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 Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
def post_tools_invalid_ate_tags(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Invalidate DICOM-as-JSON summaries

    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
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/tools/invalid_ate-tags",
    )

post_tools_lookup(data=None)

Look for DICOM identifiers

This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources Tags: System

Parameters:

Name Type Description Default
data RequestData

The DICOM identifier of interest (i.e. the value of PatientID, StudyInstanceUID, SeriesInstanceUID, or SOPInstanceUID)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing a list of matching Orthanc resources, each item in the list corresponding to a JSON object with the fields Type, ID and Path identifying one DICOM resource that is stored by Orthanc

Source code in pyorthanc/client.py
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
def post_tools_lookup(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Look for DICOM identifiers

    This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources
    Tags: System

    Parameters
    ----------
    data
        The DICOM identifier of interest (i.e. the value of `PatientID`, `StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`)

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing a list of matching Orthanc resources, each item in the list corresponding to a JSON object with the fields `Type`, `ID` and `Path` identifying one DICOM resource that is stored by Orthanc
    """
    return self._post(
        route=f"{self.url}/tools/lookup",
        data=data,
    )

post_tools_reconstruct(json=None)

Reconstruct all the index

Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys: "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
def post_tools_reconstruct(
    self,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Reconstruct all the index

    Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:
          "ReconstructFiles": Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._post(
        route=f"{self.url}/tools/reconstruct",
        json=json,
    )

post_tools_reset()

Restart Orthanc

Restart Orthanc Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
def post_tools_reset(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Restart Orthanc

    Restart Orthanc
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/tools/reset",
    )

post_tools_shutdown()

Shutdown Orthanc

Shutdown Orthanc Tags: System

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
def post_tools_shutdown(
    self,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Shutdown Orthanc

    Shutdown Orthanc
    Tags: System

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._post(
        route=f"{self.url}/tools/shutdown",
    )

put_instances_id_attachments_name(id_, name, content=None, headers=None)

Set attachment

Attach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024). Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
content RequestContent
- (Content-Type: "application/octet-stream") Binary data containing the attachment
None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
def put_instances_id_attachments_name(
    self,
    id_: str,
    name: str,
    content: RequestContent = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set attachment

    Attach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
    Tags: Instances

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the instance of interest
    content
            - (Content-Type: "application/octet-stream") Binary data containing the attachment
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._put(
        route=f"{self.url}/instances/{id_}/attachments/{name}",
        content=content,
        headers=headers,
    )

put_instances_id_labels_label(id_, label)

Add label

Associate a label with a instance Tags: Instances

Parameters:

Name Type Description Default
label str

The label to be added

required
id_ str

Orthanc identifier of the instance of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
def put_instances_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Add label

    Associate a label with a instance
    Tags: Instances

    Parameters
    ----------
    label
        The label to be added
    id_
        Orthanc identifier of the instance of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/instances/{id_}/labels/{label}",
    )

put_instances_id_metadata_name(id_, name, data=None, headers=None)

Set metadata

Set the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024). Tags: Instances

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the instance of interest

required
data RequestData

String value of the metadata

None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
def put_instances_id_metadata_name(
    self,
    id_: str,
    name: str,
    data: RequestData = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set metadata

    Set the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
    Tags: Instances

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the instance of interest
    data
        String value of the metadata
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/instances/{id_}/metadata/{name}",
        data=data,
        headers=headers,
    )

put_modalities_id(id_, json=None)

Update DICOM modality

Define a new DICOM modality, or update an existing one. This change is permanent iff. DicomModalitiesInDatabase is true, otherwise it is lost at the next restart of Orthanc. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the new/updated DICOM modality

required
json Any

Dictionary with the following keys: "AET": AET of the remote DICOM modality "AllowEcho": Whether to accept C-ECHO SCU commands issued by the remote modality "AllowFind": Whether to accept C-FIND SCU commands issued by the remote modality "AllowFindWorklist": Whether to accept C-FIND SCU commands for worklists issued by the remote modality "AllowGet": Whether to accept C-GET SCU commands issued by the remote modality "AllowMove": Whether to accept C-MOVE SCU commands issued by the remote modality "AllowStorageCommitment": Whether to accept storage commitment requests issued by the remote modality "AllowStore": Whether to accept C-STORE SCU commands issued by the remote modality "AllowTranscoding": Whether to allow transcoding for operations initiated by this modality. This option applies to Orthanc C-GET SCP and to Orthanc C-STORE SCU. It only has an effect if the global option EnableTranscoding is set to true. "Host": Host address of the remote DICOM modality (typically, an IP address) "LocalAet": Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality "Manufacturer": Manufacturer of the remote DICOM modality (check configuration option DicomModalities for possible values "Port": TCP port of the remote DICOM modality "Timeout": Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality "UseDicomTls": Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
def put_modalities_id(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Update DICOM modality

    Define a new DICOM modality, or update an existing one. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the new/updated DICOM modality
    json
        Dictionary with the following keys:
          "AET": AET of the remote DICOM modality
          "AllowEcho": Whether to accept C-ECHO SCU commands issued by the remote modality
          "AllowFind": Whether to accept C-FIND SCU commands issued by the remote modality
          "AllowFindWorklist": Whether to accept C-FIND SCU commands for worklists issued by the remote modality
          "AllowGet": Whether to accept C-GET SCU commands issued by the remote modality
          "AllowMove": Whether to accept C-MOVE SCU commands issued by the remote modality
          "AllowStorageCommitment": Whether to accept storage commitment requests issued by the remote modality
          "AllowStore": Whether to accept C-STORE SCU commands issued by the remote modality
          "AllowTranscoding": Whether to allow transcoding for operations initiated by this modality. This option applies to Orthanc C-GET SCP and to Orthanc C-STORE SCU. It only has an effect if the global option `EnableTranscoding` is set to `true`.
          "Host": Host address of the remote DICOM modality (typically, an IP address)
          "LocalAet": Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality
          "Manufacturer": Manufacturer of the remote DICOM modality (check configuration option `DicomModalities` for possible values
          "Port": TCP port of the remote DICOM modality
          "Timeout": Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality
          "UseDicomTls": Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._put(
        route=f"{self.url}/modalities/{id_}",
        json=json,
    )

put_patients_id_attachments_name(id_, name, content=None, headers=None)

Set attachment

Attach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024). Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
content RequestContent
- (Content-Type: "application/octet-stream") Binary data containing the attachment
None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
def put_patients_id_attachments_name(
    self,
    id_: str,
    name: str,
    content: RequestContent = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set attachment

    Attach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
    Tags: Patients

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the patient of interest
    content
            - (Content-Type: "application/octet-stream") Binary data containing the attachment
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._put(
        route=f"{self.url}/patients/{id_}/attachments/{name}",
        content=content,
        headers=headers,
    )

put_patients_id_labels_label(id_, label)

Add label

Associate a label with a patient Tags: Patients

Parameters:

Name Type Description Default
label str

The label to be added

required
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
def put_patients_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Add label

    Associate a label with a patient
    Tags: Patients

    Parameters
    ----------
    label
        The label to be added
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/patients/{id_}/labels/{label}",
    )

put_patients_id_metadata_name(id_, name, data=None, headers=None)

Set metadata

Set the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024). Tags: Patients

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the patient of interest

required
data RequestData

String value of the metadata

None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
def put_patients_id_metadata_name(
    self,
    id_: str,
    name: str,
    data: RequestData = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set metadata

    Set the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
    Tags: Patients

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the patient of interest
    data
        String value of the metadata
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/patients/{id_}/metadata/{name}",
        data=data,
        headers=headers,
    )

put_patients_id_protected(id_)

Protect/Unprotect a patient against recycling

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 Tags: Patients

Parameters:

Name Type Description Default
id_ str

Orthanc identifier of the patient of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
def put_patients_id_protected(
    self,
    id_: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Protect/Unprotect a patient against recycling

    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
    Tags: Patients

    Parameters
    ----------
    id_
        Orthanc identifier of the patient of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/patients/{id_}/protected",
    )

put_peers_id(id_, json=None)

Update Orthanc peer

Define a new Orthanc peer, or update an existing one. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart of Orthanc. Tags: Networking

Parameters:

Name Type Description Default
id_ str

Identifier of the new/updated Orthanc peer

required
json Any

Dictionary with the following keys: "CertificateFile": SSL certificate for the HTTPS connections "CertificateKeyFile": Key file for the SSL certificate for the HTTPS connections "CertificateKeyPassword": Key password for the SSL certificate for the HTTPS connections "HttpHeaders": HTTP headers to be used for the connections to the remote peer "Password": Password for the credentials "URL": URL of the root of the REST API of the remote Orthanc peer, for instance http://localhost:8042/ "Username": Username for the credentials

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
def put_peers_id(
    self,
    id_: str,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Update Orthanc peer

    Define a new Orthanc peer, or update an existing one. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
    Tags: Networking

    Parameters
    ----------
    id_
        Identifier of the new/updated Orthanc peer
    json
        Dictionary with the following keys:
          "CertificateFile": SSL certificate for the HTTPS connections
          "CertificateKeyFile": Key file for the SSL certificate for the HTTPS connections
          "CertificateKeyPassword": Key password for the SSL certificate for the HTTPS connections
          "HttpHeaders": HTTP headers to be used for the connections to the remote peer
          "Password": Password for the credentials
          "URL": URL of the root of the REST API of the remote Orthanc peer, for instance `http://localhost:8042/`
          "Username": Username for the credentials


    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    if json is None:
        json = {}
    return self._put(
        route=f"{self.url}/peers/{id_}",
        json=json,
    )

put_series_id_attachments_name(id_, name, content=None, headers=None)

Set attachment

Attach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024). Tags: Series

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
content RequestContent
- (Content-Type: "application/octet-stream") Binary data containing the attachment
None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
def put_series_id_attachments_name(
    self,
    id_: str,
    name: str,
    content: RequestContent = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set attachment

    Attach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
    Tags: Series

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the series of interest
    content
            - (Content-Type: "application/octet-stream") Binary data containing the attachment
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._put(
        route=f"{self.url}/series/{id_}/attachments/{name}",
        content=content,
        headers=headers,
    )

put_series_id_labels_label(id_, label)

Add label

Associate a label with a series Tags: Series

Parameters:

Name Type Description Default
label str

The label to be added

required
id_ str

Orthanc identifier of the series of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
def put_series_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Add label

    Associate a label with a series
    Tags: Series

    Parameters
    ----------
    label
        The label to be added
    id_
        Orthanc identifier of the series of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/series/{id_}/labels/{label}",
    )

put_series_id_metadata_name(id_, name, data=None, headers=None)

Set metadata

Set the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024). Tags: Series

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the series of interest

required
data RequestData

String value of the metadata

None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
def put_series_id_metadata_name(
    self,
    id_: str,
    name: str,
    data: RequestData = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set metadata

    Set the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
    Tags: Series

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the series of interest
    data
        String value of the metadata
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/series/{id_}/metadata/{name}",
        data=data,
        headers=headers,
    )

put_studies_id_attachments_name(id_, name, content=None, headers=None)

Set attachment

Attach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024). Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the attachment, or its index (cf. UserContentType configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
content RequestContent
- (Content-Type: "application/octet-stream") Binary data containing the attachment
None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

Empty JSON object in the case of a success

Source code in pyorthanc/client.py
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
def put_studies_id_attachments_name(
    self,
    id_: str,
    name: str,
    content: RequestContent = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set attachment

    Attach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
    Tags: Studies

    Parameters
    ----------
    name
        The name of the attachment, or its index (cf. `UserContentType` configuration option)
    id_
        Orthanc identifier of the study of interest
    content
            - (Content-Type: "application/octet-stream") Binary data containing the attachment
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the attachment, if this is not the first time this attachment is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        Empty JSON object in the case of a success
    """
    return self._put(
        route=f"{self.url}/studies/{id_}/attachments/{name}",
        content=content,
        headers=headers,
    )

put_studies_id_labels_label(id_, label)

Add label

Associate a label with a study Tags: Studies

Parameters:

Name Type Description Default
label str

The label to be added

required
id_ str

Orthanc identifier of the study of interest

required

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
def put_studies_id_labels_label(
    self,
    id_: str,
    label: str,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Add label

    Associate a label with a study
    Tags: Studies

    Parameters
    ----------
    label
        The label to be added
    id_
        Orthanc identifier of the study of interest

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/studies/{id_}/labels/{label}",
    )

put_studies_id_metadata_name(id_, name, data=None, headers=None)

Set metadata

Set the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024). Tags: Studies

Parameters:

Name Type Description Default
name str

The name of the metadata, or its index (cf. UserMetadata configuration option)

required
id_ str

Orthanc identifier of the study of interest

required
data RequestData

String value of the metadata

None
headers HeaderTypes

Dictionary of optional headers: "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
def put_studies_id_metadata_name(
    self,
    id_: str,
    name: str,
    data: RequestData = None,
    headers: HeaderTypes = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set metadata

    Set the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
    Tags: Studies

    Parameters
    ----------
    name
        The name of the metadata, or its index (cf. `UserMetadata` configuration option)
    id_
        Orthanc identifier of the study of interest
    data
        String value of the metadata
    headers
        Dictionary of optional headers:
            "If-Match" (str): Revision of the metadata, if this is not the first time this metadata is set.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/studies/{id_}/metadata/{name}",
        data=data,
        headers=headers,
    )

put_tools_accepted_transfer_syntaxes(data=None, json=None)

Set accepted transfer syntaxes

Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP Tags: System

Parameters:

Name Type Description Default
json Any

Dictionary with the following keys:

None
data RequestData

UID of the transfer syntax to be accepted. Wildcards ? and * are accepted.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]

JSON array containing the now-accepted transfer syntax UIDs

Source code in pyorthanc/client.py
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
def put_tools_accepted_transfer_syntaxes(
    self,
    data: RequestData = None,
    json: Any = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set accepted transfer syntaxes

    Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP
    Tags: System

    Parameters
    ----------
    json
        Dictionary with the following keys:

    data
        UID of the transfer syntax to be accepted. Wildcards `?` and `*` are accepted.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
        JSON array containing the now-accepted transfer syntax UIDs
    """
    if json is None:
        json = {}
    return self._put(
        route=f"{self.url}/tools/accepted-transfer-syntaxes",
        data=data,
        json=json,
    )

put_tools_default_encoding(data=None)

Set default encoding

Change the default encoding that is used by Orthanc if parsing a DICOM instance without the SpecificCharacterEncoding tag, or during C-FIND. This corresponds to the configuration option DefaultEncoding. Tags: System

Parameters:

Name Type Description Default
data RequestData

The name of the encoding. Check out configuration option DefaultEncoding for the allowed values.

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
def put_tools_default_encoding(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set default encoding

    Change the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.
    Tags: System

    Parameters
    ----------
    data
        The name of the encoding. Check out configuration option `DefaultEncoding` for the allowed values.

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/default-encoding",
        data=data,
    )

put_tools_log_level(data=None)

Set main log level

Set the main log level of Orthanc Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
def put_tools_log_level(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set main log level

    Set the main log level of Orthanc
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level",
        data=data,
    )

put_tools_log_level_dicom(data=None)

Set log level for dicom

Set the log level of the log category dicom Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
def put_tools_log_level_dicom(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `dicom`

    Set the log level of the log category `dicom`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-dicom",
        data=data,
    )

put_tools_log_level_generic(data=None)

Set log level for generic

Set the log level of the log category generic Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
def put_tools_log_level_generic(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `generic`

    Set the log level of the log category `generic`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-generic",
        data=data,
    )

put_tools_log_level_http(data=None)

Set log level for http

Set the log level of the log category http Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
def put_tools_log_level_http(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `http`

    Set the log level of the log category `http`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-http",
        data=data,
    )

put_tools_log_level_jobs(data=None)

Set log level for jobs

Set the log level of the log category jobs Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
def put_tools_log_level_jobs(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `jobs`

    Set the log level of the log category `jobs`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-jobs",
        data=data,
    )

put_tools_log_level_lua(data=None)

Set log level for lua

Set the log level of the log category lua Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
def put_tools_log_level_lua(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `lua`

    Set the log level of the log category `lua`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-lua",
        data=data,
    )

put_tools_log_level_plugins(data=None)

Set log level for plugins

Set the log level of the log category plugins Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
def put_tools_log_level_plugins(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `plugins`

    Set the log level of the log category `plugins`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-plugins",
        data=data,
    )

put_tools_log_level_sqlite(data=None)

Set log level for sqlite

Set the log level of the log category sqlite Tags: Logs

Parameters:

Name Type Description Default
data RequestData

Possible values: default, verbose or trace

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
def put_tools_log_level_sqlite(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set log level for `sqlite`

    Set the log level of the log category `sqlite`
    Tags: Logs

    Parameters
    ----------
    data
        Possible values: `default`, `verbose` or `trace`

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/log-level-sqlite",
        data=data,
    )

put_tools_metrics(data=None)

Enable collection of metrics

Enable or disable the collection and publication of metrics at /tools/metrics-prometheus Tags: System

Parameters:

Name Type Description Default
data RequestData

1 if metrics are collected, 0 if metrics are disabled

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
def put_tools_metrics(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Enable collection of metrics

    Enable or disable the collection and publication of metrics at `/tools/metrics-prometheus`
    Tags: System

    Parameters
    ----------
    data
        `1` if metrics are collected, `0` if metrics are disabled

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/metrics",
        data=data,
    )

put_tools_unknown_sop_class_accepted(data=None)

Set unknown SOP class accepted

Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID Tags: System

Parameters:

Name Type Description Default
data RequestData

1 if accepted, 0 if not accepted

None

Returns:

Type Description
Union[Dict, List, str, bytes, int, Response]
Source code in pyorthanc/client.py
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
def put_tools_unknown_sop_class_accepted(
    self,
    data: RequestData = None,
) -> Union[Dict, List, str, bytes, int, httpx.Response]:
    """Set unknown SOP class accepted

    Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID
    Tags: System

    Parameters
    ----------
    data
        `1` if accepted, `0` if not accepted

    Returns
    -------
    Union[Dict, List, str, bytes, int, httpx.Response]
    """
    return self._put(
        route=f"{self.url}/tools/unknown-sop-class-accepted",
        data=data,
    )

setup_credentials(username, password)

Set credentials needed for HTTP requests

Source code in pyorthanc/client.py
54
55
56
def setup_credentials(self, username: str, password: str) -> None:
    """Set credentials needed for HTTP requests"""
    self._auth = httpx.BasicAuth(username, password)