Skip to Content

Wiki source code of Users

Version 8.1 by michaely on 2015/07/09 12:28
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 = Description =
5
6 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.
7 {{/layout-cell}}
8
9 {{layout-cell}}
10 {{panel title="On this page:"}}
11
12
13 {{toc maxLevel="2" indent="1"/}}
14 {{/panel}}
15 {{/layout-cell}}
16 {{/layout-section}}
17
18 {{layout-section ac:type="single"}}
19 {{layout-cell}}
20 \\
21
22 = Root Resource Path =
23
24 {{code}}
25  communication_manager/rest/live/coreServers
26 {{/code}}
27
28 = JSON Representation =
29
30 {{code}}
31 {
32 "id": "11de1781-b239-4ced-bd24-7b06d4c9956b",
33 "slug": "default",
34 "name": "default"
35 }
36 {{/code}}
37
38 |=(((
39 Property
40 )))|=(((
41 Type
42 )))|=(((
43 Description
44 )))
45 |(((
46 {{{id}}}
47 )))|(((
48 String
49 )))|(((
50 The id of the core server.
51 )))
52 |(% colspan="1" %)(% colspan="1" %)
53 (((
54 slug
55 )))|(% colspan="1" %)(% colspan="1" %)
56 (((
57 String
58 )))|(% colspan="1" %)(% colspan="1" %)
59 (((
60 The directory slug of the core server.
61 )))
62 |(% colspan="1" %)(% colspan="1" %)
63 (((
64 name
65 )))|(% colspan="1" %)(% colspan="1" %)
66 (((
67 String
68 )))|(% colspan="1" %)(% colspan="1" %)
69 (((
70 The display name of the core server.
71 )))
72
73 = Resource Paths =
74
75 |=(% colspan="2" %)(% colspan="2" %)
76 (((
77 {{{communication_manager/rest/live/coreServers/}}}
78 )))
79 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
80 (((
81 **Description**
82 )))|(((
83 Accesses the state of all core servers in the system.
84 )))
85 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
86 (((
87 **GET**
88 )))|(((
89 Gets the state of all core servers in the system.
90 )))
91 |(% colspan="2" %)(% colspan="2" %)
92 (((
93
94 )))
95 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
96 (((
97 {{{communication_manager/rest/live/coreServers/{core_server_id}}}}
98 )))
99 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
100 (((
101 **Description**
102 )))|(((
103 Access the state of a specific core server, by core server id.
104
105 **Parameters:**
106
107 * core_server_id: the id of the core server to access
108
109 **Errors:**
110
111 * 404 Not Found: Returned if no core server with the given id exists
112 )))
113 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
114 (((
115 **GET**
116 )))|(((
117 Gets the state of a specific core server.
118 )))
119 |(% colspan="2" %)(% colspan="2" %)
120 (((
121
122 )))
123 |=(% colspan="2" %)(% colspan="2" %)
124 (((
125 {{{communication_manager/rest/live/coreServers/getByName/{core_server_slug}}}}
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 state of a specific core server, by core server slug.
133
134 **Parameters:**
135
136 * core_server_slug: the slug of the core server to access
137
138 **Errors:**
139
140 * 404 Not Found: Returned if no core server with the given slug exists
141 )))
142 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
143 (((
144 **GET**
145 )))|(% colspan="1" %)(% colspan="1" %)
146 (((
147 Gets the state of a specific core server.
148 )))
149 |(% colspan="2" %)(% colspan="2" %)
150 (((
151
152 )))
153 |=(% colspan="2" %)(% colspan="2" %)
154 (((
155 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users}}}
156 )))
157 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
158 (((
159 **Description**
160 )))|(% colspan="1" %)(% colspan="1" %)
161 (((
162 Access the sub/child resource for users, in a specific core server.
163
164 **Parameters:**
165
166 * core_server_id: the id of the parent core server\\
167 * core_server_slug: the slug of the parent core server
168
169 **Errors:**
170
171 * 404 Not Found: Returned if no core server with the given id or slug exists
172 )))
173 |(% colspan="2" %)(% colspan="2" %)
174 (((
175
176 )))
177 |=(% colspan="2" %)(% colspan="2" %)
178 (((
179 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions}}}
180 )))
181 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
182 (((
183 **Description**
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186 Access the sub/child resource for extensions, in a specific core server.
187
188 **Parameters:**
189
190 * core_server_id: the id of the parent core server\\
191 * core_server_slug: the slug of the parent core server
192
193 **Errors:**
194
195 * 404 Not Found: Returned if no core server with the given id or slug exists
196 )))
197 |(% colspan="2" %)(% colspan="2" %)
198 (((
199
200 )))
201 |=(% colspan="2" %)(% colspan="2" %)
202 (((
203 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/queues}}}
204 )))
205 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
206 (((
207 **Description**
208 )))|(% colspan="1" %)(% colspan="1" %)
209 (((
210 Access the sub/child resource for queues, in a specific core server.
211
212 **Parameters:**
213
214 * core_server_id: the id of the parent core server\\
215 * core_server_slug: the slug of the parent core server
216
217 **Errors:**
218
219 * 404 Not Found: Returned if no core server with the given id or slug exists
220 )))
221 |(% colspan="2" %)(% colspan="2" %)
222 (((
223
224 )))
225 |=(% colspan="2" %)(% colspan="2" %)
226 (((
227 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments}}}
228 )))
229 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
230 (((
231 **Description**
232 )))|(% colspan="1" %)(% colspan="1" %)
233 (((
234 Access the sub/child resource for call segments, in a specific core server.
235
236 **Parameters:**
237
238 * core_server_id: the id of the parent core server\\
239 * core_server_slug: the slug of the parent core server
240
241 **Errors:**
242
243 * 404 Not Found: Returned if no core server with the given id or slug exists
244 )))
245
246 =
247 Curl Examples =
248
249 === Get the state of all core servers ===
250
251 {{code language="bash"}}
252 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers
253 {{/code}}
254
255 === Get the state of a specific core server ===
256
257 {{code language="bash"}}
258 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4
259 {{/code}}
260 {{/layout-cell}}
261 {{/layout-section}}
262 {{/layout}}