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	"?expand" argument
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 decoded image to the [-32768;32767] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)
28	/instances/{id}/frames/{frameNumber}/image-uint16	y	n	n	n	Truncated decoded image to the [0;65535] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)
29	/instances/{id}/frames/{frameNumber}/image-uint8	y	n	n	n	Truncated decoded image to the [0;255] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)
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), "?quality" to change JPEG compression
32	/instances/{id}/frames/{frameNumber}/rendered	y	n	n	n	Rescaled image taking the windowing into account (so that all the range [0;255] is used)
33	/instances/{id}/frames/{frameNumber}/raw	y	n	n	n	Access to the raw content of one frame (bypass image decoding)
34	/instances/{id}/frames/{frameNumber}/raw.gz	y	n	n	n	Access to the raw content of one frame, compressed using gzip
35	/instances/{id}/header	y	n	n	n	Get the meta information (header) of the DICOM file, "?simplify" argument to simplify output, "?short"
36	/instances/{id}/image-int16	y	n	n	n	Truncated decoded image to the [-32768;32767] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)
37	/instances/{id}/image-uint16	y	n	n	n	Truncated decoded image to the [0;65535] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)
38	/instances/{id}/image-uint8	y	n	n	n	Truncated decoded image to the [0;255] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)
39	/instances/{id}/matlab	y	n	n	n	a = eval(urlread('http://localhost:8042/instances/.../matlab'))
40	/instances/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
41	/instances/{id}/module	y	n	n	n	"?simplify" argument to simplify output, "?short"
42	/instances/{id}/patient	y	n	n	n	Retrieve the parent patient of this instance
43	/instances/{id}/pdf	y	n	n	n	Return the encapsulated PDF inside the DICOM file, if any
44	/instances/{id}/preview	y	n	n	n	Rescaled image (so that all the range [0;255] is used), "?quality" to change JPEG compression
45	/instances/{id}/rendered	y	n	n	n	Rescaled image taking the windowing into account (so that all the range [0;255] is used)
46	/instances/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata
47	/instances/{id}/series	y	n	n	n	Retrieve the parent series of this instance
48	/instances/{id}/simplified-tags	y	n	n	n
49	/instances/{id}/statistics	y	n	n	n
50	/instances/{id}/study	y	n	n	n	Retrieve the parent study of this instance
51	/instances/{id}/tags	y	n	n	n	"?simplify" argument to simplify output (same as "simplified-tags"), "?short"
52	/jobs	y	n	n	n	List the jobs, "?expand" to get more information
53	/jobs/{id}	y	n	n	n	Get information about one job
54	/jobs/{id}/cancel	n	n	y	n	Cancel the job, tag it as failed
55	/jobs/{id}/pause	n	n	y	n	Pause the job
56	/jobs/{id}/resubmit	n	n	y	n	Resumbit a failed job
57	/jobs/{id}/resume	n	n	y	n	Resume a paused job
58	/jobs/{id}/{key}	y	n	n	n	Retrieve outputs generated by the job (only valid after job is successful)
59	/modalities	y	n	n	n
60	/modalities/{dicom}	y	y	n	y
61	/modalities/{dicom}/configuration	y	n	n	n	Return the configuration of one single DICOM modality (cf. "/modalities?expand")
62	/modalities/{dicom}/echo	n	n	y	n	C-Echo SCU
63	/modalities/{dicom}/find	n	n	d	n	Deprecated
64	/modalities/{dicom}/find-patient	n	n	d	n	Deprecated
65	/modalities/{dicom}/find-series	n	n	d	n	Deprecated
66	/modalities/{dicom}/find-study	n	n	d	n	Deprecated
67	/modalities/{dicom}/find-worklist	n	n	y	n	Performs a C-Find for worklist on the given modality. ex: curl http://localhost:8042/modalities/sectra/find-worklist -d '{"PatientID":""}'
68	/modalities/{dicom}/move	n	n	y	n	DICOM C-Move SCU (Retrieve)
69	/modalities/{dicom}/query	n	n	y	n	DICOM C-Find SCU (Query), with subsequent possibility for Retrieve
70	/modalities/{dicom}/store	n	n	y	n	POST body = UUID series, UUID instance, or raw DICOM file
71	/modalities/{dicom}/store-straight	n	n	y	n	Send the DICOM file contained in the POST body to remote modality (using C-STORE), without using jobs (synchronous call)
72	/modalities/{dicom}/storage-commitment	n	n	y	n	DICOM N-ACTION SCU to request storage commitment from remote modality
73	/patients	y	n	n	n	"since" and "limit" arguments + "expand" argument to retrieve the content of the patients
74	/patients/{id}	y	y	n	n
75	/patients/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
76	/patients/{id}/archive	y	n	y	n	Create ZIP
77	/patients/{id}/instances	y	n	n	n	Retrieve all the instances of this patient in a single REST call
78	/patients/{id}/instances-tags	y	n	n	n	"?simplify" argument to simplify output, "?short"
79	/patients/{id}/media	y	n	y	n	Create a ZIP archive for media storage with DICOMDIR
80	/patients/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
81	/patients/{id}/module	y	n	n	n	"?simplify" argument to simplify output, "?short"
82	/patients/{id}/protected	y	n	n	y	Protection against recycling: "0" means unprotected, "1" protected
83	/patients/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances
84	/patients/{id}/series	y	n	n	n	Retrieve all the series of this patient in a single REST call
85	/patients/{id}/shared-tags	y	n	n	n	"?simplify" argument to simplify output, "?short"
86	/patients/{id}/statistics	y	n	n	n
87	/patients/{id}/studies	y	n	n	n	Retrieve all the studies of this patient in a single REST call
88	/peers	y	n	n	n
89	/peers/{peer}	y	y	n	y
90	/peers/{peer}/configuration	y	n	n	n	Return the configuration of one single Orthanc peer (cf. "/peers?expand")
91	/peers/{peer}/store	n	n	y	n	POST body = UUID series, UUID instance, or raw DICOM file
92	/peers/{peer}/system	y	n	n	n	Gets the /system info from the remote peer (useful to test the connection with the remote peer)
93	/plugins	y	n	n	n	Get the list of all the registered plugins
94	/plugins/{id}	y	n	n	n	Get information about some plugin
95	/plugins/explorer.js	y	n	n	n	Get the JavaScript code that is injected by plugins into Orthanc Explorer
96	/queries	y	n	n	n
97	/queries/{id}	y	y	n	n
98	/queries/{id}/answers	y	n	n	n	List all the answers for this C-Find SCU request ("?expand" to show content, "&simplify" to simplify output)
99	/queries/{id}/answers/{index}/content	y	n	n	n	Access 1 answer of C-Find SCU; "?simplify" argument to simplify output
100	/queries/{id}/answers/{index}/retrieve	n	n	y	n	C-Move SCU: Send this resource to another modality whose AET is in the body
101	/queries/{id}/answers/{index}/query-instances	n	n	y	n	Launch another C-Find SCU to find the child DICOM instances of the given answer (might not work with all PACS)
102	/queries/{id}/answers/{index}/query-series	n	n	y	n	Launch another C-Find SCU to find the child series of the given answer
103	/queries/{id}/answers/{index}/query-studies	n	n	y	n	Launch another C-Find SCU to find the child patient of the given answer
104	/queries/{id}/level	y	n	n	n	Get the query retrieve level for this C-Find SCU request
105	/queries/{id}/modality	y	n	n	n	Get the modality to which this C-Find SCU request was issued (cf. /modalities)
106	/queries/{id}/query	y	n	n	n	Access the C-Find SCU query; "?simplify" argument to simplify output
107	/queries/{id}/retrieve	n	n	y	n	C-Move SCU: Send all the results to another modality whose AET is in the body
108	/series	y	n	n	n	"since" and "limit" arguments + "expand" argument to retrieve the content of the series
109	/series/{id}	y	y	n	n
110	/series/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
111	/series/{id}/archive	y	n	y	n	Create a ZIP archive for media storage with DICOMDIR
112	/series/{id}/instances	y	n	n	n	Retrieve all the instances of this series in a single REST call
113	/series/{id}/instances-tags	y	n	n	n	"?simplify" argument to simplify output, "?short"
114	/series/{id}/media	y	n	y	n	Create archives for media storage with DICOMDIR
115	/series/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
116	/series/{id}/module	y	n	n	n	"?simplify" argument to simplify output, "?short"
117	/series/{id}/ordered-slices	y	n	n	n	Order the slices of a 2D+t, 3D or 3D+t image
118	/series/{id}/patient	y	n	n	n	Retrieve the parent patient of this series
119	/series/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances
120	/series/{id}/shared-tags	y	n	n	n	"?simplify" argument to simplify output, "?short"
121	/series/{id}/statistics	y	n	n	n
122	/series/{id}/study	y	n	n	n	Retrieve the parent study of this series
123	/statistics	y	n	n	n
124	/storage-commitment/{transaction}	y	n	n	n	Get the status of a storage commitment report received from a remote modality
125	/storage-commitment/{transaction}/remove	n	n	y	n	Remove DICOM instances stored locally, for which the remote modality has reported successful storage commitment
126	/studies	y	n	n	n	"since" and "limit" arguments + "expand" argument to retrieve the content of the studies
127	/studies/{id}	y	y	n	n
128	/studies/{id}/anonymize	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
129	/studies/{id}/archive	y	n	y	n	Create ZIP
130	/studies/{id}/instances	y	n	n	n	Retrieve all the instances of this patient in a single REST call
131	/studies/{id}/instances-tags	y	n	n	n	"?simplify" argument to simplify output, "?short"
132	/studies/{id}/media	y	n	y	n	Create a ZIP archive for media storage with DICOMDIR
133	/studies/{id}/merge	n	n	y	n	Merge a study, i.e. move series from another study into this study
134	/studies/{id}/modify	n	n	y	n	http://book.orthanc-server.com/users/anonymization.html
135	/studies/{id}/module	y	n	n	n	"?simplify" argument to simplify output, "?short"
136	/studies/{id}/module-patient	y	n	n	n	"?simplify" argument to simplify output, "?short"
137	/studies/{id}/patient	y	n	n	n	Retrieve the parent patient of this study
138	/studies/{id}/reconstruct	n	n	y	n	Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances
139	/studies/{id}/series	y	n	n	n	Retrieve all the series of this study in a single REST call
140	/studies/{id}/shared-tags	y	n	n	n	"?simplify" argument to simplify output, "?short"
141	/studies/{id}/split	n	n	y	n	Split a study, i.e. create a new study from a subset of its child series
142	/studies/{id}/statistics	y	n	n	n
143	/system	y	n	n	n
144	/tools/create-archive	n	n	y	n	Create a ZIP from a set of unrelated DICOM resources
145	/tools/create-dicom	n	n	y	n	Create and store a new DICOM instance, possibly with an image or a PDF payload
146	/tools/create-media	n	n	y	n	Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources
147	/tools/create-media-extended	n	n	y	n	Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources, including type-3 tags
148	/tools/default-encoding	y	n	n	y	Get the default encoding used by Orthanc, or temporarily change it until the next restart
149	/tools/dicom-conformance	y	n	n	n	DICOM conformance statement of this version of Orthanc
150	/tools/dicom-echo	n	n	n	y	Execute C-Echo SCU to a modality that is not registered in "/modalities"
151	/tools/execute-script	n	n	y	n	Execute the Lua script in the POST body
152	/tools/find	n	n	y	n	Runs a C-Find call from the REST API
153	/tools/generate-uid	y	n	n	n	Generate DICOM UID. The "level" GET argument must be "patient", "study", "series" or "instance"
154	/tools/invalidate-tags	n	n	y	n	Invalidate the JSON summary of all the DICOM files (useful if new private tags are registered)
155	/tools/log-level	y	n	n	y	Change the log level while Orthanc is running (can be "default", "verbose" or "trace")
156	/tools/log-level-[category]	y	n	n	y	Dynamically change the log level associated with a log category (can be "default", "verbose" or "trace")
157	/tools/lookup	n	n	y	n	Map DICOM UIDs to Orthanc identifiers
158	/tools/metrics	y	n	n	y	See whether the collection of metrics is enabled, and enable/disable this collection
159	/tools/metrics-prometheus	y	n	n	n	Retrieve the metrics in the Prometheus text-based exposition format
160	/tools/now	y	n	n	n	Returns the current universal datetime (UTC) in the ISO 8601 format
161	/tools/now-local	y	n	n	n	Returns the current local datetime in the ISO 8601 format
162	/tools/reconstruct	n	n	y	n	Reconstructs the main DICOM tags, the JSON summary and metadata of all the instances stored in Orthanc. Slow operation!
163	/tools/reset	n	n	y	n	Hot restart of Orthanc, the configuration file will be read again
164	/tools/shutdown	n	n	y	n	Stop Orthanc

