Wiki source code of Core Servers

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.2+**.
10 {{/info}}
11
12 = Description =
13
14 The live core server REST resource allows access to information about a core server. There are currently no actions that can be performed on a core server. This resource simply serves as a parent resource to access other sub/child resources.
15 {{/layout-cell}}
16
17 {{layout-cell}}
18 {{panel title="On this page:"}}
19
20
21 {{toc maxLevel="2" indent="1"/}}
22 {{/panel}}
23 {{/layout-cell}}
24 {{/layout-section}}
25
26 {{layout-section ac:type="single"}}
27 {{layout-cell}}
28 (% style="color: rgb(0,0,0);" %)
29
30
31 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
32
33 {{code}}
34 {
35 "id": "11de1781-b239-4ced-bd24-7b06d4c9956b",
36 "slug": "default",
37 "name": "default"
38 }
39 {{/code}}
40
41 |=(((
42 Property
43 )))|=(((
44 Type
45 )))|=(((
46 Description
47 )))
48 |(((
49 {{{id}}}
50 )))|(((
51 String
52 )))|(((
53 The id of the core server.
54 )))
55 |(% colspan="1" %)(% colspan="1" %)
56 (((
57 slug
58 )))|(% colspan="1" %)(% colspan="1" %)
59 (((
60 String
61 )))|(% colspan="1" %)(% colspan="1" %)
62 (((
63 The directory slug of the core server.
64 )))
65 |(% colspan="1" %)(% colspan="1" %)
66 (((
67 name
68 )))|(% colspan="1" %)(% colspan="1" %)
69 (((
70 String
71 )))|(% colspan="1" %)(% colspan="1" %)
72 (((
73 The display name of the core server.
74 )))
75
76 = Root Resource Paths =
77
78 Paths used to access sets of the resource, in relation to parent resources.
79
80 |=(% colspan="2" %)(% colspan="2" %)
81 (((
82 {{{communication_manager/rest/live/coreServers}}}
83 )))
84 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
85 (((
86 **Description**
87 )))|(((
88 Accesses the state of all core servers in the system.
89 )))
90 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
91 (((
92 **GET**
93 )))|(((
94 Gets all core servers in the system.
95 )))
96
97 = (% style="color: rgb(0,0,0);" %)Instance Resource Paths(%%) =
98
99 Paths used to access a specific instance of the resource.
100
101 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
102 (((
103 {{{{root_resource_path}/{core_server_id}}}}
104 )))
105 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
106 (((
107 **Description**
108 )))|(((
109 Provides access to a specified core server, by core server id.
110
111 **Parameters:**
112
113 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above\\
114 * core_server_id: the id of the core server to access
115
116 **Errors:**
117
118 * 404 Not Found: Returned if no core server with the given id exists
119 )))
120 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
121 (((
122 **GET**
123 )))|(((
124 Gets the specified core server.
125 )))
126 |(% colspan="2" %)(% colspan="2" %)
127 (((
128
129 )))
130 |=(% colspan="2" %)(% colspan="2" %)
131 (((
132 {{{{root_resource_path}/getByName/{core_server_slug}}}}
133 )))
134 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
135 (((
136 **Description**
137 )))|(% colspan="1" %)(% colspan="1" %)
138 (((
139 Provides access to a specified core server, by core server slug.
140
141 **Parameters:**
142
143 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above\\
144 * core_server_slug: the slug of the core server to access
145
146 **Errors:**
147
148 * 404 Not Found: Returned if no core server with the given slug exists
149 )))
150 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
151 (((
152 **GET**
153 )))|(% colspan="1" %)(% colspan="1" %)
154 (((
155 Gets the specified core server.
156 )))
157
158 = Sub Resource Paths =
159
160 Paths used to access the child resources of this resource.
161
162 |=(% colspan="2" %)(% colspan="2" %)
163 (((
164 {{{{instance_resource_path}/users}}}
165 )))
166 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
167 (((
168 **Description**
169 )))|(% colspan="1" %)(% colspan="1" %)
170 (((
171 Provides access to all users in the specified core server. See [[doc:Users]].
172
173 **Parameters:**
174
175 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
176
177 **Errors:**
178
179 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
180 )))
181 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
182 (((
183 **GET**
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186 Gets all users in the specified core server.
187 )))
188 |(% colspan="2" %)(% colspan="2" %)
189 (((
190
191 )))
192 |=(% colspan="2" %)(% colspan="2" %)
193 (((
194 {{{{instance_resource_path}/extensions}}}
195 )))
196 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
197 (((
198 **Description**
199 )))|(% colspan="1" %)(% colspan="1" %)
200 (((
201 Provides access to all extensions in the specified core server. See [[doc:Extensions]].
202
203 {{info}}
204 Excludes any extensions that are not bound to a licensed/full user.
205 {{/info}}
206
207 (% style="line-height: 1.4285715;" %)**Parameters:**
208
209 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
210
211 **Errors:**
212
213 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
214 )))
215 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
216 (((
217 **GET**
218 )))|(% colspan="1" %)(% colspan="1" %)
219 (((
220 Gets all extension in the specified core server.
221 )))
222 |(% colspan="2" %)(% colspan="2" %)
223 (((
224
225 )))
226 |=(% colspan="2" %)(% colspan="2" %)
227 (((
228 {{{{instance_resource_path}/queues}}}
229 )))
230 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
231 (((
232 **Description**
233 )))|(% colspan="1" %)(% colspan="1" %)
234 (((
235 Provides access to all queues in the specified core server. See [[doc:Queues]].
236
237 {{info}}
238 Excludes any queues that are not enabled.
239 {{/info}}
240
241 (% style="line-height: 1.4285715;" %)**Parameters:**
242
243 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
244
245 **Errors:**
246
247 * 404 Not Found: Returned if no core server with the given id or slug exists
248 )))
249 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
250 (((
251 **GET**
252 )))|(% colspan="1" %)(% colspan="1" %)
253 (((
254 Gets all queues in the specified core server.
255 )))
256 |(% colspan="2" %)(% colspan="2" %)
257 (((
258
259 )))
260 |=(% colspan="2" %)(% colspan="2" %)
261 (((
262 {{{{instance_resource_path}/callSegments}}}
263 )))
264 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
265 (((
266 **Description**
267 )))|(% colspan="1" %)(% colspan="1" %)
268 (((
269 Provides access to all call segments in the specified core server. See [[doc:Call Segments]].
270
271 {{info}}
272 Excludes any call segments that are not related to an extension that is bound to a licensed/full user, or have not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
273 {{/info}}
274
275 (% style="line-height: 1.4285715;" %)**Parameters:**
276
277 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
278
279 **Errors:**
280
281 * 404 Not Found: Returned if no core server with the given id or slug exists
282 )))
283 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
284 (((
285 **GET**
286 )))|(% colspan="1" %)(% colspan="1" %)
287 (((
288 Gets all call segment in the specified core server.
289 )))
290
291 = Curl Examples =
292
293 === Get all core servers ===
294
295 {{code language="bash"}}
296 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers
297 {{/code}}
298
299 === Get a specific core server ===
300
301 {{code language="bash"}}
302 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4
303 {{/code}}
304 {{/layout-cell}}
305 {{/layout-section}}
306 {{/layout}}

Search

Navigation

iSymphony