Mercurial > hg > orthanc-python

annotate CodeAnalysis/CustomFunctions.json @ 203:28531e615104

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 03 Jul 2024 12:03:09 +0200
parents d7a6e75558ee
children 234681297600
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
183
d31f216c9462 extracted custom functions/methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 [
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
2 {
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
3 "short_name" : "RegisterRestCallback",
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
4 "implementation" : "RegisterRestCallback",
193
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
5 "documentation" : {
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
6 "description" : [ "Register a REST callback." ],
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
7 "args" : {
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
8 "pathRegularExpression" : "Regular expression for the URI. May contain groups.",
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
9 "callback" : "The callback function to handle the REST call."
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
10 }
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
11 },
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
12 "args" : [
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
13 {
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
14 "sdk_name" : "pathRegularExpression",
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
15 "sdk_type" : "const char *"
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
16 },
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
17 {
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
18 "sdk_name" : "callback",
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
19 "sdk_type" : "Callable",
203
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
20 "callable_type" : "RestCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
21 "callable_protocol_args" : "output: RestOutput, url: str, method: HttpMethod, groups: dict, get: dict, headers: dict, body: bytes=None",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
22 "callable_protocol_return" : "None"
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
23 }
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
24 ],
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
25 "return_sdk_type" : "void"
195
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
26 },
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
27
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
28 {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
29 "short_name" : "RegisterOnChangeCallback",
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
30 "implementation" : "RegisterOnChangeCallback",
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
31 "documentation" : {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
32 "description" : [ "Register a callback to monitor changes." ],
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
33 "args" : {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
34 "callback" : "The callback function."
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
35 }
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
36 },
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
37 "args" : [
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
38 {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
39 "sdk_name" : "callback",
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
40 "sdk_type" : "Callable",
203
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
41 "callable_type" : "OnChangeCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
42 "callable_protocol_args" : "change_type: ChangeType, resource_type: ResourceType, resource_id: str",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
43 "callable_protocol_return" : "None"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
44 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
45 ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
46 "return_sdk_type" : "void"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
47 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
48
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
49 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
50 "short_name" : "RegisterOnStoredInstanceCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
51 "implementation" : "RegisterOnStoredInstanceCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
52 "documentation" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
53 "description" : [ "Register a callback for received DICOM instances." ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
54 "args" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
55 "callback" : "The callback function."
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
56 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
57 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
58 "args" : [
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
59 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
60 "sdk_name" : "callback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
61 "sdk_type" : "Callable",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
62 "callable_type" : "OnStoredInstanceCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
63 "callable_protocol_args" : "instance: DicomInstance, instance_id: str",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
64 "callable_protocol_return" : "None"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
65 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
66 ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
67 "return_sdk_type" : "void"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
68 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
69
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
70 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
71 "comment" : "New in release 3.0",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
72 "short_name" : "RegisterIncomingHttpRequestFilter",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
73 "implementation" : "RegisterIncomingHttpRequestFilter",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
74 "documentation" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
75 "description" : [ "Callback to filter incoming HTTP requests received by Orthanc." ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
76 "args" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
77 "callback" : "The callback function."
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
78 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
79 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
80 "args" : [
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
81 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
82 "sdk_name" : "callback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
83 "sdk_type" : "Callable",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
84 "callable_type" : "IncomingHttpRequestFilter",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
85 "callable_protocol_args" : "uri: str, method: HttpMethod, ip: str, headers: dict, get: dict",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
86 "callable_protocol_return" : "bool"
195
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
87 }
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
88 ],
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
89 "return_sdk_type" : "void"
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
90 }
183
d31f216c9462 extracted custom functions/methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 ]