1

Path

GET

DELETE

POST

PUT

Notes

2

/{resourceType}/{id}/attachments

y

n

List the files that are attached to this patient, study, series or instance

3

/{resourceType}/{id}/attachments/{name}

y

n

y

4

/{resourceType}/{id}/attachments/{name}/compress

n

y

n

5

/{resourceType}/{id}/attachments/{name}/compressed-data

y

n

Return the (possibly compressed) data, as stored on the disk

6

/{resourceType}/{id}/attachments/{name}/compressed-md5

y

n

7

/{resourceType}/{id}/attachments/{name}/compressed-size

y

n

8

/{resourceType}/{id}/attachments/{name}/data

y

n

9

/{resourceType}/{id}/attachments/{name}/is-compressed

y

n

Is this attachment compressed: "0" means uncompressed, "1" compressed

10

/{resourceType}/{id}/attachments/{name}/md5

y

n

11

/{resourceType}/{id}/attachments/{name}/size

y

n

12

/{resourceType}/{id}/attachments/{name}/uncompress

n

y

n

13

/{resourceType}/{id}/attachments/{name}/verify-md5

n

y

n

Check that there is no corruption on the disk (HTTP status == 200 iff. no error)

14

/{resourceType}/{id}/metadata

y

n

"?expand" argument

