Orthanc - REST API - Google Drive


1	Path	GET	DELETE	POST	PUT	Notes

2	/{resourceType}/{id}/attachments	y	n	n	n	List the files that are attached to this patient, study, series or instance
3	/{resourceType}/{id}/attachments/{name}	y	y	n	y
4	/{resourceType}/{id}/attachments/{name}/compress	n	n	y	n
5	/{resourceType}/{id}/attachments/{name}/compressed-data	y	n	n	n	Return the (possibly compressed) data, as stored on the disk
6	/{resourceType}/{id}/attachments/{name}/compressed-md5	y	n	n	n
7	/{resourceType}/{id}/attachments/{name}/compressed-size	y	n	n	n
8	/{resourceType}/{id}/attachments/{name}/data	y	n	n	n
9	/{resourceType}/{id}/attachments/{name}/is-compressed	y	n	n	n	Is this attachment compressed: "0" means uncompressed, "1" compressed
10	/{resourceType}/{id}/attachments/{name}/md5	y	n	n	n
11	/{resourceType}/{id}/attachments/{name}/size	y	n	n	n
12	/{resourceType}/{id}/attachments/{name}/uncompress	n	n	y	n
13	/{resourceType}/{id}/attachments/{name}/verify-md5	n	n	y	n	Check that there is no corruption on the disk (HTTP status == 200 iff. no error)
14	/{resourceType}/{id}/metadata	y	n	n	n
15	/{resourceType}/{id}/metadata/{name}	y	y	n	y
16	/changes	y	y	n	n	"last", "limit" and "since" arguments
17	/exports	y	y	n	n	"last", "limit" and "since" arguments
18	/instances	y	n	y	n	GET: "last" and "limit" arguments; POST = Add the new DICOM file given in the POST body
19	/instances/{id}	y	y	n	n
20	/instances/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
21	/instances/{id}/content/	y	n	n	n	List the first-level DICOM tags
22	/instances/{id}/content/{group}-{element}	y	n	n	n	Raw access to the value of DICOM tags (comprising the padding character)
23	/instances/{id}/content/{group}-{element}/{index}/...	y	n	n	n	Raw access to the content of DICOM sequences
24	/instances/{id}/export	n	n	y	n	Write the DICOM file to the filesystem where Orthanc is running
25	/instances/{id}/file	y	n	n	n
26	/instances/{id}/frames	y	n	n	n
27	/instances/{id}/frames/{frameNumber}/image-int16	y	n	n	n	Truncated image to the [-32768;32767] range
28	/instances/{id}/frames/{frameNumber}/image-uint16	y	n	n	n	Truncated image to the [0;65535] range
29	/instances/{id}/frames/{frameNumber}/image-uint8	y	n	n	n	Truncated image to the [0;255] range
30	/instances/{id}/frames/{frameNumber}/matlab	y	n	n	n	a = eval(urlread('http://localhost:8042/instances/.../frames/0/matlab'))
31	/instances/{id}/frames/{frameNumber}/preview	y	n	n	n	Rescaled image (so that all the range [0;255] is used)
32	/instances/{id}/frames/{frameNumber}/raw	y	n	n	n	Access to the raw content of one frame (bypass image decoding)
33	/instances/{id}/frames/{frameNumber}/raw.gz	y	n	n	n	Access to the raw content of one frame, compressed using gzip
34	/instances/{id}/header	y	n	n	n	Get the meta information (header) of the DICOM file, "?simplify" argument to simplify output
35	/instances/{id}/image-int16	y	n	n	n	Truncated image to the [-32768;32767] range
36	/instances/{id}/image-uint16	y	n	n	n	Truncated image to the [0;65535] range
37	/instances/{id}/image-uint8	y	n	n	n	Truncated image to the [0;255] range
38	/instances/{id}/matlab	y	n	n	n	a = eval(urlread('http://localhost:8042/instances/.../matlab'))
39	/instances/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
40	/instances/{id}/module	y	n	n	n
41	/instances/{id}/patient	y	n	n	n	Retrieve the parent patient of this instance
42	/instances/{id}/pdf	y	n	n	n	Return the encapsulated PDF inside the DICOM file, if any
43	/instances/{id}/preview	y	n	n	n	Rescaled image (so that all the range [0;255] is used)
44	/instances/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata
45	/instances/{id}/series	y	n	n	n	Retrieve the parent series of this instance
46	/instances/{id}/simplified-tags	y	n	n	n
47	/instances/{id}/statistics	y	n	n	n
48	/instances/{id}/study	y	n	n	n	Retrieve the parent study of this instance
49	/instances/{id}/tags	y	n	n	n	"?simplify" argument to simplify output (same as "simplified-tags")
50	/modalities	y	n	n	n
51	/modalities/{dicom}	y	y	n	y
52	/modalities/{dicom}/echo	n	n	y	n	C-Echo SCU
53	/modalities/{dicom}/find	n	n	d	n	Deprecated
54	/modalities/{dicom}/find-patient	n	n	d	n	Deprecated
55	/modalities/{dicom}/find-series	n	n	d	n	Deprecated
56	/modalities/{dicom}/find-study	n	n	d	n	Deprecated
57	/modalities/{dicom}/move	n	n	y	n	DICOM C-Move SCU (Retrieve)
58	/modalities/{dicom}/query	n	n	y	n	DICOM C-Find SCU (Query), with subsequent possibility for Retrieve
59	/modalities/{dicom}/store	n	n	y	n	POST body = UUID series, UUID instance, or raw DICOM file
60	/patients	y	n	n	n	"since" and "limit" arguments + "expand" argument to retrieve the content of the patients
61	/patients/{id}	y	y	n	n
62	/patients/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
63	/patients/{id}/archive	y	n	n	n	Create ZIP
64	/patients/{id}/instances	y	n	n	n	Retrieve all the instances of this patient in a single REST call
65	/patients/{id}/media	y	n	n	n	Create a ZIP archive for media storage with DICOMDIR
66	/patients/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
67	/patients/{id}/module	y	n	n	n
68	/patients/{id}/protected	y	n	n	y	Protection against recycling: "0" means unprotected, "1" protected
69	/patients/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances
70	/patients/{id}/series	y	n	n	n	Retrieve all the series of this patient in a single REST call
71	/patients/{id}/shared-tags	y	n	n	n	"?simplify" argument to simplify output
72	/patients/{id}/statistics	y	n	n	n
73	/patients/{id}/studies	y	n	n	n	Retrieve all the studies of this patient in a single REST call
74	/peers	y	n	n	n
75	/peers/{peer}	y	y	n	y
76	/peers/{peer}/store	n	n	y	n	POST body = UUID series, UUID instance, or raw DICOM file
77	/plugins	y	n	n	n	Get the list of all the registered plugins
78	/plugins/{id}	y	n	n	n	Get information about some plugin
79	/plugins/explorer.js	y	n	n	n	Get the JavaScript code that is injected by plugins into Orthanc Explorer
80	/queries	y	n	n	n
81	/queries/{id}	y	y	n	n
82	/queries/{id}/answers	y	n	n	n	List all the answers for this C-Find SCU request
83	/queries/{id}/answers/{index}/content	y	n	n	n	Access 1 answer of C-Find SCU; "?simplify" argument to simplify output
84	/queries/{id}/answers/{index}/retrieve	n	n	y	n	C-Move SCU: Send this resource to another modality whose AET is in the body
85	/queries/{id}/level	y	n	n	n	Get the query retrieve level for this C-Find SCU request
86	/queries/{id}/modality	y	n	n	n	Get the modality to which this C-Find SCU request was issued (cf. /modalities)
87	/queries/{id}/query	y	n	n	n	Access the C-Find SCU query; "?simplify" argument to simplify output
88	/queries/{id}/retrieve	n	n	y	n	C-Move SCU: Send all the results to another modality whose AET is in the body
89	/series	y	n	n	n	"since" and "limit" arguments + "expand" argument to retrieve the content of the series
90	/series/{id}	y	y	n	n
91	/series/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
92	/series/{id}/archive	y	n	n	n	Create a ZIP archive for media storage with DICOMDIR
93	/series/{id}/instances	y	n	n	n	Retrieve all the instances of this series in a single REST call
94	/series/{id}/media	y	n	n	n	Create archives for media storage with DICOMDIR
95	/series/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
96	/series/{id}/module	y	n	n	n	"?simplify" argument to simplify output
97	/series/{id}/ordered-slices	y	n	n	n	Order the slices of a 2D+t, 3D or 3D+t image
98	/series/{id}/patient	y	n	n	n	Retrieve the parent patient of this series
99	/series/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances
100	/series/{id}/shared-tags	y	n	n	n	"?simplify" argument to simplify output
101	/series/{id}/statistics	y	n	n	n
102	/series/{id}/study	y	n	n	n	Retrieve the parent study of this series
103	/statistics	y	n	n	n
104	/studies	y	n	n	n	"since" and "limit" arguments + "expand" argument to retrieve the content of the studies
105	/studies/{id}	y	y	n	n
106	/studies/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
107	/studies/{id}/archive	y	n	n	n	Create ZIP
108	/studies/{id}/instances	y	n	n	n	Retrieve all the instances of this patient in a single REST call
109	/studies/{id}/media	y	n	n	n	Create a ZIP archive for media storage with DICOMDIR
110	/studies/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
111	/studies/{id}/module	y	n	n	n	"?simplify" argument to simplify output
112	/studies/{id}/module-patient	y	n	n	n	"?simplify" argument to simplify output
113	/studies/{id}/patient	y	n	n	n	Retrieve the parent patient of this study
114	/studies/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances
115	/studies/{id}/series	y	n	n	n	Retrieve all the series of this study in a single REST call
116	/studies/{id}/shared-tags	y	n	n	n	"?simplify" argument to simplify output
117	/studies/{id}/statistics	y	n	n	n
118	/system	y	n	n	n
119	/tools/create-archive	n	n	y	n	Create a ZIP from a set of unrelated DICOM resources
120	/tools/create-dicom	n	n	y	n	Create and store a new DICOM instance, possibly with an image or a PDF payload
121	/tools/create-media	n	n	y	n	Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources
122	/tools/create-media-extended	n	n	y	n	Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources, including type-3 tags
123	/tools/default-encoding	y	n	n	y	Get the default encoding used by Orthanc, or temporarily change it until the next restart
124	/tools/dicom-conformance	y	n	n	n	DICOM conformance statement of this version of Orthanc
125	/tools/execute-script	n	n	y	n	Execute the Lua script in the POST body
126	/tools/find	n	n	y	n	Runs a C-Find call from the REST API
127	/tools/generate-uid	y	n	n	n	"level" argument among "patient", "study", "series" and "instance"
128	/tools/invalidate-tags	n	n	y	n	Invalidate the JSON summary of all the DICOM files (useful if private tags are registered)
129	/tools/lookup	n	n	y	n	Map DICOM UIDs to Orthanc identifiers
130	/tools/now	y	n	n	n	Returns the current universal datetime (UTC) in the ISO 8601 format
131	/tools/now-local	y	n	n	n	Returns the current local datetime in the ISO 8601 format
132	/tools/reset	n	n	y	n	Hot restart of Orthanc, the configuration file will be read again
133	/tools/shutdown	n	n	y	n	Stop Orthanc