Wiki source code of Module License Properties

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 properties REST resource allows access to the properties of a specific module licenses. Each module licenses property will specify functionality that the license allows.
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/{moduleLicenseId}/properties
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "f7814391-b894-4c04-b0ff-0877f1a93f26",
41 "key": "pbx_connections",
42 "value": "1",
43 "displayName": "PBX Connections",
44 "description": "The total amount of PBX connections allowed.",
45 "display": true
46 }
47 {{/code}}
48
49 |=(((
50 Property
51 )))|=(((
52 Type
53 )))|=(((
54 Description
55 )))
56 |(((
57 {{{id}}}
58 )))|(((
59 String
60 )))|(((
61 Configuration id of the module license property.
62 )))
63 |(% colspan="1" %)(% colspan="1" %)
64 (((
65 key
66 )))|(% colspan="1" %)(% colspan="1" %)
67 (((
68 String
69 )))|(% colspan="1" %)(% colspan="1" %)
70 (((
71 The key of the module license property.
72 )))
73 |(% colspan="1" %)(% colspan="1" %)
74 (((
75 displayName
76 )))|(% colspan="1" %)(% colspan="1" %)
77 (((
78 String
79 )))|(% colspan="1" %)(% colspan="1" %)
80 (((
81 The display name of the module license property.
82 )))
83 |(% colspan="1" %)(% colspan="1" %)
84 (((
85 description
86 )))|(% colspan="1" %)(% colspan="1" %)
87 (((
88 String
89 )))|(% colspan="1" %)(% colspan="1" %)
90 (((
91 The description of the module license property.
92 )))
93 |(% colspan="1" %)(% colspan="1" %)
94 (((
95 display
96 )))|(% colspan="1" %)(% colspan="1" %)
97 (((
98 Boolean
99 )))|(% colspan="1" %)(% colspan="1" %)
100 (((
101 Flag specifying if the property should be visible on the License activation page, in the administration interface.
102 )))
103
104 = Resource Paths =
105
106 |=(% colspan="2" %)(% colspan="2" %)
107 (((
108 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}/properties}}}
109 )))
110 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
111 (((
112 **Description**
113 )))|(((
114 Accesses all properties for the module license license.
115 )))
116 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
117 (((
118 **GET**
119 )))|(((
120 Gets all the properties for the module license.
121 )))
122 |(% colspan="2" %)(% colspan="2" %)
123 (((
124
125 )))
126 |=(% colspan="2" %)(% colspan="2" %)
127 (((
128 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}/properties/{propertyId}}}}
129 )))
130 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
131 (((
132 **Description**
133 )))|(% colspan="1" %)(% colspan="1" %)
134 (((
135 Accesses a specific module license property.
136 )))
137 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
138 (((
139 (% style="font-family: monospace;" %)**GET**
140 )))|(% colspan="1" %)(% colspan="1" %)
141 (((
142 Gets a specific module license property.
143
144 **Parameters:**
145
146 * (((
147 propertyId: The configuration id of the module license property.
148 )))
149
150 (% style="line-height: 1.42857;" %)**Errors:**
151
152 * 404: Returned if a module license property with the given id does not exist.
153 )))
154
155 = Curl Examples =
156
157 === Get all properties for the given module license ===
158
159 {{code language="bash"}}
160 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/properties
161 {{/code}}
162
163 === Get a specific module license ===
164
165 {{code language="bash"}}
166 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/properties/ab833sf5-9cb6-444c-b32e-0333283ea592
167 {{/code}}
168 {{/layout-cell}}
169 {{/layout-section}}
170 {{/layout}}

Search

Navigation

iSymphony