Skip to Content
Version 8.1 by michaely on 2016/05/29 14:15
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 core server instance REST resource allows access to the top level configuration for core servers. This resource allows adding, removing, and editing of core servers in the system.
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
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "0a576628-502c-491a-9d49-670bbb79cfee",
41 "slug": "default",
42 "name": "default"
43 }
44 {{/code}}
45
46 |=(((
47 Property
48 )))|=(((
49 Type
50 )))|=(((
51 Description
52 )))
53 |(((
54 {{{id}}}
55 )))|(((
56 String
57 )))|(((
58 The id of the core server.
59 )))
60 |(% colspan="1" %)(% colspan="1" %)
61 (((
62 slug
63 )))|(% colspan="1" %)(% colspan="1" %)
64 (((
65 String
66 )))|(% colspan="1" %)(% colspan="1" %)
67 (((
68 The slug (core server configuration directory name) of the core server.
69 )))
70 |(% colspan="1" %)(% colspan="1" %)
71 (((
72 name
73 )))|(% colspan="1" %)(% colspan="1" %)
74 (((
75 String
76 )))|(% colspan="1" %)(% colspan="1" %)
77 (((
78 The display name of the core server.
79 )))
80
81 == Resource Paths ==
82
83 |=(% colspan="2" %)(% colspan="2" %)
84 (((
85 {{{communication_manager/rest/config/server/coreServers}}}
86 )))
87 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
88 (((
89 **Description**
90 )))|(((
91 Accesses all the core server instances in the system.
92 )))
93 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
94 (((
95 **GET**
96 )))|(((
97 Gets all the core server instances in the system.
98 )))
99 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
100 (((
101 **POST
102 **
103 )))|(% colspan="1" %)(% colspan="1" %)
104 (((
105 Adds a core server to the configuration.
106
107 (% style="line-height: 1.42857;" %)**Errors:**
108
109 * 409 'A core server with the given id already exists.': Returned if an core server with the given id already exists.
110 * 409 'A core server with the given slug already exists.': Returned if an core server with the given slug already exists.
111 * 409 'No name provided.': Returned if no name was provided.
112 * 409 'No slug provided.': Returned if no slug was provided.
113 )))
114 |(% colspan="2" %)(% colspan="2" %)
115 (((
116
117 )))
118 |=(% colspan="2" %)(% colspan="2" %)
119 (((
120 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]}}}
121 )))
122 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
123 (((
124 **Description**
125 )))|(((
126 Accesses the configuration of a specific core server instance.
127
128 **Parameters:**
129
130 * id: The configuration id of the core server instance.
131 * slug : The slug of the core server instance.
132 )))
133 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
134 (((
135 **GET**
136 )))|(((
137 Gets the configuration of the specified core server.
138
139 **Errors:**
140
141 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
142 * 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.
143 )))
144 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
145 (((
146 **PUT**
147 )))|(% colspan="1" %)(% colspan="1" %)
148 (((
149 Updates the specified core server configuration.
150
151 **Errors:**
152
153 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
154 * 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.
155 * 409 'No name provided.': Returned if no name was provided.
156 * 409 'No slug provided.': Returned if no slug was provided.
157 )))
158 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
159 (((
160 **DELETE**
161 )))|(% colspan="1" %)(% colspan="1" %)
162 (((
163 Deletes the specified core server.
164
165 **Errors:**
166
167 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
168 * 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.
169 )))
170
171 = Sub/Child Resource Paths =
172
173 |=(% colspan="2" %)(% colspan="2" %)
174 (((
175 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/managingAdministrators}}}
176 )))
177 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
178 (((
179 **Description**
180 )))|(% colspan="1" %)(% colspan="1" %)
181 (((
182 Access the sub/child resource for the Administrators that manage the specified core server instance.
183
184 **Parameters:**
185
186 * id: The configuration id of the core server instance.
187 * slug : The slug of the core server instance.
188
189 **Errors:**
190
191 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
192 * 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.
193 )))
194 |(% colspan="2" %)(% colspan="2" %)
195 (((
196
197 )))
198 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
199 (((
200 {{{communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license}}}
201 )))
202 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
203 (((
204 **Description**
205 )))|(% colspan="1" %)(% colspan="1" %)
206 (((
207 Access the sub/child resource for the License of the specified core server instance.
208
209 **Parameters:**
210
211 * id: The configuration id of the core server instance.
212 * slug : The slug of the core server instance.
213
214 **Errors:**
215
216 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
217 * 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.
218 )))
219
220 = Curl Examples =
221
222 === Get all core server instances ===
223
224 {{code language="bash"}}
225 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers
226 {{/code}}
227
228 === Get the configuration for a specific core server instance ===
229
230 {{code language="bash"}}
231 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/ee828da8-5ee6-413d-82ac-1273f598659d
232 {{/code}}
233
234 === Add a new core server instance ===
235
236 {{code language="bash"}}
237 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id": "0a576628-502c-491a-9d59-670bbb79cfee", "slug": "new_server", "name": "newServer"}' http://localhost:58080/communication_manager/rest/config/server/coreServers
238 {{/code}}
239
240 === Delete a core server instance ===
241
242 {{code language="bash"}}
243 curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/server/coreServers/0a576628-502c-491a-9d59-670bbb79cfee
244 {{/code}}
245
246 === Update a core server instance ===
247
248 {{code language="bash"}}
249 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id": "0a576628-502c-491a-9d59-670bbb79cfee", "slug": "new_server", "name": "newName"}' http://localhost:58080/communication_manager/rest/config/server/coreServers/0a576628-502c-491a-9d59-670bbb79cfee
250 {{/code}}
251 {{/layout-cell}}
252 {{/layout-section}}
253 {{/layout}}