Mercurial > hg > orthanc-book
comparison Sphinx/source/users/rest-cheatsheet.csv @ 577:7d27154e70f9
cheatsheet and full openapi
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 30 Dec 2020 07:55:12 +0100 |
parents | |
children | 4ca0061637ac |
comparison
equal
deleted
inserted
replaced
576:28a09c734c90 | 577:7d27154e70f9 |
---|---|
1 Path,GET,POST,DELETE,PUT,Summary | |
2 ``/changes``,`GET <https://api.orthanc-server.com/index.html#tag/Tracking-changes/paths/~1changes/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Tracking-changes/paths/~1changes/delete>`__,,List changes | |
3 ``/exports``,`GET <https://api.orthanc-server.com/index.html#tag/Tracking-changes/paths/~1exports/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Tracking-changes/paths/~1exports/delete>`__,,List exports | |
4 ``/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances/post>`__,,,List the available instances | |
5 ``/instances/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}/delete>`__,,Get information about some instance | |
6 ``/instances/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Instance/paths/~1instances~1{id}~1anonymize/post>`__,,,Anonymize instance | |
7 ``/instances/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments/get>`__,,,,List attachments | |
8 ``/instances/{id}/attachments/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1instances~1{id}~1attachments~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}/put>`__,List operations on attachments | |
9 ``/instances/{id}/attachments/{name}/compress``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1compress/post>`__,,,Compress attachment | |
10 ``/instances/{id}/attachments/{name}/compressed-data``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1compressed-data/get>`__,,,,Get attachment (no decompression) | |
11 ``/instances/{id}/attachments/{name}/compressed-md5``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1compressed-md5/get>`__,,,,Get MD5 of attachment on disk | |
12 ``/instances/{id}/attachments/{name}/compressed-size``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1compressed-size/get>`__,,,,Get size of attachment on disk | |
13 ``/instances/{id}/attachments/{name}/data``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1data/get>`__,,,,Get attachment | |
14 ``/instances/{id}/attachments/{name}/is-compressed``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1is-compressed/get>`__,,,,Is attachment compressed? | |
15 ``/instances/{id}/attachments/{name}/md5``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1md5/get>`__,,,,Get MD5 of attachment | |
16 ``/instances/{id}/attachments/{name}/size``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1size/get>`__,,,,Get size of attachment | |
17 ``/instances/{id}/attachments/{name}/uncompress``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1uncompress/post>`__,,,Uncompress attachment | |
18 ``/instances/{id}/attachments/{name}/verify-md5``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1verify-md5/post>`__,,,Verify attachment | |
19 ``/instances/{id}/content``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1content/get>`__,,,,Get raw tag | |
20 ``/instances/{id}/export``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1export/post>`__,,,Write DICOM onto filesystem | |
21 ``/instances/{id}/file``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1file/get>`__,,,,Download DICOM | |
22 ``/instances/{id}/frames``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames/get>`__,,,,List available frames | |
23 ``/instances/{id}/frames/{frame}``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1instances~1{id}~1frames~1{frame}/get>`__,,,,List operations | |
24 ``/instances/{id}/frames/{frame}/image-int16``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1image-int16/get>`__,,,,Decode a frame (int16) | |
25 ``/instances/{id}/frames/{frame}/image-uint16``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1image-uint16/get>`__,,,,Decode a frame (uint16) | |
26 ``/instances/{id}/frames/{frame}/image-uint8``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1image-uint8/get>`__,,,,Decode a frame (uint8) | |
27 ``/instances/{id}/frames/{frame}/matlab``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1matlab/get>`__,,,,Decode frame for Matlab | |
28 ``/instances/{id}/frames/{frame}/preview``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1preview/get>`__,,,,Decode a frame (preview) | |
29 ``/instances/{id}/frames/{frame}/raw``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1raw/get>`__,,,,Access raw frame | |
30 ``/instances/{id}/frames/{frame}/raw.gz``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1raw.gz/get>`__,,,,Access raw frame (compressed) | |
31 ``/instances/{id}/frames/{frame}/rendered``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1rendered/get>`__,,,,Render a frame | |
32 ``/instances/{id}/header``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1header/get>`__,,,,Get DICOM meta-header | |
33 ``/instances/{id}/image-int16``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1image-int16/get>`__,,,,Decode an image (int16) | |
34 ``/instances/{id}/image-uint16``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1image-uint16/get>`__,,,,Decode an image (uint16) | |
35 ``/instances/{id}/image-uint8``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1image-uint8/get>`__,,,,Decode an image (uint8) | |
36 ``/instances/{id}/matlab``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1matlab/get>`__,,,,Decode frame for Matlab | |
37 ``/instances/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1metadata/get>`__,,,,List metadata | |
38 ``/instances/{id}/metadata/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1metadata~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1metadata~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1metadata~1{name}/put>`__,Get metadata | |
39 ``/instances/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Instance/paths/~1instances~1{id}~1modify/post>`__,,,Modify instance | |
40 ``/instances/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1module/get>`__,,,,Get instance module | |
41 ``/instances/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1patient/get>`__,,,,Get parent patient | |
42 ``/instances/{id}/pdf``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1pdf/get>`__,,,,Get embedded PDF | |
43 ``/instances/{id}/preview``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1preview/get>`__,,,,Decode an image (preview) | |
44 ``/instances/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1reconstruct/post>`__,,,Reconstruct tags of instance | |
45 ``/instances/{id}/rendered``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1rendered/get>`__,,,,Render an image | |
46 ``/instances/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1series/get>`__,,,,Get parent series | |
47 ``/instances/{id}/simplified-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1simplified-tags/get>`__,,,,Get human-readable tags | |
48 ``/instances/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1statistics/get>`__,,,,Get instance statistics | |
49 ``/instances/{id}/study``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1study/get>`__,,,,Get parent study | |
50 ``/instances/{id}/tags``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1tags/get>`__,,,,Get DICOM tags | |
51 ``/jobs``,`GET <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs/get>`__,,,,List jobs | |
52 ``/jobs/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}/get>`__,,,,Get job | |
53 ``/jobs/{id}/cancel``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1cancel/post>`__,,,Cancel job | |
54 ``/jobs/{id}/pause``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1pause/post>`__,,,Pause job | |
55 ``/jobs/{id}/resubmit``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1resubmit/post>`__,,,Resubmit job | |
56 ``/jobs/{id}/resume``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1resume/post>`__,,,Resume job | |
57 ``/jobs/{id}/{key}``,`GET <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1{key}/get>`__,,,,Get job output | |
58 ``/modalities``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities/get>`__,,,,List DICOM modalities | |
59 ``/modalities/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}/put>`__,List operations on modality | |
60 ``/modalities/{id}/configuration``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1configuration/get>`__,,,,Get modality configuration | |
61 ``/modalities/{id}/echo``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1echo/post>`__,,,Trigger C-ECHO SCU | |
62 ``/modalities/{id}/find``,,`(post) <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find/post>`__,,,*(deprecated)* Hierarchical C-FIND SCU | |
63 ``/modalities/{id}/find-instance``,,`(post) <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find-instance/post>`__,,,*(deprecated)* C-FIND SCU for instances | |
64 ``/modalities/{id}/find-patient``,,`(post) <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find-patient/post>`__,,,*(deprecated)* C-FIND SCU for patients | |
65 ``/modalities/{id}/find-series``,,`(post) <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find-series/post>`__,,,*(deprecated)* C-FIND SCU for series | |
66 ``/modalities/{id}/find-study``,,`(post) <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find-study/post>`__,,,*(deprecated)* C-FIND SCU for studies | |
67 ``/modalities/{id}/find-worklist``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find-worklist/post>`__,,,C-FIND SCU for worklist | |
68 ``/modalities/{id}/move``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1move/post>`__,,,Trigger C-MOVE SCU | |
69 ``/modalities/{id}/query``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1query/post>`__,,,Trigger C-FIND SCU | |
70 ``/modalities/{id}/storage-commitment``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1storage-commitment/post>`__,,,Trigger storage commitment request | |
71 ``/modalities/{id}/store``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1store/post>`__,,,Trigger C-STORE SCU | |
72 ``/modalities/{id}/store-straight``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1store-straight/post>`__,,,Straight C-STORE SCU | |
73 ``/patients``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients/get>`__,,,,List the available patients | |
74 ``/patients/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}/delete>`__,,Get information about some patient | |
75 ``/patients/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1anonymize/post>`__,,,Anonymize patient | |
76 ``/patients/{id}/archive``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1archive/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1archive/post>`__,,,Create ZIP archive | |
77 ``/patients/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments/get>`__,,,,List attachments | |
78 ``/patients/{id}/attachments/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1patients~1{id}~1attachments~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}/put>`__,List operations on attachments | |
79 ``/patients/{id}/attachments/{name}/compress``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1compress/post>`__,,,Compress attachment | |
80 ``/patients/{id}/attachments/{name}/compressed-data``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1compressed-data/get>`__,,,,Get attachment (no decompression) | |
81 ``/patients/{id}/attachments/{name}/compressed-md5``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1compressed-md5/get>`__,,,,Get MD5 of attachment on disk | |
82 ``/patients/{id}/attachments/{name}/compressed-size``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1compressed-size/get>`__,,,,Get size of attachment on disk | |
83 ``/patients/{id}/attachments/{name}/data``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1data/get>`__,,,,Get attachment | |
84 ``/patients/{id}/attachments/{name}/is-compressed``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1is-compressed/get>`__,,,,Is attachment compressed? | |
85 ``/patients/{id}/attachments/{name}/md5``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1md5/get>`__,,,,Get MD5 of attachment | |
86 ``/patients/{id}/attachments/{name}/size``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1size/get>`__,,,,Get size of attachment | |
87 ``/patients/{id}/attachments/{name}/uncompress``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1uncompress/post>`__,,,Uncompress attachment | |
88 ``/patients/{id}/attachments/{name}/verify-md5``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1verify-md5/post>`__,,,Verify attachment | |
89 ``/patients/{id}/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1instances/get>`__,,,,Get child instances | |
90 ``/patients/{id}/instances-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1instances-tags/get>`__,,,,Get tags of instances | |
91 ``/patients/{id}/media``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1media/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1media/post>`__,,,Create DICOMDIR media | |
92 ``/patients/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1metadata/get>`__,,,,List metadata | |
93 ``/patients/{id}/metadata/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1metadata~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1metadata~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1metadata~1{name}/put>`__,Get metadata | |
94 ``/patients/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1modify/post>`__,,,Modify patient | |
95 ``/patients/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1module/get>`__,,,,Get patient module | |
96 ``/patients/{id}/protected``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1protected/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1protected/put>`__,Is the patient protected against recycling? | |
97 ``/patients/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1reconstruct/post>`__,,,Reconstruct tags of patient | |
98 ``/patients/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1series/get>`__,,,,Get child series | |
99 ``/patients/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1shared-tags/get>`__,,,,Get shared tags | |
100 ``/patients/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1statistics/get>`__,,,,Get patient statistics | |
101 ``/patients/{id}/studies``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1studies/get>`__,,,,Get child studies | |
102 ``/peers``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers/get>`__,,,,List Orthanc peers | |
103 ``/peers/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}/put>`__,List operations on peer | |
104 ``/peers/{id}/configuration``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1configuration/get>`__,,,,Get peer configuration | |
105 ``/peers/{id}/store``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1store/post>`__,,,Send to Orthanc peer | |
106 ``/peers/{id}/system``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1system/get>`__,,,,Get peer system information | |
107 ``/plugins``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1plugins/get>`__,,,,List plugins | |
108 ``/plugins/explorer.js``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1plugins~1explorer.js/get>`__,,,,JavaScript extensions to Orthanc Explorer | |
109 ``/plugins/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1plugins~1{id}/get>`__,,,,Get plugin | |
110 ``/queries``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries/get>`__,,,,List query/retrieve operations | |
111 ``/queries/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}/delete>`__,,List operations on a query | |
112 ``/queries/{id}/answers``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers/get>`__,,,,List answers to a query | |
113 ``/queries/{id}/answers/{index}``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers~1{index}/get>`__,,,,List operations on an answer | |
114 ``/queries/{id}/answers/{index}/content``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers~1{index}~1content/get>`__,,,,Get one answer | |
115 ``/queries/{id}/answers/{index}/query-instances``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers~1{index}~1query-instances/post>`__,,,Query the child instances of an answer | |
116 ``/queries/{id}/answers/{index}/query-series``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers~1{index}~1query-series/post>`__,,,Query the child series of an answer | |
117 ``/queries/{id}/answers/{index}/query-studies``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers~1{index}~1query-studies/post>`__,,,Query the child studies of an answer | |
118 ``/queries/{id}/answers/{index}/retrieve``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers~1{index}~1retrieve/post>`__,,,Retrieve one answer | |
119 ``/queries/{id}/level``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1level/get>`__,,,,Get level of original query | |
120 ``/queries/{id}/modality``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1modality/get>`__,,,,Get modality of original query | |
121 ``/queries/{id}/query``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1query/get>`__,,,,Get original query arguments | |
122 ``/queries/{id}/retrieve``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1retrieve/post>`__,,,Retrieve all answers | |
123 ``/series``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series/get>`__,,,,List the available series | |
124 ``/series/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}/delete>`__,,Get information about some series | |
125 ``/series/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1anonymize/post>`__,,,Anonymize series | |
126 ``/series/{id}/archive``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1archive/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1archive/post>`__,,,Create ZIP archive | |
127 ``/series/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments/get>`__,,,,List attachments | |
128 ``/series/{id}/attachments/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1series~1{id}~1attachments~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}/put>`__,List operations on attachments | |
129 ``/series/{id}/attachments/{name}/compress``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1compress/post>`__,,,Compress attachment | |
130 ``/series/{id}/attachments/{name}/compressed-data``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1compressed-data/get>`__,,,,Get attachment (no decompression) | |
131 ``/series/{id}/attachments/{name}/compressed-md5``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1compressed-md5/get>`__,,,,Get MD5 of attachment on disk | |
132 ``/series/{id}/attachments/{name}/compressed-size``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1compressed-size/get>`__,,,,Get size of attachment on disk | |
133 ``/series/{id}/attachments/{name}/data``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1data/get>`__,,,,Get attachment | |
134 ``/series/{id}/attachments/{name}/is-compressed``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1is-compressed/get>`__,,,,Is attachment compressed? | |
135 ``/series/{id}/attachments/{name}/md5``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1md5/get>`__,,,,Get MD5 of attachment | |
136 ``/series/{id}/attachments/{name}/size``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1size/get>`__,,,,Get size of attachment | |
137 ``/series/{id}/attachments/{name}/uncompress``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1uncompress/post>`__,,,Uncompress attachment | |
138 ``/series/{id}/attachments/{name}/verify-md5``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1verify-md5/post>`__,,,Verify attachment | |
139 ``/series/{id}/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1instances/get>`__,,,,Get child instances | |
140 ``/series/{id}/instances-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1instances-tags/get>`__,,,,Get tags of instances | |
141 ``/series/{id}/media``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1media/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1media/post>`__,,,Create DICOMDIR media | |
142 ``/series/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1metadata/get>`__,,,,List metadata | |
143 ``/series/{id}/metadata/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1metadata~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1metadata~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1metadata~1{name}/put>`__,Get metadata | |
144 ``/series/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1modify/post>`__,,,Modify series | |
145 ``/series/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1module/get>`__,,,,Get series module | |
146 ``/series/{id}/ordered-slices``,`(get) <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1ordered-slices/get>`__,,,,*(deprecated)* Order the slices | |
147 ``/series/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1patient/get>`__,,,,Get parent patient | |
148 ``/series/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1reconstruct/post>`__,,,Reconstruct tags of series | |
149 ``/series/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1shared-tags/get>`__,,,,Get shared tags | |
150 ``/series/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1statistics/get>`__,,,,Get series statistics | |
151 ``/series/{id}/study``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1study/get>`__,,,,Get parent study | |
152 ``/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1statistics/get>`__,,,,Get database statistics | |
153 ``/storage-commitment/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1storage-commitment~1{id}/get>`__,,,,Get storage commitment report | |
154 ``/storage-commitment/{id}/remove``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1storage-commitment~1{id}~1remove/post>`__,,,Remove after storage commitment | |
155 ``/studies``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies/get>`__,,,,List the available studies | |
156 ``/studies/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}/delete>`__,,Get information about some study | |
157 ``/studies/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1anonymize/post>`__,,,Anonymize study | |
158 ``/studies/{id}/archive``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1archive/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1archive/post>`__,,,Create ZIP archive | |
159 ``/studies/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments/get>`__,,,,List attachments | |
160 ``/studies/{id}/attachments/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1studies~1{id}~1attachments~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}/put>`__,List operations on attachments | |
161 ``/studies/{id}/attachments/{name}/compress``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1compress/post>`__,,,Compress attachment | |
162 ``/studies/{id}/attachments/{name}/compressed-data``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1compressed-data/get>`__,,,,Get attachment (no decompression) | |
163 ``/studies/{id}/attachments/{name}/compressed-md5``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1compressed-md5/get>`__,,,,Get MD5 of attachment on disk | |
164 ``/studies/{id}/attachments/{name}/compressed-size``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1compressed-size/get>`__,,,,Get size of attachment on disk | |
165 ``/studies/{id}/attachments/{name}/data``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1data/get>`__,,,,Get attachment | |
166 ``/studies/{id}/attachments/{name}/is-compressed``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1is-compressed/get>`__,,,,Is attachment compressed? | |
167 ``/studies/{id}/attachments/{name}/md5``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1md5/get>`__,,,,Get MD5 of attachment | |
168 ``/studies/{id}/attachments/{name}/size``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1size/get>`__,,,,Get size of attachment | |
169 ``/studies/{id}/attachments/{name}/uncompress``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1uncompress/post>`__,,,Uncompress attachment | |
170 ``/studies/{id}/attachments/{name}/verify-md5``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1verify-md5/post>`__,,,Verify attachment | |
171 ``/studies/{id}/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1instances/get>`__,,,,Get child instances | |
172 ``/studies/{id}/instances-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1instances-tags/get>`__,,,,Get tags of instances | |
173 ``/studies/{id}/media``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1media/get>`__,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1media/post>`__,,,Create DICOMDIR media | |
174 ``/studies/{id}/merge``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1merge/post>`__,,,Merge study | |
175 ``/studies/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1metadata/get>`__,,,,List metadata | |
176 ``/studies/{id}/metadata/{name}``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1metadata~1{name}/get>`__,,`DELETE <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1metadata~1{name}/delete>`__,`PUT <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1metadata~1{name}/put>`__,Get metadata | |
177 ``/studies/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1modify/post>`__,,,Modify study | |
178 ``/studies/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1module/get>`__,,,,Get study module | |
179 ``/studies/{id}/module-patient``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1module-patient/get>`__,,,,Get patient module of study | |
180 ``/studies/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1patient/get>`__,,,,Get parent patient | |
181 ``/studies/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1reconstruct/post>`__,,,Reconstruct tags of study | |
182 ``/studies/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1series/get>`__,,,,Get child series | |
183 ``/studies/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1shared-tags/get>`__,,,,Get shared tags | |
184 ``/studies/{id}/split``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1split/post>`__,,,Split study | |
185 ``/studies/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1statistics/get>`__,,,,Get study statistics | |
186 ``/system``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1system/get>`__,,,,Get system information | |
187 ``/tools``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1tools/get>`__,,,,List operations | |
188 ``/tools/create-archive``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-archive/post>`__,,,Create ZIP archive | |
189 ``/tools/create-dicom``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-dicom/post>`__,,,Create one DICOM instance | |
190 ``/tools/create-media``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-media/post>`__,,,Create DICOMDIR media | |
191 ``/tools/create-media-extended``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-media-extended/post>`__,,,Create DICOMDIR media | |
192 ``/tools/default-encoding``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1default-encoding/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1default-encoding/put>`__,Get default encoding | |
193 ``/tools/dicom-conformance``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1dicom-conformance/get>`__,,,,Get DICOM conformance | |
194 ``/tools/dicom-echo``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1dicom-echo/post>`__,,,Trigger C-ECHO SCU | |
195 ``/tools/execute-script``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1execute-script/post>`__,,,Execute Lua script | |
196 ``/tools/find``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1find/post>`__,,,Look for local resources | |
197 ``/tools/generate-uid``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1generate-uid/get>`__,,,,Generate an identifier | |
198 ``/tools/invalidate-tags``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1invalidate-tags/post>`__,,,Invalidate DICOM-as-JSON summaries | |
199 ``/tools/log-level``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level/put>`__,Get main log level | |
200 ``/tools/log-level-dicom``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-dicom/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-dicom/put>`__,Get log level for `dicom` | |
201 ``/tools/log-level-generic``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-generic/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-generic/put>`__,Get log level for `generic` | |
202 ``/tools/log-level-http``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-http/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-http/put>`__,Get log level for `http` | |
203 ``/tools/log-level-jobs``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-jobs/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-jobs/put>`__,Get log level for `jobs` | |
204 ``/tools/log-level-lua``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-lua/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-lua/put>`__,Get log level for `lua` | |
205 ``/tools/log-level-plugins``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-plugins/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-plugins/put>`__,Get log level for `plugins` | |
206 ``/tools/log-level-sqlite``,`GET <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-sqlite/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/Logs/paths/~1tools~1log-level-sqlite/put>`__,Get log level for `sqlite` | |
207 ``/tools/lookup``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1lookup/post>`__,,,Look for DICOM identifiers | |
208 ``/tools/metrics``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1metrics/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1metrics/put>`__,Are metrics collected? | |
209 ``/tools/metrics-prometheus``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1metrics-prometheus/get>`__,,,,Get usage metrics | |
210 ``/tools/now``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1now/get>`__,,,,Get UTC time | |
211 ``/tools/now-local``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1now-local/get>`__,,,,Get local time | |
212 ``/tools/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1reconstruct/post>`__,,,Reconstruct all the index | |
213 ``/tools/reset``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1reset/post>`__,,,Restart Orthanc | |
214 ``/tools/shutdown``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1shutdown/post>`__,,,Shutdown Orthanc |