15

/{resourceType}/{id}/metadata/{name}

y

n

y

16

/changes

y

n

"last", "limit" and "since" arguments

17

/exports

y

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

n

20

/instances/{id}/anonymize

n

y

n

http://book.orthanc-server.com/users/anonymization.html

21

/instances/{id}/content/

y

n

List the first-level DICOM tags

22

/instances/{id}/content/{group}-{element}

y

n

Raw access to the value of DICOM tags (comprising the padding character)

23

/instances/{id}/content/{group}-{element}/{index}/...

y

n

Raw access to the content of DICOM sequences

24

/instances/{id}/export

n

y

n

Write the DICOM file to the filesystem where Orthanc is running

25

/instances/{id}/file

y

n

26

/instances/{id}/frames

y

n

27

/instances/{id}/frames/{frameNumber}/image-int16

y

n

Truncated decoded image to the [-32768;32767] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)

28

/instances/{id}/frames/{frameNumber}/image-uint16

y

n

Truncated decoded image to the [0;65535] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)

29

/instances/{id}/frames/{frameNumber}/image-uint8

y

n

Truncated decoded image to the [0;255] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)

30

/instances/{id}/frames/{frameNumber}/matlab

y

n

a = eval(urlread('http://localhost:8042/instances/.../frames/0/matlab'))

