Skip to Content
Version 13.1 by michaely on 2016/05/28 22:23
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 (e.g. name, slug, license, ect.).
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}}}}
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 )))
132 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
133 (((
134 **GET**
135 )))|(((
136 Gets the configuration of the specified core server.
137
138 **Errors:**
139
140 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
141 )))
142 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
143 (((
144 **PUT**
145 )))|(% colspan="1" %)(% colspan="1" %)
146 (((
147 Updates the specified core server configuration.
148
149 **Errors:**
150
151 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
152 * 409 'No name provided.': Returned if no name was provided.
153 * 409 'No slug provided.': Returned if no slug was provided.
154 )))
155 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
156 (((
157 **DELETE**
158 )))|(% colspan="1" %)(% colspan="1" %)
159 (((
160 Deletes the specified core server.
161
162 **Errors:**
163
164 * 404 'A core server with the given id does not exist': Returned if no core server exists with the given id.
165 )))
166
167 = Sub/Child Resource Paths =
168
169 |=(% colspan="2" %)(% colspan="2" %)
170 (((
171 {{{communication_manager/rest/config/server/administrators/{id}/managedCoreServers}}}
172 )))
173 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
174 (((
175 **Description**
176 )))|(% colspan="1" %)(% colspan="1" %)
177 (((
178 Access the sub/child resource for the Core Server Instances that are are managed by the specified administrator.
179
180 **Parameters:**
181
182 * id: The configuration id of the administrator.
183
184 **Errors:**
185
186 * 404 'An administrator with the given id does not exist': Returned if no administrator exists with the given id.
187 )))
188
189 = Curl Examples =
190
191 === Get all administrators ===
192
193 {{code language="bash"}}
194 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/administrators
195 {{/code}}
196
197 === Get the configuration for a specific administrator ===
198
199 {{code language="bash"}}
200 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/administrators/ee828da8-5ee6-413d-82ac-1273f598659d
201 {{/code}}
202
203 === Add a new administrator ===
204
205 {{code language="bash"}}
206 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id": "ee828da8-5ee6-412d-82ac-1273f598659d", "userName": "newAdmin", "password": "d36c07e12f98bea42b1cd80bca5b5ce4d6131c68", "superUser": true}' http://localhost:58080/communication_manager/rest/config/server/administrators
207 {{/code}}
208
209 === Delete an administrator ===
210
211 {{code language="bash"}}
212 curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/server/administrators/ee828da8-5ee6-412d-82ac-1273f598659d
213 {{/code}}
214
215 === Update an administrator ===
216
217 {{code language="bash"}}
218 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id": "ee828da8-5ee6-412d-82ac-1273f598659d", "userName": "newAdmin", "password": "d36c07e12f98bea42b1cd80bca5b5ce4d6131c68", "superUser": false}' http://localhost:58080/communication_manager/rest/config/server/administrators/ee828da8-5ee6-412d-82ac-1273f598659d
219 {{/code}}
220 {{/layout-cell}}
221 {{/layout-section}}
222 {{/layout}}