Wiki source code of Module Licenses

Last modified by michaely on 2021/09/10 23:34
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.1+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The module license REST resource allows access to the module licenses for a specific license. Each module in the system can have its own license, where license properties specific to the module are stored.
15
16
17 {{/layout-cell}}
18
19 {{layout-cell}}
20 {{panel title="On this page:"}}
21
22
23 {{toc maxLevel="2" indent="1"/}}
24 {{/panel}}
25 {{/layout-cell}}
26 {{/layout-section}}
27
28 {{layout-section ac:type="single"}}
29 {{layout-cell}}
30 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
31
32 {{code}}
33 communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "c5ec4a36-545b-4f80-a82c-4b009b7621a7",
41 "moduleId": "core"
42 }
43 {{/code}}
44
45 |=(((
46 Property
47 )))|=(((
48 Type
49 )))|=(((
50 Description
51 )))
52 |(((
53 {{{id}}}
54 )))|(((
55 String
56 )))|(((
57 Configuration id of the module license.
58 )))
59 |(% colspan="1" %)(% colspan="1" %)
60 (((
61 moduleId
62 )))|(% colspan="1" %)(% colspan="1" %)
63 (((
64 String
65 )))|(% colspan="1" %)(% colspan="1" %)
66 (((
67 The id of the module the license is for.
68 )))
69
70 = Resource Paths =
71
72 |=(% colspan="2" %)(% colspan="2" %)
73 (((
74 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses}}}
75 )))
76 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
77 (((
78 **Description**
79 )))|(((
80 Accesses all module licenses for the core server license.
81 )))
82 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
83 (((
84 **GET**
85 )))|(((
86 Gets all the module licenses for the core server license.
87 )))
88 |(% colspan="2" %)(% colspan="2" %)
89 (((
90
91 )))
92 |=(% colspan="2" %)(% colspan="2" %)
93 (((
94 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}}}}
95 )))
96 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
97 (((
98 **Description**
99 )))|(% colspan="1" %)(% colspan="1" %)
100 (((
101 Accesses a specific module license.
102 )))
103 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
104 (((
105 (% style="font-family: monospace;" %)**GET**
106 )))|(% colspan="1" %)(% colspan="1" %)
107 (((
108 Gets a specific module license.
109
110 **Parameters:**
111
112 *
113
114 {{{moduleLicenseId: The configuration id of the module license.}}}
115
116 (% style="line-height: 1.42857;" %)**Errors:**
117
118 * 404: Returned if a module license with the given id does not exist.
119 )))
120
121 = Sub/Child Resource Paths =
122
123 |=(% colspan="2" %)(% colspan="2" %)
124 (((
125 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}/properties}}}
126 )))
127 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
128 (((
129 **Description**
130 )))|(% colspan="1" %)(% colspan="1" %)
131 (((
132 Access the sub/child resource that provides the properties of the module license.
133
134 See [[doc:Module License Properties]] for more information.
135 )))
136
137 = Curl Examples =
138
139 === Get all module licenses for the given core server license ===
140
141 {{code language="bash"}}
142 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license/moduleLicenses
143 {{/code}}
144
145 === Get a specific module license ===
146
147 {{code language="bash"}}
148 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license/moduleLicenses/c5843sfb-95b6-474c-b32e-0973283ea592
149 {{/code}}
150 {{/layout-cell}}
151 {{/layout-section}}
152 {{/layout}}

Search

Navigation

iSymphony