31

/instances/{id}/frames/{frameNumber}/preview

y

n

Rescaled image (so that all the range [0;255] is used), "?quality" to change JPEG compression

32

/instances/{id}/frames/{frameNumber}/rendered

y

n

Rescaled image taking the windowing into account (so that all the range [0;255] is used)

33

/instances/{id}/frames/{frameNumber}/raw

y

n

Access to the raw content of one frame (bypass image decoding)

34

/instances/{id}/frames/{frameNumber}/raw.gz

y

n

Access to the raw content of one frame, compressed using gzip

35

/instances/{id}/header

y

n

Get the meta information (header) of the DICOM file, "?simplify" argument to simplify output, "?short"

36

/instances/{id}/image-int16

y

n

Truncated decoded image to the [-32768;32767] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)

37

/instances/{id}/image-uint16

y

n

Truncated decoded image to the [0;65535] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)

38

/instances/{id}/image-uint8

y

n

Truncated decoded image to the [0;255] range (Accepts image/png, image/jpg, image/x-portable-arbitrarymap)

39

/instances/{id}/matlab

y

n

a = eval(urlread('http://localhost:8042/instances/.../matlab'))

40

/instances/{id}/modify

n

y

n

http://book.orthanc-server.com/users/anonymization.html

41

/instances/{id}/module

