source: admin/WebConsole/rest/opengnsys-api.html @ ac8b234e

918-git-images-111dconfigfileconfigure-oglivegit-imageslgromero-new-oglivemainmaint-cronmount-efivarfsmultivmmultivm-ogboot-installerogClonningEngineogboot-installer-jenkinsoglive-ipv6test-python-scriptsticket-301ticket-50ticket-50-oldticket-577ticket-585ticket-611ticket-612ticket-693ticket-700ubu24tplunification2use-local-agent-oglivevarios-instalacionwebconsole3
Last change on this file since ac8b234e was ac8b234e, checked in by ramon <ramongomez@…>, 9 years ago

#708: Incluir documentación de la API REST (aún no terminada), usando fichero YAML como base para generar la página HTML con el editor de Swagger.

git-svn-id: https://opengnsys.es/svn/branches/version1.1@5016 a21b9725-9963-47de-94b9-378ad31fedc9
  • Property mode set to 100644
File size: 41.8 KB
Line 
1<!doctype html>
2<html>
3  <head>
4    <title>OpenGnsys Server REST API</title>
5    <style type="text/css">
6      body {
7        font-family: Trebuchet MS, sans-serif;
8        font-size: 15px;
9        color: #444;
10        margin-right: 24px;
11}
12
13h1      {
14        font-size: 25px;
15}
16h2      {
17        font-size: 20px;
18}
19h3      {
20        font-size: 16px;
21        font-weight: bold;
22}
23hr      {
24        height: 1px;
25        border: 0;
26        color: #ddd;
27        background-color: #ddd;
28        display: none;
29}
30
31.app-desc {
32  clear: both;
33  margin-left: 20px;
34}
35.param-name {
36  width: 100%;
37}
38.license-info {
39  margin-left: 20px;
40}
41
42.license-url {
43  margin-left: 20px;
44}
45
46.model {
47  margin: 0 0 0px 20px;
48}
49
50.method {
51  margin-left: 20px;
52}
53
54.method-notes   {
55        margin: 10px 0 20px 0;
56        font-size: 90%;
57        color: #555;
58}
59
60pre {
61  padding: 10px;
62  margin-bottom: 2px;
63}
64
65.http-method {
66 text-transform: uppercase;
67}
68
69pre.get {
70  background-color: #0f6ab4;
71}
72
73pre.post {
74  background-color: #10a54a;
75}
76
77pre.put {
78  background-color: #c5862b;
79}
80
81pre.delete {
82  background-color: #a41e22;
83}
84
85.huge   {
86        color: #fff;
87}
88
89pre.example {
90  background-color: #f3f3f3;
91  padding: 10px;
92  border: 1px solid #ddd;
93}
94
95code {
96  white-space: pre;
97}
98
99.nickname {
100  font-weight: bold;
101}
102
103.method-path {
104  font-size: 1.5em;
105  background-color: #0f6ab4;
106}
107
108.up {
109  float:right;
110}
111
112.parameter {
113  width: 500px;
114}
115
116.param {
117  width: 500px;
118  padding: 10px 0 0 20px;
119  font-weight: bold;
120}
121
122.param-desc {
123  width: 700px;
124  padding: 0 0 0 20px;
125  color: #777;
126}
127
128.param-type {
129  font-style: italic;
130}
131
132.param-enum-header {
133width: 700px;
134padding: 0 0 0 60px;
135color: #777;
136font-weight: bold;
137}
138
139.param-enum {
140width: 700px;
141padding: 0 0 0 80px;
142color: #777;
143font-style: italic;
144}
145
146.field-label {
147  padding: 0;
148  margin: 0;
149  clear: both;
150}
151
152.field-items    {
153        padding: 0 0 15px 0;
154        margin-bottom: 15px;
155}
156
157.return-type {
158  clear: both;
159  padding-bottom: 10px;
160}
161
162.param-header {
163  font-weight: bold;
164}
165
166.method-tags {
167  text-align: right;
168}
169
170.method-tag {
171  background: none repeat scroll 0% 0% #24A600;
172  border-radius: 3px;
173  padding: 2px 10px;
174  margin: 2px;
175  color: #FFF;
176  display: inline-block;
177  text-decoration: none;
178}
179    </style>
180  </head>
181  <body>
182  <h1>OpenGnsys Server REST API</h1>
183    <div class="app-desc">Information about OpenGnsys Server REST API functions. </div>
184    <div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div>
185    <div class="app-desc">Contact Info: <a href="hello@helloreverb.com">hello@helloreverb.com</a></div>
186    <div class="app-desc">Version: 1.1.0</div>
187    <div class="app-desc">BasePath:/rest</div>
188    <div class="license-info">Creative Commons 4.0 International</div>
189    <div class="license-url">http://creativecommons.org/licenses/by/4.0/</div>
190  <h2>Access</h2>
191    <ol>
192      <li>APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true</li>
193    </ol>
194
195  <h2><a name="__Methods">Methods</a></h2>
196  [ Jump to <a href="#__Models">Models</a> ]
197
198  <h2>Table of Contents </h2>
199  <div class="method-summary"></div>
200  <ol>
201  <li><a href="#ousOuidLabsLabidClientsClientidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></a></li>
202  <li><a href="#ousOuidLabsLabidClientsClientidHardwareGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></a></li>
203  <li><a href="#ousOuidLabsLabidClientsClientidStatusGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></a></li>
204  <li><a href="#ousOuidLabsLabidClientsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></a></li>
205  <li><a href="#ousOuidLabsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs</code></a></li>
206  <li><a href="#ousOuidLabsLabidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></a></li>
207  <li><a href="#ousGet"><code><span class="http-method">get</span> /ous</code></a></li>
208  <li><a href="#ousOuidGet"><code><span class="http-method">get</span> /ous/{ouid}</code></a></li>
209  <li><a href="#ousOuidReposGet"><code><span class="http-method">get</span> /ous/{ouid}/repos</code></a></li>
210  <li><a href="#ousOuidReposRepoidGet"><code><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></a></li>
211  <li><a href="#loginPost"><code><span class="http-method">post</span> /login</code></a></li>
212  </ol>
213
214  <div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
215    <div class="method-path">
216    <a class="up" href="#__Methods">Up</a>
217    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
218    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
219    <div class="method-notes">Get a &#x60;client&#x60; object.</div>
220
221    <h3 class="field-label">Path parameters</h3>
222    <div class="field-items">
223      <div class="param">ouid (required)</div>
224
225      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
226
227      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
228
229      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
230    </div>  <!-- field-items -->
231
232    <h3 class="field-label">Consumes</h3>
233    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
234    <ul>
235      <li><code>application/json</code></li>
236    </ul>
237
238
239
240
241
242    <h3 class="field-label">Return type</h3>
243    <div class="return-type">
244      <a href="#inline_response_200_6">inline_response_200_6</a>
245     
246    </div>
247
248    <!--Todo: process Response Object and its headers, schema, examples -->
249
250    <h3 class="field-label">Example data</h3>
251    <div class="example-data-content-type">Content-Type: application/json</div>
252    <pre class="example"><code>{
253  "image" : "aeiou",
254  "routerip" : "aeiou",
255  "boottype" : "aeiou",
256  "ip" : "aeiou",
257  "repo" : {
258    "id" : ""
259  },
260  "netdriver" : "aeiou",
261  "netiface" : "aeiou",
262  "mac" : "aeiou",
263  "serialno" : "aeiou",
264  "netmask" : "aeiou",
265  "name" : "aeiou",
266  "id" : "",
267  "validation" : true
268}</code></pre>
269
270    <h3 class="field-label">Produces</h3>
271    This API call produces the following media types according to the <span class="header">Accept</span> request header;
272    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
273    <ul>
274      <li><code>application/json</code></li>
275    </ul>
276
277    <h3 class="field-label">Responses</h3>
278    <h4 class="field-label">200</h4>
279    Successful response
280        <a href="#inline_response_200_6">inline_response_200_6</a>
281  </div> <!-- method -->
282  <hr/>
283  <div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
284    <div class="method-path">
285    <a class="up" href="#__Methods">Up</a>
286    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
287    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
288    <div class="method-notes">Get the hardware definition of a &#x60;client&#x60; object.</div>
289
290    <h3 class="field-label">Path parameters</h3>
291    <div class="field-items">
292      <div class="param">ouid (required)</div>
293
294      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
295
296      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
297
298      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
299    </div>  <!-- field-items -->
300
301    <h3 class="field-label">Consumes</h3>
302    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
303    <ul>
304      <li><code>application/json</code></li>
305    </ul>
306
307
308
309
310
311    <h3 class="field-label">Return type</h3>
312    <div class="return-type">
313      <a href="#inline_response_200_7">inline_response_200_7</a>
314     
315    </div>
316
317    <!--Todo: process Response Object and its headers, schema, examples -->
318
319    <h3 class="field-label">Example data</h3>
320    <div class="example-data-content-type">Content-Type: application/json</div>
321    <pre class="example"><code>{
322  "name" : "aeiou",
323  "id" : "",
324  "hardware" : [ {
325    "description" : "aeiou",
326    "type" : "aeiou"
327  } ]
328}</code></pre>
329
330    <h3 class="field-label">Produces</h3>
331    This API call produces the following media types according to the <span class="header">Accept</span> request header;
332    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
333    <ul>
334      <li><code>application/json</code></li>
335    </ul>
336
337    <h3 class="field-label">Responses</h3>
338    <h4 class="field-label">200</h4>
339    Successful response
340        <a href="#inline_response_200_7">inline_response_200_7</a>
341  </div> <!-- method -->
342  <hr/>
343  <div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
344    <div class="method-path">
345    <a class="up" href="#__Methods">Up</a>
346    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
347    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
348    <div class="method-notes">Get execution status of a &#x60;client&#x60;</div>
349
350    <h3 class="field-label">Path parameters</h3>
351    <div class="field-items">
352      <div class="param">ouid (required)</div>
353
354      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
355
356      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
357
358      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
359    </div>  <!-- field-items -->
360
361    <h3 class="field-label">Consumes</h3>
362    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
363    <ul>
364      <li><code>application/json</code></li>
365    </ul>
366
367
368
369
370
371    <h3 class="field-label">Return type</h3>
372    <div class="return-type">
373      <a href="#inline_response_200_8">inline_response_200_8</a>
374     
375    </div>
376
377    <!--Todo: process Response Object and its headers, schema, examples -->
378
379    <h3 class="field-label">Example data</h3>
380    <div class="example-data-content-type">Content-Type: application/json</div>
381    <pre class="example"><code>{
382  "ip" : "aeiou",
383  "id" : "",
384  "status" : "aeiou"
385}</code></pre>
386
387    <h3 class="field-label">Produces</h3>
388    This API call produces the following media types according to the <span class="header">Accept</span> request header;
389    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
390    <ul>
391      <li><code>application/json</code></li>
392    </ul>
393
394    <h3 class="field-label">Responses</h3>
395    <h4 class="field-label">200</h4>
396    Successful response
397        <a href="#inline_response_200_8">inline_response_200_8</a>
398  </div> <!-- method -->
399  <hr/>
400  <div class="method"><a name="ousOuidLabsLabidClientsGet"/>
401    <div class="method-path">
402    <a class="up" href="#__Methods">Up</a>
403    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
404    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
405    <div class="method-notes">Get all &#x60;client&#x60; objects defined in an &#x60;lab&#x60;.</div>
406
407    <h3 class="field-label">Path parameters</h3>
408    <div class="field-items">
409      <div class="param">ouid (required)</div>
410
411      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
412
413      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div>
414    </div>  <!-- field-items -->
415
416    <h3 class="field-label">Consumes</h3>
417    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
418    <ul>
419      <li><code>application/json</code></li>
420    </ul>
421
422
423
424
425
426    <h3 class="field-label">Return type</h3>
427    <div class="return-type">
428      array[<a href="#inline_response_200_5">inline_response_200_5</a>]
429     
430    </div>
431
432    <!--Todo: process Response Object and its headers, schema, examples -->
433
434    <h3 class="field-label">Example data</h3>
435    <div class="example-data-content-type">Content-Type: application/json</div>
436    <pre class="example"><code>[ {
437  "ou" : {
438    "id" : ""
439  },
440  "name" : "aeiou",
441  "id" : "",
442  "lab" : ""
443} ]</code></pre>
444
445    <h3 class="field-label">Produces</h3>
446    This API call produces the following media types according to the <span class="header">Accept</span> request header;
447    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
448    <ul>
449      <li><code>application/json</code></li>
450    </ul>
451
452    <h3 class="field-label">Responses</h3>
453    <h4 class="field-label">200</h4>
454    Successful response
455       
456  </div> <!-- method -->
457  <hr/>
458  <div class="method"><a name="ousOuidLabsGet"/>
459    <div class="method-path">
460    <a class="up" href="#__Methods">Up</a>
461    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
462    <div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
463    <div class="method-notes">Get all &#x60;lab&#x60; objects defined in an &#x60;OU&#x60;.</div>
464
465    <h3 class="field-label">Path parameters</h3>
466    <div class="field-items">
467      <div class="param">ouid (required)</div>
468
469      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
470    </div>  <!-- field-items -->
471
472    <h3 class="field-label">Consumes</h3>
473    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
474    <ul>
475      <li><code>application/json</code></li>
476    </ul>
477
478
479
480
481
482    <h3 class="field-label">Return type</h3>
483    <div class="return-type">
484      array[<a href="#inline_response_200_3">inline_response_200_3</a>]
485     
486    </div>
487
488    <!--Todo: process Response Object and its headers, schema, examples -->
489
490    <h3 class="field-label">Example data</h3>
491    <div class="example-data-content-type">Content-Type: application/json</div>
492    <pre class="example"><code>[ {
493  "ou" : {
494    "id" : ""
495  },
496  "name" : "aeiou",
497  "id" : "",
498  "inremotepc" : true
499} ]</code></pre>
500
501    <h3 class="field-label">Produces</h3>
502    This API call produces the following media types according to the <span class="header">Accept</span> request header;
503    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
504    <ul>
505      <li><code>application/json</code></li>
506    </ul>
507
508    <h3 class="field-label">Responses</h3>
509    <h4 class="field-label">200</h4>
510    Successful response
511       
512  </div> <!-- method -->
513  <hr/>
514  <div class="method"><a name="ousOuidLabsLabidGet"/>
515    <div class="method-path">
516    <a class="up" href="#__Methods">Up</a>
517    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
518    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
519    <div class="method-notes">Get a &#x60;lab&#x60; object.</div>
520
521    <h3 class="field-label">Path parameters</h3>
522    <div class="field-items">
523      <div class="param">ouid (required)</div>
524
525      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
526
527      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; laboratory identificator </div>
528    </div>  <!-- field-items -->
529
530    <h3 class="field-label">Consumes</h3>
531    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
532    <ul>
533      <li><code>application/json</code></li>
534    </ul>
535
536
537
538
539
540    <h3 class="field-label">Return type</h3>
541    <div class="return-type">
542      <a href="#inline_response_200_4">inline_response_200_4</a>
543     
544    </div>
545
546    <!--Todo: process Response Object and its headers, schema, examples -->
547
548    <h3 class="field-label">Example data</h3>
549    <div class="example-data-content-type">Content-Type: application/json</div>
550    <pre class="example"><code>{
551  "image" : "aeiou",
552  "routerip" : "aeiou",
553  "mcastport" : "",
554  "proxyurl" : "aeiou",
555  "dns" : "aeiou",
556  "mcastmode" : "aeiou",
557  "description" : "aeiou",
558  "inremotepc" : true,
559  "ntp" : "aeiou",
560  "mcastspeed" : "",
561  "capacity" : "",
562  "defclients" : "",
563  "mcastip" : "aeiou",
564  "projector" : true,
565  "netmask" : "aeiou",
566  "p2ptime" : "",
567  "name" : "aeiou",
568  "p2pmode" : "aeiou",
569  "location" : "aeiou",
570  "id" : "",
571  "board" : true
572}</code></pre>
573
574    <h3 class="field-label">Produces</h3>
575    This API call produces the following media types according to the <span class="header">Accept</span> request header;
576    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
577    <ul>
578      <li><code>application/json</code></li>
579    </ul>
580
581    <h3 class="field-label">Responses</h3>
582    <h4 class="field-label">200</h4>
583    Successful response
584        <a href="#inline_response_200_4">inline_response_200_4</a>
585  </div> <!-- method -->
586  <hr/>
587  <div class="method"><a name="ousGet"/>
588    <div class="method-path">
589    <a class="up" href="#__Methods">Up</a>
590    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
591    <div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
592    <div class="method-notes">Gets all &#x60;OU&#x60; objects.</div>
593
594
595    <h3 class="field-label">Consumes</h3>
596    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
597    <ul>
598      <li><code>application/json</code></li>
599    </ul>
600
601
602
603
604
605    <h3 class="field-label">Return type</h3>
606    <div class="return-type">
607      array[<a href="#inline_response_200_1">inline_response_200_1</a>]
608     
609    </div>
610
611    <!--Todo: process Response Object and its headers, schema, examples -->
612
613    <h3 class="field-label">Example data</h3>
614    <div class="example-data-content-type">Content-Type: application/json</div>
615    <pre class="example"><code>[ {
616  "name" : "aeiou",
617  "id" : ""
618} ]</code></pre>
619
620    <h3 class="field-label">Produces</h3>
621    This API call produces the following media types according to the <span class="header">Accept</span> request header;
622    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
623    <ul>
624      <li><code>application/json</code></li>
625    </ul>
626
627    <h3 class="field-label">Responses</h3>
628    <h4 class="field-label">200</h4>
629    Successful response
630       
631  </div> <!-- method -->
632  <hr/>
633  <div class="method"><a name="ousOuidGet"/>
634    <div class="method-path">
635    <a class="up" href="#__Methods">Up</a>
636    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
637    <div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
638    <div class="method-notes">Get an &#x60;OU&#x60; object.</div>
639
640    <h3 class="field-label">Path parameters</h3>
641    <div class="field-items">
642      <div class="param">ouid (required)</div>
643
644      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Organization Unit identificator </div>
645    </div>  <!-- field-items -->
646
647    <h3 class="field-label">Consumes</h3>
648    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
649    <ul>
650      <li><code>application/json</code></li>
651    </ul>
652
653
654
655
656
657    <h3 class="field-label">Return type</h3>
658    <div class="return-type">
659      <a href="#inline_response_200_2">inline_response_200_2</a>
660     
661    </div>
662
663    <!--Todo: process Response Object and its headers, schema, examples -->
664
665    <h3 class="field-label">Example data</h3>
666    <div class="example-data-content-type">Content-Type: application/json</div>
667    <pre class="example"><code>{
668  "name" : "aeiou",
669  "description" : "aeiou",
670  "id" : ""
671}</code></pre>
672
673    <h3 class="field-label">Produces</h3>
674    This API call produces the following media types according to the <span class="header">Accept</span> request header;
675    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
676    <ul>
677      <li><code>application/json</code></li>
678    </ul>
679
680    <h3 class="field-label">Responses</h3>
681    <h4 class="field-label">200</h4>
682    Successful response
683        <a href="#inline_response_200_2">inline_response_200_2</a>
684  </div> <!-- method -->
685  <hr/>
686  <div class="method"><a name="ousOuidReposGet"/>
687    <div class="method-path">
688    <a class="up" href="#__Methods">Up</a>
689    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
690    <div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
691    <div class="method-notes">Get all &#x60;repo&#x60; objects defined in an &#x60;OU&#x60;.</div>
692
693    <h3 class="field-label">Path parameters</h3>
694    <div class="field-items">
695      <div class="param">ouid (required)</div>
696
697      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
698    </div>  <!-- field-items -->
699
700    <h3 class="field-label">Consumes</h3>
701    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
702    <ul>
703      <li><code>application/json</code></li>
704    </ul>
705
706
707
708
709
710    <h3 class="field-label">Return type</h3>
711    <div class="return-type">
712      array[<a href="#inline_response_200_9">inline_response_200_9</a>]
713     
714    </div>
715
716    <!--Todo: process Response Object and its headers, schema, examples -->
717
718    <h3 class="field-label">Example data</h3>
719    <div class="example-data-content-type">Content-Type: application/json</div>
720    <pre class="example"><code>[ {
721  "ou" : {
722    "id" : ""
723  },
724  "name" : "aeiou",
725  "id" : ""
726} ]</code></pre>
727
728    <h3 class="field-label">Produces</h3>
729    This API call produces the following media types according to the <span class="header">Accept</span> request header;
730    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
731    <ul>
732      <li><code>application/json</code></li>
733    </ul>
734
735    <h3 class="field-label">Responses</h3>
736    <h4 class="field-label">200</h4>
737    Successful response
738       
739  </div> <!-- method -->
740  <hr/>
741  <div class="method"><a name="ousOuidReposRepoidGet"/>
742    <div class="method-path">
743    <a class="up" href="#__Methods">Up</a>
744    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
745    <div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
746    <div class="method-notes">Get a &#x60;repo&#x60; object.</div>
747
748    <h3 class="field-label">Path parameters</h3>
749    <div class="field-items">
750      <div class="param">ouid (required)</div>
751
752      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">repoid (required)</div>
753
754      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; repository identificator </div>
755    </div>  <!-- field-items -->
756
757    <h3 class="field-label">Consumes</h3>
758    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
759    <ul>
760      <li><code>application/json</code></li>
761    </ul>
762
763
764
765
766
767    <h3 class="field-label">Return type</h3>
768    <div class="return-type">
769      <a href="#inline_response_200_10">inline_response_200_10</a>
770     
771    </div>
772
773    <!--Todo: process Response Object and its headers, schema, examples -->
774
775    <h3 class="field-label">Example data</h3>
776    <div class="example-data-content-type">Content-Type: application/json</div>
777    <pre class="example"><code>{
778  "ip" : "aeiou",
779  "name" : "aeiou",
780  "description" : "aeiou",
781  "id" : ""
782}</code></pre>
783
784    <h3 class="field-label">Produces</h3>
785    This API call produces the following media types according to the <span class="header">Accept</span> request header;
786    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
787    <ul>
788      <li><code>application/json</code></li>
789    </ul>
790
791    <h3 class="field-label">Responses</h3>
792    <h4 class="field-label">200</h4>
793    Successful response
794        <a href="#inline_response_200_10">inline_response_200_10</a>
795  </div> <!-- method -->
796  <hr/>
797  <div class="method"><a name="loginPost"/>
798    <div class="method-path">
799    <a class="up" href="#__Methods">Up</a>
800    <pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
801    <div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
802    <div class="method-notes">Check user login and returns his/her API key.</div>
803
804
805    <h3 class="field-label">Consumes</h3>
806    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
807    <ul>
808      <li><code>application/json</code></li>
809    </ul>
810
811    <h3 class="field-label">Request body</h3>
812    <div class="field-items">
813      <div class="param">authdata (required)</div>
814
815      <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; JSON authentication data </div>
816    </div>  <!-- field-items -->
817
818
819
820
821    <h3 class="field-label">Return type</h3>
822    <div class="return-type">
823      <a href="#inline_response_200">inline_response_200</a>
824     
825    </div>
826
827    <!--Todo: process Response Object and its headers, schema, examples -->
828
829    <h3 class="field-label">Example data</h3>
830    <div class="example-data-content-type">Content-Type: application/json</div>
831    <pre class="example"><code>{
832  "apikey" : "aeiou",
833  "userid" : ""
834}</code></pre>
835
836    <h3 class="field-label">Produces</h3>
837    This API call produces the following media types according to the <span class="header">Accept</span> request header;
838    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
839    <ul>
840      <li><code>application/json</code></li>
841    </ul>
842
843    <h3 class="field-label">Responses</h3>
844    <h4 class="field-label">200</h4>
845    Successful login
846        <a href="#inline_response_200">inline_response_200</a>
847    <h4 class="field-label">400</h4>
848    Missing parameters
849        <a href="#"></a>
850    <h4 class="field-label">500</h4>
851    Authentication error
852        <a href="#"></a>
853  </div> <!-- method -->
854  <hr/>
855
856  <div class="up"><a href="#__Models">Up</a></div>
857  <h2><a name="__Models">Models</a></h2>
858  [ Jump to <a href="#__Methods">Methods</a> ]
859
860  <h2>Table of Contents</h2>
861  <ol>
862    <li><a href="#authdata"><code>authdata</code></a></li>
863    <li><a href="#inline_response_200"><code>inline_response_200</code></a></li>
864    <li><a href="#inline_response_200_1"><code>inline_response_200_1</code></a></li>
865    <li><a href="#inline_response_200_10"><code>inline_response_200_10</code></a></li>
866    <li><a href="#inline_response_200_2"><code>inline_response_200_2</code></a></li>
867    <li><a href="#inline_response_200_3"><code>inline_response_200_3</code></a></li>
868    <li><a href="#inline_response_200_4"><code>inline_response_200_4</code></a></li>
869    <li><a href="#inline_response_200_5"><code>inline_response_200_5</code></a></li>
870    <li><a href="#inline_response_200_6"><code>inline_response_200_6</code></a></li>
871    <li><a href="#inline_response_200_6_repo"><code>inline_response_200_6_repo</code></a></li>
872    <li><a href="#inline_response_200_7"><code>inline_response_200_7</code></a></li>
873    <li><a href="#inline_response_200_7_hardware"><code>inline_response_200_7_hardware</code></a></li>
874    <li><a href="#inline_response_200_8"><code>inline_response_200_8</code></a></li>
875    <li><a href="#inline_response_200_9"><code>inline_response_200_9</code></a></li>
876    <li><a href="#ousouidlabs_ou"><code>ousouidlabs_ou</code></a></li>
877  </ol>
878
879  <div class="model">
880    <h3 class="field-label"><a name="authdata">authdata</a> <a class="up" href="#__Models">Up</a></h3>
881    <div class="field-items">
882      <div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
883<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
884    </div>  <!-- field-items -->
885  </div>
886  <div class="model">
887    <h3 class="field-label"><a name="inline_response_200">inline_response_200</a> <a class="up" href="#__Models">Up</a></h3>
888    <div class="field-items">
889      <div class="param">userid (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
890<div class="param">apikey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
891    </div>  <!-- field-items -->
892  </div>
893  <div class="model">
894    <h3 class="field-label"><a name="inline_response_200_1">inline_response_200_1</a> <a class="up" href="#__Models">Up</a></h3>
895    <div class="field-items">
896      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
897<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
898    </div>  <!-- field-items -->
899  </div>
900  <div class="model">
901    <h3 class="field-label"><a name="inline_response_200_10">inline_response_200_10</a> <a class="up" href="#__Models">Up</a></h3>
902    <div class="field-items">
903      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> repository id </div>
904<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository name </div>
905<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository description </div>
906<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository IP address </div>
907    </div>  <!-- field-items -->
908  </div>
909  <div class="model">
910    <h3 class="field-label"><a name="inline_response_200_2">inline_response_200_2</a> <a class="up" href="#__Models">Up</a></h3>
911    <div class="field-items">
912      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
913<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
914<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
915    </div>  <!-- field-items -->
916  </div>
917  <div class="model">
918    <h3 class="field-label"><a name="inline_response_200_3">inline_response_200_3</a> <a class="up" href="#__Models">Up</a></h3>
919    <div class="field-items">
920      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
921<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
922<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span>  </div>
923<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidlabs_ou">ousouidlabs_ou</a></span>  </div>
924    </div>  <!-- field-items -->
925  </div>
926  <div class="model">
927    <h3 class="field-label"><a name="inline_response_200_4">inline_response_200_4</a> <a class="up" href="#__Models">Up</a></h3>
928    <div class="field-items">
929      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> laboratory identificator </div>
930<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory name </div>
931<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory location </div>
932<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory description </div>
933<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> check if this lab will be included in Remote PC Project </div>
934<div class="param">capacity (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> maximum number of people in the lab </div>
935<div class="param">defclients (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> number of defined clients in the lab </div>
936<div class="param">projector (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> check if this lab has a projector </div>
937<div class="param">board (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> check if this lab has an electronic board </div>
938<div class="param">routerip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> lab router IP address </div>
939<div class="param">netmask (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> network mask to use in the lab </div>
940<div class="param">ntp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> NTP server IP address </div>
941<div class="param">dns (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> DNS server IP address </div>
942<div class="param">proxyurl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Proxy server URL </div>
943<div class="param">mcastmode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast protocol mode (\&quot;full-duplex\&quot;, \&quot;half-duplex\&quot;). </div>
944<div class="param">mcastip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast IP address </div>
945<div class="param">mcastport (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Multicast port </div>
946<div class="param">mcastspeed (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Multicast speed (in Mbps) </div>
947<div class="param">p2pmode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Bittorrent connection type (\&quot;peer\&quot;, \&quot;leecher\&quot;. \&quot;seeder\&quot;). </div>
948<div class="param">p2ptime (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Bittorrent connection extra time (in s.) </div>
949<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Lab&#39;s picture file </div>
950    </div>  <!-- field-items -->
951  </div>
952  <div class="model">
953    <h3 class="field-label"><a name="inline_response_200_5">inline_response_200_5</a> <a class="up" href="#__Models">Up</a></h3>
954    <div class="field-items">
955      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
956<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
957<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidlabs_ou">ousouidlabs_ou</a></span>  </div>
958<div class="param">lab (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidlabs_ou">ousouidlabs_ou</a></span>  </div>
959    </div>  <!-- field-items -->
960  </div>
961  <div class="model">
962    <h3 class="field-label"><a name="inline_response_200_6">inline_response_200_6</a> <a class="up" href="#__Models">Up</a></h3>
963    <div class="field-items">
964      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id </div>
965<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
966<div class="param">serialno (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client serial number </div>
967<div class="param">netiface (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> main network interface </div>
968<div class="param">netdriver (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client MAC address (kernel module) </div>
969<div class="param">mac (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client MAC address </div>
970<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
971<div class="param">netmask (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> subnet mask address </div>
972<div class="param">routerip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> network router IP address </div>
973<div class="param">repo (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_6_repo">inline_response_200_6_repo</a></span>  </div>
974<div class="param">validation (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> boot validation flag </div>
975<div class="param">boottype (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> boot template type </div>
976<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client&#39;s picture file </div>
977    </div>  <!-- field-items -->
978  </div>
979  <div class="model">
980    <h3 class="field-label"><a name="inline_response_200_6_repo">inline_response_200_6_repo</a> <a class="up" href="#__Models">Up</a></h3>
981    <div class="field-items">
982      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
983    </div>  <!-- field-items -->
984  </div>
985  <div class="model">
986    <h3 class="field-label"><a name="inline_response_200_7">inline_response_200_7</a> <a class="up" href="#__Models">Up</a></h3>
987    <div class="field-items">
988      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id </div>
989<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
990<div class="param">hardware (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_7_hardware">array[inline_response_200_7_hardware]</a></span> hardware components </div>
991    </div>  <!-- field-items -->
992  </div>
993  <div class="model">
994    <h3 class="field-label"><a name="inline_response_200_7_hardware">inline_response_200_7_hardware</a> <a class="up" href="#__Models">Up</a></h3>
995    <div class="field-items">
996      <div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component type </div>
997<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component description </div>
998    </div>  <!-- field-items -->
999  </div>
1000  <div class="model">
1001    <h3 class="field-label"><a name="inline_response_200_8">inline_response_200_8</a> <a class="up" href="#__Models">Up</a></h3>
1002    <div class="field-items">
1003      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id </div>
1004<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
1005<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> execution status </div>
1006    </div>  <!-- field-items -->
1007  </div>
1008  <div class="model">
1009    <h3 class="field-label"><a name="inline_response_200_9">inline_response_200_9</a> <a class="up" href="#__Models">Up</a></h3>
1010    <div class="field-items">
1011      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
1012<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1013<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidlabs_ou">ousouidlabs_ou</a></span>  </div>
1014    </div>  <!-- field-items -->
1015  </div>
1016  <div class="model">
1017    <h3 class="field-label"><a name="ousouidlabs_ou">ousouidlabs_ou</a> <a class="up" href="#__Models">Up</a></h3>
1018    <div class="field-items">
1019      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
1020    </div>  <!-- field-items -->
1021  </div>
1022  </body>
1023</html>
Note: See TracBrowser for help on using the repository browser.