annotate Sphinx/source/users/rest-cheatsheet.csv @ 836:a9c35bf108fa

stable age ref
author Alain Mazy <am@osimis.io>
date Tue, 03 May 2022 14:13:57 +0200
parents 01fa632daae9
children c29ac12e3160
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
1 Path,GET,POST,DELETE,PUT,Summary
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
6 ``/instances/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1anonymize/post>`__,,,Anonymize instance
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
7 ``/instances/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments/get>`__,,,,List attachments
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
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
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
14 ``/instances/{id}/attachments/{name}/info``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1attachments~1{name}~1info/get>`__,,,,Get info about the attachment
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
15 ``/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?
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
16 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
17 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
18 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
19 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
20 ``/instances/{id}/content``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1content/get>`__,,,,Get raw tag
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
21 ``/instances/{id}/export``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1export/post>`__,,,Write DICOM onto filesystem
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
22 ``/instances/{id}/file``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1file/get>`__,,,,Download DICOM
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
23 ``/instances/{id}/frames``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames/get>`__,,,,List available frames
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
24 ``/instances/{id}/frames/{frame}``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1instances~1{id}~1frames~1{frame}/get>`__,,,,List operations
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
25 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
26 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
27 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
28 ``/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
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
29 ``/instances/{id}/frames/{frame}/numpy``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1frames~1{frame}~1numpy/get>`__,,,,Decode frame for numpy
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
30 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
31 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
32 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
33 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
34 ``/instances/{id}/header``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1header/get>`__,,,,Get DICOM meta-header
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
35 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
36 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
37 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
38 ``/instances/{id}/matlab``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1matlab/get>`__,,,,Decode frame for Matlab
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
39 ``/instances/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1metadata/get>`__,,,,List metadata
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
40 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
41 ``/instances/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1modify/post>`__,,,Modify instance
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
42 ``/instances/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1module/get>`__,,,,Get instance module
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
43 ``/instances/{id}/numpy``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1numpy/get>`__,,,,Decode instance for numpy
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
44 ``/instances/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1patient/get>`__,,,,Get parent patient
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
45 ``/instances/{id}/pdf``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1pdf/get>`__,,,,Get embedded PDF
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
46 ``/instances/{id}/preview``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1preview/get>`__,,,,Decode an image (preview)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
47 ``/instances/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1reconstruct/post>`__,,,Reconstruct tags of instance
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
48 ``/instances/{id}/rendered``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1rendered/get>`__,,,,Render an image
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
49 ``/instances/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1series/get>`__,,,,Get parent series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
50 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
51 ``/instances/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1statistics/get>`__,,,,Get instance statistics
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
52 ``/instances/{id}/study``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1study/get>`__,,,,Get parent study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
53 ``/instances/{id}/tags``,`GET <https://api.orthanc-server.com/index.html#tag/Instances/paths/~1instances~1{id}~1tags/get>`__,,,,Get DICOM tags
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
54 ``/jobs``,`GET <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs/get>`__,,,,List jobs
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
55 ``/jobs/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}/get>`__,,,,Get job
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
56 ``/jobs/{id}/cancel``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1cancel/post>`__,,,Cancel job
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
57 ``/jobs/{id}/pause``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1pause/post>`__,,,Pause job
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
58 ``/jobs/{id}/resubmit``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1resubmit/post>`__,,,Resubmit job
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
59 ``/jobs/{id}/resume``,,`POST <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1resume/post>`__,,,Resume job
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
60 ``/jobs/{id}/{key}``,`GET <https://api.orthanc-server.com/index.html#tag/Jobs/paths/~1jobs~1{id}~1{key}/get>`__,,,,Get job output
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
61 ``/modalities``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities/get>`__,,,,List DICOM modalities
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
62 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
63 ``/modalities/{id}/configuration``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1configuration/get>`__,,,,Get modality configuration
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
64 ``/modalities/{id}/echo``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1echo/post>`__,,,Trigger C-ECHO SCU
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
65 ``/modalities/{id}/find``,,`(post) <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1find/post>`__,,,*(deprecated)* Hierarchical C-FIND SCU
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
66 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
67 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
68 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
69 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
70 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
71 ``/modalities/{id}/move``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1move/post>`__,,,Trigger C-MOVE SCU
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
72 ``/modalities/{id}/query``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1query/post>`__,,,Trigger C-FIND SCU
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
73 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
74 ``/modalities/{id}/store``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1modalities~1{id}~1store/post>`__,,,Trigger C-STORE SCU
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
75 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
76 ``/patients``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients/get>`__,,,,List the available patients
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
77 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
78 ``/patients/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1anonymize/post>`__,,,Anonymize patient
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
79 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
80 ``/patients/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments/get>`__,,,,List attachments
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
81 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
82 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
83 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
84 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
85 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
86 ``/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
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
87 ``/patients/{id}/attachments/{name}/info``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1attachments~1{name}~1info/get>`__,,,,Get info about the attachment
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
88 ``/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?
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
89 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
90 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
91 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
92 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
93 ``/patients/{id}/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1instances/get>`__,,,,Get child instances
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
94 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
95 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
96 ``/patients/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1metadata/get>`__,,,,List metadata
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
97 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
98 ``/patients/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1modify/post>`__,,,Modify patient
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
99 ``/patients/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1module/get>`__,,,,Get patient module
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
100 ``/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?
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
101 ``/patients/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1reconstruct/post>`__,,,Reconstruct tags of patient
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
102 ``/patients/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1series/get>`__,,,,Get child series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
103 ``/patients/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1shared-tags/get>`__,,,,Get shared tags
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
104 ``/patients/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1statistics/get>`__,,,,Get patient statistics
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
105 ``/patients/{id}/studies``,`GET <https://api.orthanc-server.com/index.html#tag/Patients/paths/~1patients~1{id}~1studies/get>`__,,,,Get child studies
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
106 ``/peers``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers/get>`__,,,,List Orthanc peers
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
107 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
108 ``/peers/{id}/configuration``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1configuration/get>`__,,,,Get peer configuration
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
109 ``/peers/{id}/store``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1store/post>`__,,,Send to Orthanc peer
618
cfeb018b9150 Orthanc 1.9.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 607
diff changeset
110 ``/peers/{id}/store-straight``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1store-straight/post>`__,,,Straight store to peer
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
111 ``/peers/{id}/system``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1peers~1{id}~1system/get>`__,,,,Get peer system information
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
112 ``/plugins``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1plugins/get>`__,,,,List plugins
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
113 ``/plugins/explorer.js``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1plugins~1explorer.js/get>`__,,,,JavaScript extensions to Orthanc Explorer
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
114 ``/plugins/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1plugins~1{id}/get>`__,,,,Get plugin
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
115 ``/queries``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries/get>`__,,,,List query/retrieve operations
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
116 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
117 ``/queries/{id}/answers``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1answers/get>`__,,,,List answers to a query
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
118 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
119 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
120 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
121 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
122 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
123 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
124 ``/queries/{id}/level``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1level/get>`__,,,,Get level of original query
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
125 ``/queries/{id}/modality``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1modality/get>`__,,,,Get modality of original query
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
126 ``/queries/{id}/query``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1query/get>`__,,,,Get original query arguments
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
127 ``/queries/{id}/retrieve``,,`POST <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1queries~1{id}~1retrieve/post>`__,,,Retrieve all answers
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
128 ``/series``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series/get>`__,,,,List the available series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
129 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
130 ``/series/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1anonymize/post>`__,,,Anonymize series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
131 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
132 ``/series/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments/get>`__,,,,List attachments
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
133 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
134 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
135 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
136 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
137 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
138 ``/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
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
139 ``/series/{id}/attachments/{name}/info``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1attachments~1{name}~1info/get>`__,,,,Get info about the attachment
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
140 ``/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?
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
141 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
142 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
143 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
144 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
145 ``/series/{id}/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1instances/get>`__,,,,Get child instances
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
146 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
147 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
148 ``/series/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1metadata/get>`__,,,,List metadata
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
149 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
150 ``/series/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1modify/post>`__,,,Modify series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
151 ``/series/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1module/get>`__,,,,Get series module
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
152 ``/series/{id}/numpy``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1numpy/get>`__,,,,Decode series for numpy
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
153 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
154 ``/series/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1patient/get>`__,,,,Get parent patient
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
155 ``/series/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1reconstruct/post>`__,,,Reconstruct tags of series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
156 ``/series/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1shared-tags/get>`__,,,,Get shared tags
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
157 ``/series/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1statistics/get>`__,,,,Get series statistics
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
158 ``/series/{id}/study``,`GET <https://api.orthanc-server.com/index.html#tag/Series/paths/~1series~1{id}~1study/get>`__,,,,Get parent study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
159 ``/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1statistics/get>`__,,,,Get database statistics
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
160 ``/storage-commitment/{id}``,`GET <https://api.orthanc-server.com/index.html#tag/Networking/paths/~1storage-commitment~1{id}/get>`__,,,,Get storage commitment report
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
161 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
162 ``/studies``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies/get>`__,,,,List the available studies
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
163 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
164 ``/studies/{id}/anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1anonymize/post>`__,,,Anonymize study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
165 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
166 ``/studies/{id}/attachments``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments/get>`__,,,,List attachments
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
167 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
168 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
169 ``/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)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
170 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
171 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
172 ``/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
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
173 ``/studies/{id}/attachments/{name}/info``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1attachments~1{name}~1info/get>`__,,,,Get info about the attachment
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
174 ``/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?
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
175 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
176 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
177 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
178 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
179 ``/studies/{id}/instances``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1instances/get>`__,,,,Get child instances
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
180 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
181 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
182 ``/studies/{id}/merge``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1merge/post>`__,,,Merge study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
183 ``/studies/{id}/metadata``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1metadata/get>`__,,,,List metadata
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
184 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
185 ``/studies/{id}/modify``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1modify/post>`__,,,Modify study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
186 ``/studies/{id}/module``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1module/get>`__,,,,Get study module
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
187 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
188 ``/studies/{id}/patient``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1patient/get>`__,,,,Get parent patient
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
189 ``/studies/{id}/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1reconstruct/post>`__,,,Reconstruct tags of study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
190 ``/studies/{id}/series``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1series/get>`__,,,,Get child series
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
191 ``/studies/{id}/shared-tags``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1shared-tags/get>`__,,,,Get shared tags
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
192 ``/studies/{id}/split``,,`POST <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1split/post>`__,,,Split study
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
193 ``/studies/{id}/statistics``,`GET <https://api.orthanc-server.com/index.html#tag/Studies/paths/~1studies~1{id}~1statistics/get>`__,,,,Get study statistics
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
194 ``/system``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1system/get>`__,,,,Get system information
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
195 ``/tools``,`GET <https://api.orthanc-server.com/index.html#tag/Other/paths/~1tools/get>`__,,,,List operations
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
196 ``/tools/accepted-transfer-syntaxes``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1accepted-transfer-syntaxes/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1accepted-transfer-syntaxes/put>`__,Get accepted transfer syntaxes
719
8a247c645ac6 Orthanc 1.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 618
diff changeset
197 ``/tools/bulk-anonymize``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1bulk-anonymize/post>`__,,,Anonymize a set of resources
817
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
198 ``/tools/bulk-content``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1bulk-content/post>`__,,,Describe a set of resources
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 719
diff changeset
199 ``/tools/bulk-delete``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1bulk-delete/post>`__,,,Delete a set of resources
719
8a247c645ac6 Orthanc 1.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 618
diff changeset
200 ``/tools/bulk-modify``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1bulk-modify/post>`__,,,Modify a set of resources
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
201 ``/tools/create-archive``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-archive/post>`__,,,Create ZIP archive
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
202 ``/tools/create-dicom``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-dicom/post>`__,,,Create one DICOM instance
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
203 ``/tools/create-media``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-media/post>`__,,,Create DICOMDIR media
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
204 ``/tools/create-media-extended``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-media-extended/post>`__,,,Create DICOMDIR media
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
205 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
206 ``/tools/dicom-conformance``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1dicom-conformance/get>`__,,,,Get DICOM conformance
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
207 ``/tools/dicom-echo``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1dicom-echo/post>`__,,,Trigger C-ECHO SCU
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
208 ``/tools/execute-script``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1execute-script/post>`__,,,Execute Lua script
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
209 ``/tools/find``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1find/post>`__,,,Look for local resources
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
210 ``/tools/generate-uid``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1generate-uid/get>`__,,,,Generate an identifier
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
211 ``/tools/invalidate-tags``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1invalidate-tags/post>`__,,,Invalidate DICOM-as-JSON summaries
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
212 ``/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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
213 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
214 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
215 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
216 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
217 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
218 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
219 ``/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`
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
220 ``/tools/lookup``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1lookup/post>`__,,,Look for DICOM identifiers
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
221 ``/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?
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
222 ``/tools/metrics-prometheus``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1metrics-prometheus/get>`__,,,,Get usage metrics
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
223 ``/tools/now``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1now/get>`__,,,,Get UTC time
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
224 ``/tools/now-local``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1now-local/get>`__,,,,Get local time
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
225 ``/tools/reconstruct``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1reconstruct/post>`__,,,Reconstruct all the index
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
226 ``/tools/reset``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1reset/post>`__,,,Restart Orthanc
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
227 ``/tools/shutdown``,,`POST <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1shutdown/post>`__,,,Shutdown Orthanc
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 584
diff changeset
228 ``/tools/unknown-sop-class-accepted``,`GET <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1unknown-sop-class-accepted/get>`__,,,`PUT <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1unknown-sop-class-accepted/put>`__,Is unknown SOP class accepted?