y

n

"?simplify" argument to simplify output, "?short"

42

/instances/{id}/patient

y

n

Retrieve the parent patient of this instance

43

/instances/{id}/pdf

y

n

Return the encapsulated PDF inside the DICOM file, if any

44

/instances/{id}/preview

y

n

Rescaled image (so that all the range [0;255] is used), "?quality" to change JPEG compression

45

/instances/{id}/rendered

y

n

Rescaled image taking the windowing into account (so that all the range [0;255] is used)

46

/instances/{id}/reconstruct

n

y

n

Force reconstruction of the main DICOM tags, JSON summary and metadata

47

/instances/{id}/series

y

n

Retrieve the parent series of this instance

48

/instances/{id}/simplified-tags

y

n

49

/instances/{id}/statistics

y

n

50

/instances/{id}/study

y

n

Retrieve the parent study of this instance

51

/instances/{id}/tags

y

n

"?simplify" argument to simplify output (same as "simplified-tags"), "?short"

52

/jobs

y

n

List the jobs, "?expand" to get more information

53

/jobs/{id}

y

n

Get information about one job

54

/jobs/{id}/cancel

n

y

n

Cancel the job, tag it as failed

55

/jobs/{id}/pause

n

y

n

Pause the job

56

/jobs/{id}/resubmit

n

y

n

Resumbit a failed job

57

/jobs/{id}/resume

n

y

n

Resume a paused job

58

/jobs/{id}/{key}

y

n

Retrieve outputs generated by the job (only valid after job is successful)

59

/modalities

y

n

60

/modalities/{dicom}

y

n

y

61

/modalities/{dicom}/configuration

y

n

Return the configuration of one single DICOM modality (cf. "/modalities?expand")

62

/modalities/{dicom}/echo

n

y

n

C-Echo SCU

63

/modalities/{dicom}/find

n

d

n

Deprecated

64

/modalities/{dicom}/find-patient

n

d

n

Deprecated

65

/modalities/{dicom}/find-series

n

d

n

Deprecated

66

/modalities/{dicom}/find-study

n

d

n

Deprecated

67

/modalities/{dicom}/find-worklist

n

y

n

Performs a C-Find for worklist on the given modality. ex: curl http://localhost:8042/modalities/sectra/find-worklist -d '{"PatientID":""}'

68

/modalities/{dicom}/move

n

y

n

DICOM C-Move SCU (Retrieve)

69

/modalities/{dicom}/query

n

y

n

DICOM C-Find SCU (Query), with subsequent possibility for Retrieve

70

/modalities/{dicom}/store

n

y

n

POST body = UUID series, UUID instance, or raw DICOM file

71

/modalities/{dicom}/store-straight

n

y

n

Send the DICOM file contained in the POST body to remote modality (using C-STORE), without using jobs (synchronous call)

72

/modalities/{dicom}/storage-commitment

n

y

n

DICOM N-ACTION SCU to request storage commitment from remote modality

73

/patients

y

n

"since" and "limit" arguments + "expand" argument to retrieve the content of the patients

74

/patients/{id}

y

n

75

/patients/{id}/anonymize

n

y

n

http://book.orthanc-server.com/users/anonymization.html

76

/patients/{id}/archive

y

n

y

n

Create ZIP

77

