Skip to Content

Wiki source code of Core Server

Version 5.1 by michaely on 2015/07/09 12:02
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 = Root Resource Path =
21
22 {{code}}
23  communication_manager/rest/live/coreServers
24 {{/code}}
25
26 = JSON Representation =
27
28 {{code}}
29  {
30 "id": "11de1781-b239-4ced-bd24-7b06d4c9956b",
31 "slug": "default",
32 "name": "default"
33 }
34 {{/code}}
35
36 |=(((
37 Property
38 )))|=(((
39 Type
40 )))|=(((
41 Description
42 )))
43 |(((
44 {{{id}}}
45 )))|(((
46 String
47 )))|(((
48 The id of the core server.
49 )))
50 |(% colspan="1" %)(% colspan="1" %)
51 (((
52 slug
53 )))|(% colspan="1" %)(% colspan="1" %)
54 (((
55 String
56 )))|(% colspan="1" %)(% colspan="1" %)
57 (((
58 The directory slug of the core server.
59 )))
60 |(% colspan="1" %)(% colspan="1" %)
61 (((
62 name
63 )))|(% colspan="1" %)(% colspan="1" %)
64 (((
65 String
66 )))|(% colspan="1" %)(% colspan="1" %)
67 (((
68 The display name of the core server.
69 )))
70
71 = Resource Paths =
72
73 |=(% colspan="2" %)(% colspan="2" %)
74 (((
75 {{{communication_manager/rest/live/coreServers/}}}
76 )))
77 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
78 (((
79 **Description**
80 )))|(((
81 Accesses the state of all core servers in the system.
82 )))
83 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
84 (((
85 **GET**
86 )))|(((
87 Gets the state of all core servers in the system.
88 )))
89 |(% colspan="2" %)(% colspan="2" %)
90 (((
91
92 )))
93 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
94 (((
95 {{{communication_manager/rest/live/coreServers/{core_server_id}}}}
96 )))
97 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
98 (((
99 **Description**
100 )))|(((
101 Access the state of a specific core server, by core server id.
102
103 **Parameters:**
104
105 * core_server_id: the id of the core server to access
106
107 **Errors:**
108
109 * 404 Not Found: Returned if no core server with the given id exists
110 )))
111 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
112 (((
113 **GET**
114 )))|(((
115 Gets the state of a specific core server.
116 )))
117 |(% colspan="2" %)(% colspan="2" %)
118 (((
119
120 )))
121 |=(% colspan="2" %)(% colspan="2" %)
122 (((
123 {{{communication_manager/rest/live/coreServers/getByName/{core_server_slug}}}}
124 )))
125 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
126 (((
127 **Description**
128 )))|(% colspan="1" %)(% colspan="1" %)
129 (((
130 Access the state of a specific core server, by core server slug.
131
132 **Parameters:**
133
134 * core_server_slug: the slug of the core server to access
135
136 **Errors:**
137
138 * 404 Not Found: Returned if no core server with the given slug exists
139 )))
140 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
141 (((
142 **GET**
143 )))|(% colspan="1" %)(% colspan="1" %)
144 (((
145 Gets the state of a specific core server.
146 )))
147 |(% colspan="2" %)(% colspan="2" %)
148 (((
149
150 )))
151 |=(% colspan="2" %)(% colspan="2" %)
152 (((
153 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users}}}
154 )))
155 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
156 (((
157 **Description**
158 )))|(% colspan="1" %)(% colspan="1" %)
159 (((
160 Access the sub/child resource for users,
161
162 **Parameters:**
163
164 * core_server_slug: the slug of the core server to access
165
166 **Errors:**
167
168 * 404 Not Found: Returned if no core server with the given slug exists
169 )))
170 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
171 (((
172 **GET**
173 )))|(% colspan="1" %)(% colspan="1" %)
174 (((
175
176 )))
177
178 = Resource Actions =
179
180 |=(% colspan="2" %)(% colspan="2" %)
181 (((
182 {{{path}}}
183 )))
184 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
185 (((
186 **Description**
187 )))|(((
188 description
189
190 **Parameters:**
191
192 * parameter name: parameter description
193
194 **Errors:**
195
196 * error code and message: Error description
197 )))
198 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
199 (((
200 **HTTP Method**
201 )))|(((
202 Method description
203 )))
204 |(% colspan="2" %)(% colspan="2" %)
205 (((
206
207 )))
208
209 = Curl Examples =
210
211 === Example description ===
212
213 {{code language="bash"}}
214 curl code
215 {{/code}}
216 {{/layout-cell}}
217 {{/layout-section}}
218 {{/layout}}