/patients/{id}/instances

y

n

Retrieve all the instances of this patient in a single REST call

78

/patients/{id}/instances-tags

y

n

"?simplify" argument to simplify output, "?short"

79

/patients/{id}/media

y

n

y

n

Create a ZIP archive for media storage with DICOMDIR

80

/patients/{id}/modify

n

y

n

http://book.orthanc-server.com/users/anonymization.html

81

/patients/{id}/module

y

n

"?simplify" argument to simplify output, "?short"

82

/patients/{id}/protected

y

n

y

Protection against recycling: "0" means unprotected, "1" protected

83

/patients/{id}/reconstruct

n

y

n

Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances

84

/patients/{id}/series

y

n

Retrieve all the series of this patient in a single REST call

85

/patients/{id}/shared-tags

y

n

"?simplify" argument to simplify output, "?short"

86

/patients/{id}/statistics

y

n

87

/patients/{id}/studies

y

n

Retrieve all the studies of this patient in a single REST call

88

/peers

y

n

89

/peers/{peer}

y

n

y

90

/peers/{peer}/configuration

y

n

Return the configuration of one single Orthanc peer (cf. "/peers?expand")

91

/peers/{peer}/store

n

y

n

POST body = UUID series, UUID instance, or raw DICOM file

92

/peers/{peer}/system

y

n

Gets the /system info from the remote peer (useful to test the connection with the remote peer)

93

/plugins

y

n

Get the list of all the registered plugins

94

/plugins/{id}

y

n

Get information about some plugin

95

/plugins/explorer.js

y

n

Get the JavaScript code that is injected by plugins into Orthanc Explorer

96

/queries

y

n

97

/queries/{id}

y

n

98

/queries/{id}/answers

y

n

List all the answers for this C-Find SCU request ("?expand" to show content, "&simplify" to simplify output)

99

/queries/{id}/answers/{index}/content

y

n

Access 1 answer of C-Find SCU; "?simplify" argument to simplify output

100

/queries/{id}/answers/{index}/retrieve

n

y

n

C-Move SCU: Send this resource to another modality whose AET is in the body

101

/queries/{id}/answers/{index}/query-instances

n

y

n

Launch another C-Find SCU to find the child DICOM instances of the given answer (might not work with all PACS)

102

/queries/{id}/answers/{index}/query-series

n

y

n

Launch another C-Find SCU to find the child series of the given answer

103

/queries/{id}/answers/{index}/query-studies

n

y

n

Launch another C-Find SCU to find the child patient of the given answer

104

/queries/{id}/level

y

n

Get the query retrieve level for this C-Find SCU request

105

/queries/{id}/modality

y

n

Get the modality to which this C-Find SCU request was issued (cf. /modalities)

106

/queries/{id}/query

y

n

Access the C-Find SCU query; "?simplify" argument to simplify output

107

/queries/{id}/retrieve

n

y

n

C-Move SCU: Send all the results to another modality whose AET is in the body

108

/series

y

n

"since" and "limit" arguments + "expand" argument to retrieve the content of the series

109

/series/{id}

y

n

110

/series/{id}/anonymize

n

y

n

http://book.orthanc-server.com/users/anonymization.html

111

/series/{id}/archive

y

n

y

n

Create a ZIP archive for media storage with DICOMDIR

112

/series/{id}/instances

y

n

Retrieve all the instances of this series in a single REST call

113

/series/{id}/instances-tags

y

n

"?simplify" argument to simplify output, "?short"

114

/series/{id}/media

y

n

y

n

Create archives for media storage with DICOMDIR

115

/series/{id}/modify

n

y

n

http://book.orthanc-server.com/users/anonymization.html

116

/series/{id}/module

y

n

"?simplify" argument to simplify output, "?short"

117

/series/{id}/ordered-slices

y

n

Order the slices of a 2D+t, 3D or 3D+t image

118

/series/{id}/patient

y

n

Retrieve the parent patient of this series

119

/series/{id}/reconstruct

n

y

n

Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances

120

/series/{id}/shared-tags

y

n

"?simplify" argument to simplify output, "?short"

121

/series/{id}/statistics

y

n

122

/series/{id}/study

y

n

Retrieve the parent study of this series

123

/statistics

y

n

124

/storage-commitment/{transaction}

y

n

Get the status of a storage commitment report received from a remote modality

125

/storage-commitment/{transaction}/remove

n

y

n

Remove DICOM instances stored locally, for which the remote modality has reported successful storage commitment

126

/studies

y

n

"since" and "limit" arguments + "expand" argument to retrieve the content of the studies

127

/studies/{id}

y

n

128

/studies/{id}/anonymize

n

y

n

http://book.orthanc-server.com/users/anonymization.html

129

/studies/{id}/archive

y

n

y

n

Create ZIP

130

/studies/{id}/instances

y

n

Retrieve all the instances of this patient in a single REST call

131

/studies/{id}/instances-tags

y

n

"?simplify" argument to simplify output, "?short"

132

/studies/{id}/media

y

n

y

n

Create a ZIP archive for media storage with DICOMDIR

133

/studies/{id}/merge

n

y

n

Merge a study, i.e. move series from another study into this study

134

/studies/{id}/modify

n

y

n

http://book.orthanc-server.com/users/anonymization.html

135

/studies/{id}/module

y

n

"?simplify" argument to simplify output, "?short"

136

/studies/{id}/module-patient

y

n

"?simplify" argument to simplify output, "?short"

137

/studies/{id}/patient

y

n

Retrieve the parent patient of this study

138

/studies/{id}/reconstruct

n

y

n

Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances

139

/studies/{id}/series

y

n

Retrieve all the series of this study in a single REST call

140

/studies/{id}/shared-tags

y

n

"?simplify" argument to simplify output, "?short"

141

/studies/{id}/split

n

y

n

Split a study, i.e. create a new study from a subset of its child series

142

/studies/{id}/statistics

y

n

143

/system

y

n

144

/tools/create-archive

n

y

n

Create a ZIP from a set of unrelated DICOM resources

145

/tools/create-dicom

n

y

n

Create and store a new DICOM instance, possibly with an image or a PDF payload

146

/tools/create-media

n

y

n

Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources

147

/tools/create-media-extended

n

y

n

Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources, including type-3 tags

148

/tools/default-encoding

y

n

y

Get the default encoding used by Orthanc, or temporarily change it until the next restart

149

/tools/dicom-conformance

y

n

DICOM conformance statement of this version of Orthanc

150

/tools/dicom-echo

n

y

Execute C-Echo SCU to a modality that is not registered in "/modalities"

151

/tools/execute-script

n

y

n

Execute the Lua script in the POST body

152

/tools/find

n

y

n

Runs a C-Find call from the REST API

153

/tools/generate-uid

y

n

Generate DICOM UID. The "level" GET argument must be "patient", "study", "series" or "instance"

154

/tools/invalidate-tags

n

y

n

Invalidate the JSON summary of all the DICOM files (useful if new private tags are registered)

155

/tools/log-level

y

n

y

Change the log level while Orthanc is running (can be "default", "verbose" or "trace")

156

/tools/log-level-[category]

y

n

y

Dynamically change the log level associated with a log category (can be "default", "verbose" or "trace")

157

/tools/lookup

n

y

n

Map DICOM UIDs to Orthanc identifiers

158

/tools/metrics

y

n

y

See whether the collection of metrics is enabled, and enable/disable this collection

159

/tools/metrics-prometheus

y

n

Retrieve the metrics in the Prometheus text-based exposition format

160

/tools/now

y

n

Returns the current *universal* datetime (UTC) in the ISO 8601 format

161

/tools/now-local

y

n

Returns the current *local* datetime in the ISO 8601 format

162

/tools/reconstruct

n

y

n

Reconstructs the main DICOM tags, the JSON summary and metadata of all the instances stored in Orthanc. Slow operation!

163

/tools/reset

n

y

n

Hot restart of Orthanc, the configuration file will be read again

164

/tools/shutdown

n

y

n

Stop Orthanc