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

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 3b5daf8 was 3b5daf8, checked in by ramon <ramongomez@…>, 9 years ago

#708: Continuar con la documentación de la API REST con Swagger; modificar la respuesta de la ruta GET /ous/:ouid/images/:imageid para normalizar la salida de datos.

git-svn-id: https://opengnsys.es/svn/branches/version1.1@5017 a21b9725-9963-47de-94b9-378ad31fedc9
  • Property mode set to 100644
File size: 78.0 KB
RevLine 
[ac8b234e]1<!doctype html>
2<html>
3  <head>
[3b5daf8]4    <title>OpenGnsys REST API</title>
[ac8b234e]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>
[3b5daf8]182  <h1>OpenGnsys REST API</h1>
183    <div class="app-desc">Information about the OpenGnsys REST API functions (including Server and Repository Manager). </div>
184    <div class="app-desc">More information: <a href="http://opengnsys.es/">http://opengnsys.es/</a></div>
185    <div class="app-desc">Contact Info: <a href="opengnsys-devel@listas.unizar.es">opengnsys-devel@listas.unizar.es</a></div>
[ac8b234e]186    <div class="app-desc">Version: 1.1.0</div>
[3b5daf8]187    <div class="app-desc">BasePath:/opengnsys/rest</div>
[ac8b234e]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>
[3b5daf8]205  <li><a href="#ousOuidImagesGet"><code><span class="http-method">get</span> /ous/{ouid}/images</code></a></li>
206  <li><a href="#ousOuidImagesImageidGet"><code><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></a></li>
[ac8b234e]207  <li><a href="#ousOuidLabsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs</code></a></li>
208  <li><a href="#ousOuidLabsLabidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></a></li>
209  <li><a href="#ousGet"><code><span class="http-method">get</span> /ous</code></a></li>
210  <li><a href="#ousOuidGet"><code><span class="http-method">get</span> /ous/{ouid}</code></a></li>
211  <li><a href="#ousOuidReposGet"><code><span class="http-method">get</span> /ous/{ouid}/repos</code></a></li>
212  <li><a href="#ousOuidReposRepoidGet"><code><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></a></li>
213  <li><a href="#loginPost"><code><span class="http-method">post</span> /login</code></a></li>
[3b5daf8]214  <li><a href="#ousGet"><code><span class="http-method">get</span> /ous</code></a></li>
215  <li><a href="#ousOuidGet"><code><span class="http-method">get</span> /ous/{ouid}</code></a></li>
216  <li><a href="#ousOuidImagesGet"><code><span class="http-method">get</span> /ous/{ouid}/images</code></a></li>
217  <li><a href="#ousOuidImagesImageidGet"><code><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></a></li>
218  <li><a href="#ousOuidLabsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs</code></a></li>
219  <li><a href="#ousOuidLabsLabidClientsClientidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></a></li>
220  <li><a href="#ousOuidLabsLabidClientsClientidHardwareGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></a></li>
221  <li><a href="#ousOuidLabsLabidClientsClientidStatusGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></a></li>
222  <li><a href="#ousOuidLabsLabidClientsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></a></li>
223  <li><a href="#ousOuidLabsLabidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></a></li>
224  <li><a href="#ousOuidReposGet"><code><span class="http-method">get</span> /ous/{ouid}/repos</code></a></li>
225  <li><a href="#ousOuidReposRepoidGet"><code><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></a></li>
226  <li><a href="#loginPost"><code><span class="http-method">post</span> /login</code></a></li>
[ac8b234e]227  </ol>
228
229  <div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
230    <div class="method-path">
231    <a class="up" href="#__Methods">Up</a>
232    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
233    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
234    <div class="method-notes">Get a &#x60;client&#x60; object.</div>
235
236    <h3 class="field-label">Path parameters</h3>
237    <div class="field-items">
238      <div class="param">ouid (required)</div>
239
240      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
241
242      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
243
244      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
245    </div>  <!-- field-items -->
246
247    <h3 class="field-label">Consumes</h3>
248    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
249    <ul>
250      <li><code>application/json</code></li>
251    </ul>
252
253
254
255
256
257    <h3 class="field-label">Return type</h3>
258    <div class="return-type">
[3b5daf8]259      <a href="#inline_response_200_7">inline_response_200_7</a>
260     
261    </div>
262
263    <!--Todo: process Response Object and its headers, schema, examples -->
264
265    <h3 class="field-label">Example data</h3>
266    <div class="example-data-content-type">Content-Type: application/json</div>
267    <pre class="example"><code>{
268  "image" : "aeiou",
269  "routerip" : "aeiou",
270  "boottype" : "aeiou",
271  "ip" : "aeiou",
272  "repo" : {
273    "id" : 123
274  },
275  "netdriver" : "aeiou",
276  "netiface" : "aeiou",
277  "mac" : "aeiou",
278  "serialno" : "aeiou",
279  "netmask" : "aeiou",
280  "name" : "aeiou",
281  "id" : 123,
282  "validation" : true
283}</code></pre>
284
285    <h3 class="field-label">Produces</h3>
286    This API call produces the following media types according to the <span class="header">Accept</span> request header;
287    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
288    <ul>
289      <li><code>application/json</code></li>
290    </ul>
291
292    <h3 class="field-label">Responses</h3>
293    <h4 class="field-label">200</h4>
294    Successful response
295        <a href="#inline_response_200_7">inline_response_200_7</a>
296  </div> <!-- method -->
297  <hr/>
298  <div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
299    <div class="method-path">
300    <a class="up" href="#__Methods">Up</a>
301    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
302    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
303    <div class="method-notes">Get the hardware definition of a &#x60;client&#x60; object.</div>
304
305    <h3 class="field-label">Path parameters</h3>
306    <div class="field-items">
307      <div class="param">ouid (required)</div>
308
309      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
310
311      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
312
313      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
314    </div>  <!-- field-items -->
315
316    <h3 class="field-label">Consumes</h3>
317    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
318    <ul>
319      <li><code>application/json</code></li>
320    </ul>
321
322
323
324
325
326    <h3 class="field-label">Return type</h3>
327    <div class="return-type">
328      <a href="#inline_response_200_8">inline_response_200_8</a>
329     
330    </div>
331
332    <!--Todo: process Response Object and its headers, schema, examples -->
333
334    <h3 class="field-label">Example data</h3>
335    <div class="example-data-content-type">Content-Type: application/json</div>
336    <pre class="example"><code>{
337  "name" : "aeiou",
338  "id" : 123,
339  "hardware" : [ {
340    "description" : "aeiou",
341    "type" : "aeiou"
342  } ]
343}</code></pre>
344
345    <h3 class="field-label">Produces</h3>
346    This API call produces the following media types according to the <span class="header">Accept</span> request header;
347    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
348    <ul>
349      <li><code>application/json</code></li>
350    </ul>
351
352    <h3 class="field-label">Responses</h3>
353    <h4 class="field-label">200</h4>
354    Successful response
355        <a href="#inline_response_200_8">inline_response_200_8</a>
356  </div> <!-- method -->
357  <hr/>
358  <div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
359    <div class="method-path">
360    <a class="up" href="#__Methods">Up</a>
361    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
362    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
363    <div class="method-notes">Get execution status of a &#x60;client&#x60;</div>
364
365    <h3 class="field-label">Path parameters</h3>
366    <div class="field-items">
367      <div class="param">ouid (required)</div>
368
369      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
370
371      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
372
373      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
374    </div>  <!-- field-items -->
375
376    <h3 class="field-label">Consumes</h3>
377    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
378    <ul>
379      <li><code>application/json</code></li>
380    </ul>
381
382
383
384
385
386    <h3 class="field-label">Return type</h3>
387    <div class="return-type">
388      <a href="#inline_response_200_9">inline_response_200_9</a>
389     
390    </div>
391
392    <!--Todo: process Response Object and its headers, schema, examples -->
393
394    <h3 class="field-label">Example data</h3>
395    <div class="example-data-content-type">Content-Type: application/json</div>
396    <pre class="example"><code>{
397  "ip" : "aeiou",
398  "id" : 123,
399  "status" : "aeiou"
400}</code></pre>
401
402    <h3 class="field-label">Produces</h3>
403    This API call produces the following media types according to the <span class="header">Accept</span> request header;
404    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
405    <ul>
406      <li><code>application/json</code></li>
407    </ul>
408
409    <h3 class="field-label">Responses</h3>
410    <h4 class="field-label">200</h4>
411    Successful response
412        <a href="#inline_response_200_9">inline_response_200_9</a>
413  </div> <!-- method -->
414  <hr/>
415  <div class="method"><a name="ousOuidLabsLabidClientsGet"/>
416    <div class="method-path">
417    <a class="up" href="#__Methods">Up</a>
418    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
419    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
420    <div class="method-notes">Get all &#x60;client&#x60; objects defined in an &#x60;lab&#x60;.</div>
421
422    <h3 class="field-label">Path parameters</h3>
423    <div class="field-items">
424      <div class="param">ouid (required)</div>
425
426      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
427
428      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div>
429    </div>  <!-- field-items -->
430
431    <h3 class="field-label">Consumes</h3>
432    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
433    <ul>
434      <li><code>application/json</code></li>
435    </ul>
436
437
438
439
440
441    <h3 class="field-label">Return type</h3>
442    <div class="return-type">
443      array[<a href="#inline_response_200_6">inline_response_200_6</a>]
444     
445    </div>
446
447    <!--Todo: process Response Object and its headers, schema, examples -->
448
449    <h3 class="field-label">Example data</h3>
450    <div class="example-data-content-type">Content-Type: application/json</div>
451    <pre class="example"><code>[ {
452  "ou" : {
453    "id" : 123
454  },
455  "name" : "aeiou",
456  "id" : 123,
457  "lab" : ""
458} ]</code></pre>
459
460    <h3 class="field-label">Produces</h3>
461    This API call produces the following media types according to the <span class="header">Accept</span> request header;
462    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
463    <ul>
464      <li><code>application/json</code></li>
465    </ul>
466
467    <h3 class="field-label">Responses</h3>
468    <h4 class="field-label">200</h4>
469    Successful response
470       
471  </div> <!-- method -->
472  <hr/>
473  <div class="method"><a name="ousOuidImagesGet"/>
474    <div class="method-path">
475    <a class="up" href="#__Methods">Up</a>
476    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images</code></pre></div>
477    <div class="method-summary"> (<span class="nickname">ousOuidImagesGet</span>)</div>
478    <div class="method-notes">Get all &#x60;image&#x60; objects defined in an &#x60;OU&#x60;.</div>
479
480    <h3 class="field-label">Path parameters</h3>
481    <div class="field-items">
482      <div class="param">ouid (required)</div>
483
484      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
485    </div>  <!-- field-items -->
486
487    <h3 class="field-label">Consumes</h3>
488    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
489    <ul>
490      <li><code>application/json</code></li>
491    </ul>
492
493
494
495
496
497    <h3 class="field-label">Return type</h3>
498    <div class="return-type">
499      array[<a href="#inline_response_200_3">inline_response_200_3</a>]
500     
501    </div>
502
503    <!--Todo: process Response Object and its headers, schema, examples -->
504
505    <h3 class="field-label">Example data</h3>
506    <div class="example-data-content-type">Content-Type: application/json</div>
507    <pre class="example"><code>[ {
508  "ou" : {
509    "id" : 123
510  },
511  "name" : "aeiou",
512  "id" : 123,
513  "inremotepc" : true
514} ]</code></pre>
515
516    <h3 class="field-label">Produces</h3>
517    This API call produces the following media types according to the <span class="header">Accept</span> request header;
518    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
519    <ul>
520      <li><code>application/json</code></li>
521    </ul>
522
523    <h3 class="field-label">Responses</h3>
524    <h4 class="field-label">200</h4>
525    Successful response
526       
527  </div> <!-- method -->
528  <hr/>
529  <div class="method"><a name="ousOuidImagesImageidGet"/>
530    <div class="method-path">
531    <a class="up" href="#__Methods">Up</a>
532    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></pre></div>
533    <div class="method-summary"> (<span class="nickname">ousOuidImagesImageidGet</span>)</div>
534    <div class="method-notes">Get an &#x60;image&#x60; object.</div>
535
536    <h3 class="field-label">Path parameters</h3>
537    <div class="field-items">
538      <div class="param">ouid (required)</div>
539
540      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">imageid (required)</div>
541
542      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; image definition identificator </div>
543    </div>  <!-- field-items -->
544
545    <h3 class="field-label">Consumes</h3>
546    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
547    <ul>
548      <li><code>application/json</code></li>
549    </ul>
550
551
552
553
554
555    <h3 class="field-label">Return type</h3>
556    <div class="return-type">
557      <a href="#inline_response_200_4">inline_response_200_4</a>
558     
559    </div>
560
561    <!--Todo: process Response Object and its headers, schema, examples -->
562
563    <h3 class="field-label">Example data</h3>
564    <div class="example-data-content-type">Content-Type: application/json</div>
565    <pre class="example"><code>{
566  "path" : "aeiou",
567  "creationdate" : "2000-01-23T04:56:07.000+00:00",
568  "release" : "aeiou",
569  "repo" : {
570    "id" : 123
571  },
572  "name" : "aeiou",
573  "description" : "aeiou",
574  "client" : {
575    "disk" : 123,
576    "partition" : 123,
577    "id" : 123
578  },
579  "id" : 123,
580  "inremotepc" : true,
581  "type" : "aeiou",
582  "baseimg" : "aeiou"
583}</code></pre>
584
585    <h3 class="field-label">Produces</h3>
586    This API call produces the following media types according to the <span class="header">Accept</span> request header;
587    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
588    <ul>
589      <li><code>application/json</code></li>
590    </ul>
591
592    <h3 class="field-label">Responses</h3>
593    <h4 class="field-label">200</h4>
594    Successful response
595        <a href="#inline_response_200_4">inline_response_200_4</a>
596  </div> <!-- method -->
597  <hr/>
598  <div class="method"><a name="ousOuidLabsGet"/>
599    <div class="method-path">
600    <a class="up" href="#__Methods">Up</a>
601    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
602    <div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
603    <div class="method-notes">Get all &#x60;lab&#x60; objects defined in an &#x60;OU&#x60;.</div>
604
605    <h3 class="field-label">Path parameters</h3>
606    <div class="field-items">
607      <div class="param">ouid (required)</div>
608
609      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
610    </div>  <!-- field-items -->
611
612    <h3 class="field-label">Consumes</h3>
613    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
614    <ul>
615      <li><code>application/json</code></li>
616    </ul>
617
618
619
620
621
622    <h3 class="field-label">Return type</h3>
623    <div class="return-type">
624      array[<a href="#inline_response_200_3">inline_response_200_3</a>]
625     
626    </div>
627
628    <!--Todo: process Response Object and its headers, schema, examples -->
629
630    <h3 class="field-label">Example data</h3>
631    <div class="example-data-content-type">Content-Type: application/json</div>
632    <pre class="example"><code>[ {
633  "ou" : {
634    "id" : 123
635  },
636  "name" : "aeiou",
637  "id" : 123,
638  "inremotepc" : true
639} ]</code></pre>
640
641    <h3 class="field-label">Produces</h3>
642    This API call produces the following media types according to the <span class="header">Accept</span> request header;
643    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
644    <ul>
645      <li><code>application/json</code></li>
646    </ul>
647
648    <h3 class="field-label">Responses</h3>
649    <h4 class="field-label">200</h4>
650    Successful response
651       
652  </div> <!-- method -->
653  <hr/>
654  <div class="method"><a name="ousOuidLabsLabidGet"/>
655    <div class="method-path">
656    <a class="up" href="#__Methods">Up</a>
657    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
658    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
659    <div class="method-notes">Get a &#x60;lab&#x60; object.</div>
660
661    <h3 class="field-label">Path parameters</h3>
662    <div class="field-items">
663      <div class="param">ouid (required)</div>
664
665      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
666
667      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; laboratory identificator </div>
668    </div>  <!-- field-items -->
669
670    <h3 class="field-label">Consumes</h3>
671    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
672    <ul>
673      <li><code>application/json</code></li>
674    </ul>
675
676
677
678
679
680    <h3 class="field-label">Return type</h3>
681    <div class="return-type">
682      <a href="#inline_response_200_5">inline_response_200_5</a>
683     
684    </div>
685
686    <!--Todo: process Response Object and its headers, schema, examples -->
687
688    <h3 class="field-label">Example data</h3>
689    <div class="example-data-content-type">Content-Type: application/json</div>
690    <pre class="example"><code>{
691  "image" : "aeiou",
692  "routerip" : "aeiou",
693  "mcastport" : 123,
694  "proxyurl" : "aeiou",
695  "dns" : "aeiou",
696  "mcastmode" : "aeiou",
697  "description" : "aeiou",
698  "inremotepc" : true,
699  "ntp" : "aeiou",
700  "mcastspeed" : 123,
701  "capacity" : 123,
702  "defclients" : 123,
703  "mcastip" : "aeiou",
704  "projector" : true,
705  "netmask" : "aeiou",
706  "p2ptime" : 123,
707  "name" : "aeiou",
708  "p2pmode" : "aeiou",
709  "location" : "aeiou",
710  "id" : 123,
711  "board" : true
712}</code></pre>
713
714    <h3 class="field-label">Produces</h3>
715    This API call produces the following media types according to the <span class="header">Accept</span> request header;
716    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
717    <ul>
718      <li><code>application/json</code></li>
719    </ul>
720
721    <h3 class="field-label">Responses</h3>
722    <h4 class="field-label">200</h4>
723    Successful response
724        <a href="#inline_response_200_5">inline_response_200_5</a>
725  </div> <!-- method -->
726  <hr/>
727  <div class="method"><a name="ousGet"/>
728    <div class="method-path">
729    <a class="up" href="#__Methods">Up</a>
730    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
731    <div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
732    <div class="method-notes">Gets all &#x60;OU&#x60; objects.</div>
733
734
735    <h3 class="field-label">Consumes</h3>
736    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
737    <ul>
738      <li><code>application/json</code></li>
739    </ul>
740
741
742
743
744
745    <h3 class="field-label">Return type</h3>
746    <div class="return-type">
747      array[<a href="#inline_response_200_1">inline_response_200_1</a>]
748     
749    </div>
750
751    <!--Todo: process Response Object and its headers, schema, examples -->
752
753    <h3 class="field-label">Example data</h3>
754    <div class="example-data-content-type">Content-Type: application/json</div>
755    <pre class="example"><code>[ {
756  "name" : "aeiou",
757  "id" : 123
758} ]</code></pre>
759
760    <h3 class="field-label">Produces</h3>
761    This API call produces the following media types according to the <span class="header">Accept</span> request header;
762    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
763    <ul>
764      <li><code>application/json</code></li>
765    </ul>
766
767    <h3 class="field-label">Responses</h3>
768    <h4 class="field-label">200</h4>
769    Successful response
770       
771  </div> <!-- method -->
772  <hr/>
773  <div class="method"><a name="ousOuidGet"/>
774    <div class="method-path">
775    <a class="up" href="#__Methods">Up</a>
776    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
777    <div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
778    <div class="method-notes">Get an &#x60;OU&#x60; object.</div>
779
780    <h3 class="field-label">Path parameters</h3>
781    <div class="field-items">
782      <div class="param">ouid (required)</div>
783
784      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Organization Unit identificator </div>
785    </div>  <!-- field-items -->
786
787    <h3 class="field-label">Consumes</h3>
788    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
789    <ul>
790      <li><code>application/json</code></li>
791    </ul>
792
793
794
795
796
797    <h3 class="field-label">Return type</h3>
798    <div class="return-type">
799      <a href="#inline_response_200_2">inline_response_200_2</a>
800     
801    </div>
802
803    <!--Todo: process Response Object and its headers, schema, examples -->
804
805    <h3 class="field-label">Example data</h3>
806    <div class="example-data-content-type">Content-Type: application/json</div>
807    <pre class="example"><code>{
808  "name" : "aeiou",
809  "description" : "aeiou",
810  "id" : ""
811}</code></pre>
812
813    <h3 class="field-label">Produces</h3>
814    This API call produces the following media types according to the <span class="header">Accept</span> request header;
815    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
816    <ul>
817      <li><code>application/json</code></li>
818    </ul>
819
820    <h3 class="field-label">Responses</h3>
821    <h4 class="field-label">200</h4>
822    Successful response
823        <a href="#inline_response_200_2">inline_response_200_2</a>
824  </div> <!-- method -->
825  <hr/>
826  <div class="method"><a name="ousOuidReposGet"/>
827    <div class="method-path">
828    <a class="up" href="#__Methods">Up</a>
829    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
830    <div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
831    <div class="method-notes">Get all &#x60;repo&#x60; objects defined in an &#x60;OU&#x60;.</div>
832
833    <h3 class="field-label">Path parameters</h3>
834    <div class="field-items">
835      <div class="param">ouid (required)</div>
836
837      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
838    </div>  <!-- field-items -->
839
840    <h3 class="field-label">Consumes</h3>
841    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
842    <ul>
843      <li><code>application/json</code></li>
844    </ul>
845
846
847
848
849
850    <h3 class="field-label">Return type</h3>
851    <div class="return-type">
852      array[<a href="#inline_response_200_10">inline_response_200_10</a>]
853     
854    </div>
855
856    <!--Todo: process Response Object and its headers, schema, examples -->
857
858    <h3 class="field-label">Example data</h3>
859    <div class="example-data-content-type">Content-Type: application/json</div>
860    <pre class="example"><code>[ {
861  "ou" : {
862    "id" : 123
863  },
864  "name" : "aeiou",
865  "id" : 123
866} ]</code></pre>
867
868    <h3 class="field-label">Produces</h3>
869    This API call produces the following media types according to the <span class="header">Accept</span> request header;
870    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
871    <ul>
872      <li><code>application/json</code></li>
873    </ul>
874
875    <h3 class="field-label">Responses</h3>
876    <h4 class="field-label">200</h4>
877    Successful response
878       
879  </div> <!-- method -->
880  <hr/>
881  <div class="method"><a name="ousOuidReposRepoidGet"/>
882    <div class="method-path">
883    <a class="up" href="#__Methods">Up</a>
884    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
885    <div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
886    <div class="method-notes">Get a &#x60;repo&#x60; object.</div>
887
888    <h3 class="field-label">Path parameters</h3>
889    <div class="field-items">
890      <div class="param">ouid (required)</div>
891
892      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">repoid (required)</div>
893
894      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; repository identificator </div>
895    </div>  <!-- field-items -->
896
897    <h3 class="field-label">Consumes</h3>
898    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
899    <ul>
900      <li><code>application/json</code></li>
901    </ul>
902
903
904
905
906
907    <h3 class="field-label">Return type</h3>
908    <div class="return-type">
909      <a href="#inline_response_200_11">inline_response_200_11</a>
910     
911    </div>
912
913    <!--Todo: process Response Object and its headers, schema, examples -->
914
915    <h3 class="field-label">Example data</h3>
916    <div class="example-data-content-type">Content-Type: application/json</div>
917    <pre class="example"><code>{
918  "ip" : "aeiou",
919  "name" : "aeiou",
920  "description" : "aeiou",
921  "id" : 123
922}</code></pre>
923
924    <h3 class="field-label">Produces</h3>
925    This API call produces the following media types according to the <span class="header">Accept</span> request header;
926    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
927    <ul>
928      <li><code>application/json</code></li>
929    </ul>
930
931    <h3 class="field-label">Responses</h3>
932    <h4 class="field-label">200</h4>
933    Successful response
934        <a href="#inline_response_200_11">inline_response_200_11</a>
935  </div> <!-- method -->
936  <hr/>
937  <div class="method"><a name="loginPost"/>
938    <div class="method-path">
939    <a class="up" href="#__Methods">Up</a>
940    <pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
941    <div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
942    <div class="method-notes">Check user login and returns his/her API key.</div>
943
944
945    <h3 class="field-label">Consumes</h3>
946    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
947    <ul>
948      <li><code>application/json</code></li>
949    </ul>
950
951    <h3 class="field-label">Request body</h3>
952    <div class="field-items">
953      <div class="param">authdata (required)</div>
954
955      <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; JSON authentication data </div>
956    </div>  <!-- field-items -->
957
958
959
960
961    <h3 class="field-label">Return type</h3>
962    <div class="return-type">
963      <a href="#inline_response_200">inline_response_200</a>
964     
965    </div>
966
967    <!--Todo: process Response Object and its headers, schema, examples -->
968
969    <h3 class="field-label">Example data</h3>
970    <div class="example-data-content-type">Content-Type: application/json</div>
971    <pre class="example"><code>{
972  "apikey" : "aeiou",
973  "userid" : 123
974}</code></pre>
975
976    <h3 class="field-label">Produces</h3>
977    This API call produces the following media types according to the <span class="header">Accept</span> request header;
978    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
979    <ul>
980      <li><code>application/json</code></li>
981    </ul>
982
983    <h3 class="field-label">Responses</h3>
984    <h4 class="field-label">200</h4>
985    Successful login
986        <a href="#inline_response_200">inline_response_200</a>
987    <h4 class="field-label">400</h4>
988    Missing parameters
989        <a href="#"></a>
990    <h4 class="field-label">500</h4>
991    Authentication error
992        <a href="#"></a>
993  </div> <!-- method -->
994  <hr/>
995  <div class="method"><a name="ousGet"/>
996    <div class="method-path">
997    <a class="up" href="#__Methods">Up</a>
998    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
999    <div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
1000    <div class="method-notes">Gets all &#x60;OU&#x60; objects.</div>
1001
1002
1003    <h3 class="field-label">Consumes</h3>
1004    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1005    <ul>
1006      <li><code>application/json</code></li>
1007    </ul>
1008
1009
1010
1011
1012
1013    <h3 class="field-label">Return type</h3>
1014    <div class="return-type">
1015      array[<a href="#inline_response_200_1">inline_response_200_1</a>]
1016     
1017    </div>
1018
1019    <!--Todo: process Response Object and its headers, schema, examples -->
1020
1021    <h3 class="field-label">Example data</h3>
1022    <div class="example-data-content-type">Content-Type: application/json</div>
1023    <pre class="example"><code>[ {
1024  "name" : "aeiou",
1025  "id" : 123
1026} ]</code></pre>
1027
1028    <h3 class="field-label">Produces</h3>
1029    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1030    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1031    <ul>
1032      <li><code>application/json</code></li>
1033    </ul>
1034
1035    <h3 class="field-label">Responses</h3>
1036    <h4 class="field-label">200</h4>
1037    Successful response
1038       
1039  </div> <!-- method -->
1040  <hr/>
1041  <div class="method"><a name="ousOuidGet"/>
1042    <div class="method-path">
1043    <a class="up" href="#__Methods">Up</a>
1044    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
1045    <div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
1046    <div class="method-notes">Get an &#x60;OU&#x60; object.</div>
1047
1048    <h3 class="field-label">Path parameters</h3>
1049    <div class="field-items">
1050      <div class="param">ouid (required)</div>
1051
1052      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Organization Unit identificator </div>
1053    </div>  <!-- field-items -->
1054
1055    <h3 class="field-label">Consumes</h3>
1056    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1057    <ul>
1058      <li><code>application/json</code></li>
1059    </ul>
1060
1061
1062
1063
1064
1065    <h3 class="field-label">Return type</h3>
1066    <div class="return-type">
1067      <a href="#inline_response_200_2">inline_response_200_2</a>
1068     
1069    </div>
1070
1071    <!--Todo: process Response Object and its headers, schema, examples -->
1072
1073    <h3 class="field-label">Example data</h3>
1074    <div class="example-data-content-type">Content-Type: application/json</div>
1075    <pre class="example"><code>{
1076  "name" : "aeiou",
1077  "description" : "aeiou",
1078  "id" : ""
1079}</code></pre>
1080
1081    <h3 class="field-label">Produces</h3>
1082    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1083    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1084    <ul>
1085      <li><code>application/json</code></li>
1086    </ul>
1087
1088    <h3 class="field-label">Responses</h3>
1089    <h4 class="field-label">200</h4>
1090    Successful response
1091        <a href="#inline_response_200_2">inline_response_200_2</a>
1092  </div> <!-- method -->
1093  <hr/>
1094  <div class="method"><a name="ousOuidImagesGet"/>
1095    <div class="method-path">
1096    <a class="up" href="#__Methods">Up</a>
1097    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images</code></pre></div>
1098    <div class="method-summary"> (<span class="nickname">ousOuidImagesGet</span>)</div>
1099    <div class="method-notes">Get all &#x60;image&#x60; objects defined in an &#x60;OU&#x60;.</div>
1100
1101    <h3 class="field-label">Path parameters</h3>
1102    <div class="field-items">
1103      <div class="param">ouid (required)</div>
1104
1105      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
1106    </div>  <!-- field-items -->
1107
1108    <h3 class="field-label">Consumes</h3>
1109    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1110    <ul>
1111      <li><code>application/json</code></li>
1112    </ul>
1113
1114
1115
1116
1117
1118    <h3 class="field-label">Return type</h3>
1119    <div class="return-type">
1120      array[<a href="#inline_response_200_3">inline_response_200_3</a>]
[ac8b234e]1121     
1122    </div>
1123
1124    <!--Todo: process Response Object and its headers, schema, examples -->
1125
1126    <h3 class="field-label">Example data</h3>
1127    <div class="example-data-content-type">Content-Type: application/json</div>
[3b5daf8]1128    <pre class="example"><code>[ {
1129  "ou" : {
1130    "id" : 123
[ac8b234e]1131  },
1132  "name" : "aeiou",
[3b5daf8]1133  "id" : 123,
1134  "inremotepc" : true
1135} ]</code></pre>
[ac8b234e]1136
1137    <h3 class="field-label">Produces</h3>
1138    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1139    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1140    <ul>
1141      <li><code>application/json</code></li>
1142    </ul>
1143
1144    <h3 class="field-label">Responses</h3>
1145    <h4 class="field-label">200</h4>
1146    Successful response
[3b5daf8]1147       
[ac8b234e]1148  </div> <!-- method -->
1149  <hr/>
[3b5daf8]1150  <div class="method"><a name="ousOuidImagesImageidGet"/>
[ac8b234e]1151    <div class="method-path">
1152    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1153    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></pre></div>
1154    <div class="method-summary"> (<span class="nickname">ousOuidImagesImageidGet</span>)</div>
1155    <div class="method-notes">Get an &#x60;image&#x60; object.</div>
[ac8b234e]1156
1157    <h3 class="field-label">Path parameters</h3>
1158    <div class="field-items">
1159      <div class="param">ouid (required)</div>
1160
[3b5daf8]1161      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">imageid (required)</div>
[ac8b234e]1162
[3b5daf8]1163      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; image definition identificator </div>
[ac8b234e]1164    </div>  <!-- field-items -->
1165
1166    <h3 class="field-label">Consumes</h3>
1167    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1168    <ul>
1169      <li><code>application/json</code></li>
1170    </ul>
1171
1172
1173
1174
1175
1176    <h3 class="field-label">Return type</h3>
1177    <div class="return-type">
[3b5daf8]1178      <a href="#inline_response_200_4">inline_response_200_4</a>
[ac8b234e]1179     
1180    </div>
1181
1182    <!--Todo: process Response Object and its headers, schema, examples -->
1183
1184    <h3 class="field-label">Example data</h3>
1185    <div class="example-data-content-type">Content-Type: application/json</div>
1186    <pre class="example"><code>{
[3b5daf8]1187  "path" : "aeiou",
1188  "creationdate" : "2000-01-23T04:56:07.000+00:00",
1189  "release" : "aeiou",
1190  "repo" : {
1191    "id" : 123
1192  },
[ac8b234e]1193  "name" : "aeiou",
[3b5daf8]1194  "description" : "aeiou",
1195  "client" : {
1196    "disk" : 123,
1197    "partition" : 123,
1198    "id" : 123
1199  },
1200  "id" : 123,
1201  "inremotepc" : true,
1202  "type" : "aeiou",
1203  "baseimg" : "aeiou"
[ac8b234e]1204}</code></pre>
1205
1206    <h3 class="field-label">Produces</h3>
1207    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1208    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1209    <ul>
1210      <li><code>application/json</code></li>
1211    </ul>
1212
1213    <h3 class="field-label">Responses</h3>
1214    <h4 class="field-label">200</h4>
1215    Successful response
[3b5daf8]1216        <a href="#inline_response_200_4">inline_response_200_4</a>
[ac8b234e]1217  </div> <!-- method -->
1218  <hr/>
[3b5daf8]1219  <div class="method"><a name="ousOuidLabsGet"/>
[ac8b234e]1220    <div class="method-path">
1221    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1222    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
1223    <div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
1224    <div class="method-notes">Get all &#x60;lab&#x60; objects defined in an &#x60;OU&#x60;.</div>
[ac8b234e]1225
1226    <h3 class="field-label">Path parameters</h3>
1227    <div class="field-items">
1228      <div class="param">ouid (required)</div>
1229
[3b5daf8]1230      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
[ac8b234e]1231    </div>  <!-- field-items -->
1232
1233    <h3 class="field-label">Consumes</h3>
1234    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1235    <ul>
1236      <li><code>application/json</code></li>
1237    </ul>
1238
1239
1240
1241
1242
1243    <h3 class="field-label">Return type</h3>
1244    <div class="return-type">
[3b5daf8]1245      array[<a href="#inline_response_200_3">inline_response_200_3</a>]
[ac8b234e]1246     
1247    </div>
1248
1249    <!--Todo: process Response Object and its headers, schema, examples -->
1250
1251    <h3 class="field-label">Example data</h3>
1252    <div class="example-data-content-type">Content-Type: application/json</div>
[3b5daf8]1253    <pre class="example"><code>[ {
1254  "ou" : {
1255    "id" : 123
1256  },
1257  "name" : "aeiou",
1258  "id" : 123,
1259  "inremotepc" : true
1260} ]</code></pre>
[ac8b234e]1261
1262    <h3 class="field-label">Produces</h3>
1263    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1264    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1265    <ul>
1266      <li><code>application/json</code></li>
1267    </ul>
1268
1269    <h3 class="field-label">Responses</h3>
1270    <h4 class="field-label">200</h4>
1271    Successful response
[3b5daf8]1272       
[ac8b234e]1273  </div> <!-- method -->
1274  <hr/>
[3b5daf8]1275  <div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
[ac8b234e]1276    <div class="method-path">
1277    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1278    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
1279    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
1280    <div class="method-notes">Get a &#x60;client&#x60; object.</div>
[ac8b234e]1281
1282    <h3 class="field-label">Path parameters</h3>
1283    <div class="field-items">
1284      <div class="param">ouid (required)</div>
1285
1286      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
1287
[3b5daf8]1288      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
1289
1290      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
[ac8b234e]1291    </div>  <!-- field-items -->
1292
1293    <h3 class="field-label">Consumes</h3>
1294    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1295    <ul>
1296      <li><code>application/json</code></li>
1297    </ul>
1298
1299
1300
1301
1302
1303    <h3 class="field-label">Return type</h3>
1304    <div class="return-type">
[3b5daf8]1305      <a href="#inline_response_200_7">inline_response_200_7</a>
[ac8b234e]1306     
1307    </div>
1308
1309    <!--Todo: process Response Object and its headers, schema, examples -->
1310
1311    <h3 class="field-label">Example data</h3>
1312    <div class="example-data-content-type">Content-Type: application/json</div>
[3b5daf8]1313    <pre class="example"><code>{
1314  "image" : "aeiou",
1315  "routerip" : "aeiou",
1316  "boottype" : "aeiou",
1317  "ip" : "aeiou",
1318  "repo" : {
1319    "id" : 123
[ac8b234e]1320  },
[3b5daf8]1321  "netdriver" : "aeiou",
1322  "netiface" : "aeiou",
1323  "mac" : "aeiou",
1324  "serialno" : "aeiou",
1325  "netmask" : "aeiou",
[ac8b234e]1326  "name" : "aeiou",
[3b5daf8]1327  "id" : 123,
1328  "validation" : true
1329}</code></pre>
[ac8b234e]1330
1331    <h3 class="field-label">Produces</h3>
1332    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1333    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1334    <ul>
1335      <li><code>application/json</code></li>
1336    </ul>
1337
1338    <h3 class="field-label">Responses</h3>
1339    <h4 class="field-label">200</h4>
1340    Successful response
[3b5daf8]1341        <a href="#inline_response_200_7">inline_response_200_7</a>
[ac8b234e]1342  </div> <!-- method -->
1343  <hr/>
[3b5daf8]1344  <div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
[ac8b234e]1345    <div class="method-path">
1346    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1347    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
1348    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
1349    <div class="method-notes">Get the hardware definition of a &#x60;client&#x60; object.</div>
[ac8b234e]1350
1351    <h3 class="field-label">Path parameters</h3>
1352    <div class="field-items">
1353      <div class="param">ouid (required)</div>
1354
[3b5daf8]1355      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
1356
1357      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
1358
1359      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
[ac8b234e]1360    </div>  <!-- field-items -->
1361
1362    <h3 class="field-label">Consumes</h3>
1363    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1364    <ul>
1365      <li><code>application/json</code></li>
1366    </ul>
1367
1368
1369
1370
1371
1372    <h3 class="field-label">Return type</h3>
1373    <div class="return-type">
[3b5daf8]1374      <a href="#inline_response_200_8">inline_response_200_8</a>
[ac8b234e]1375     
1376    </div>
1377
1378    <!--Todo: process Response Object and its headers, schema, examples -->
1379
1380    <h3 class="field-label">Example data</h3>
1381    <div class="example-data-content-type">Content-Type: application/json</div>
[3b5daf8]1382    <pre class="example"><code>{
[ac8b234e]1383  "name" : "aeiou",
[3b5daf8]1384  "id" : 123,
1385  "hardware" : [ {
1386    "description" : "aeiou",
1387    "type" : "aeiou"
1388  } ]
1389}</code></pre>
[ac8b234e]1390
1391    <h3 class="field-label">Produces</h3>
1392    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1393    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1394    <ul>
1395      <li><code>application/json</code></li>
1396    </ul>
1397
1398    <h3 class="field-label">Responses</h3>
1399    <h4 class="field-label">200</h4>
1400    Successful response
[3b5daf8]1401        <a href="#inline_response_200_8">inline_response_200_8</a>
[ac8b234e]1402  </div> <!-- method -->
1403  <hr/>
[3b5daf8]1404  <div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
[ac8b234e]1405    <div class="method-path">
1406    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1407    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
1408    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
1409    <div class="method-notes">Get execution status of a &#x60;client&#x60;</div>
[ac8b234e]1410
1411    <h3 class="field-label">Path parameters</h3>
1412    <div class="field-items">
1413      <div class="param">ouid (required)</div>
1414
1415      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
1416
[3b5daf8]1417      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div><div class="param">clientid (required)</div>
1418
1419      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Client identificator </div>
[ac8b234e]1420    </div>  <!-- field-items -->
1421
1422    <h3 class="field-label">Consumes</h3>
1423    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1424    <ul>
1425      <li><code>application/json</code></li>
1426    </ul>
1427
1428
1429
1430
1431
1432    <h3 class="field-label">Return type</h3>
1433    <div class="return-type">
[3b5daf8]1434      <a href="#inline_response_200_9">inline_response_200_9</a>
[ac8b234e]1435     
1436    </div>
1437
1438    <!--Todo: process Response Object and its headers, schema, examples -->
1439
1440    <h3 class="field-label">Example data</h3>
1441    <div class="example-data-content-type">Content-Type: application/json</div>
1442    <pre class="example"><code>{
[3b5daf8]1443  "ip" : "aeiou",
1444  "id" : 123,
1445  "status" : "aeiou"
[ac8b234e]1446}</code></pre>
1447
1448    <h3 class="field-label">Produces</h3>
1449    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1450    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1451    <ul>
1452      <li><code>application/json</code></li>
1453    </ul>
1454
1455    <h3 class="field-label">Responses</h3>
1456    <h4 class="field-label">200</h4>
1457    Successful response
[3b5daf8]1458        <a href="#inline_response_200_9">inline_response_200_9</a>
[ac8b234e]1459  </div> <!-- method -->
1460  <hr/>
[3b5daf8]1461  <div class="method"><a name="ousOuidLabsLabidClientsGet"/>
[ac8b234e]1462    <div class="method-path">
1463    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1464    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
1465    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
1466    <div class="method-notes">Get all &#x60;client&#x60; objects defined in an &#x60;lab&#x60;.</div>
1467
1468    <h3 class="field-label">Path parameters</h3>
1469    <div class="field-items">
1470      <div class="param">ouid (required)</div>
1471
1472      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
[ac8b234e]1473
[3b5daf8]1474      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Lab identificator </div>
1475    </div>  <!-- field-items -->
[ac8b234e]1476
1477    <h3 class="field-label">Consumes</h3>
1478    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1479    <ul>
1480      <li><code>application/json</code></li>
1481    </ul>
1482
1483
1484
1485
1486
1487    <h3 class="field-label">Return type</h3>
1488    <div class="return-type">
[3b5daf8]1489      array[<a href="#inline_response_200_6">inline_response_200_6</a>]
[ac8b234e]1490     
1491    </div>
1492
1493    <!--Todo: process Response Object and its headers, schema, examples -->
1494
1495    <h3 class="field-label">Example data</h3>
1496    <div class="example-data-content-type">Content-Type: application/json</div>
1497    <pre class="example"><code>[ {
[3b5daf8]1498  "ou" : {
1499    "id" : 123
1500  },
[ac8b234e]1501  "name" : "aeiou",
[3b5daf8]1502  "id" : 123,
1503  "lab" : ""
[ac8b234e]1504} ]</code></pre>
1505
1506    <h3 class="field-label">Produces</h3>
1507    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1508    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1509    <ul>
1510      <li><code>application/json</code></li>
1511    </ul>
1512
1513    <h3 class="field-label">Responses</h3>
1514    <h4 class="field-label">200</h4>
1515    Successful response
1516       
1517  </div> <!-- method -->
1518  <hr/>
[3b5daf8]1519  <div class="method"><a name="ousOuidLabsLabidGet"/>
[ac8b234e]1520    <div class="method-path">
1521    <a class="up" href="#__Methods">Up</a>
[3b5daf8]1522    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
1523    <div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
1524    <div class="method-notes">Get a &#x60;lab&#x60; object.</div>
[ac8b234e]1525
1526    <h3 class="field-label">Path parameters</h3>
1527    <div class="field-items">
1528      <div class="param">ouid (required)</div>
1529
[3b5daf8]1530      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">labid (required)</div>
1531
1532      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; laboratory identificator </div>
[ac8b234e]1533    </div>  <!-- field-items -->
1534
1535    <h3 class="field-label">Consumes</h3>
1536    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1537    <ul>
1538      <li><code>application/json</code></li>
1539    </ul>
1540
1541
1542
1543
1544
1545    <h3 class="field-label">Return type</h3>
1546    <div class="return-type">
[3b5daf8]1547      <a href="#inline_response_200_5">inline_response_200_5</a>
[ac8b234e]1548     
1549    </div>
1550
1551    <!--Todo: process Response Object and its headers, schema, examples -->
1552
1553    <h3 class="field-label">Example data</h3>
1554    <div class="example-data-content-type">Content-Type: application/json</div>
1555    <pre class="example"><code>{
[3b5daf8]1556  "image" : "aeiou",
1557  "routerip" : "aeiou",
1558  "mcastport" : 123,
1559  "proxyurl" : "aeiou",
1560  "dns" : "aeiou",
1561  "mcastmode" : "aeiou",
[ac8b234e]1562  "description" : "aeiou",
[3b5daf8]1563  "inremotepc" : true,
1564  "ntp" : "aeiou",
1565  "mcastspeed" : 123,
1566  "capacity" : 123,
1567  "defclients" : 123,
1568  "mcastip" : "aeiou",
1569  "projector" : true,
1570  "netmask" : "aeiou",
1571  "p2ptime" : 123,
1572  "name" : "aeiou",
1573  "p2pmode" : "aeiou",
1574  "location" : "aeiou",
1575  "id" : 123,
1576  "board" : true
[ac8b234e]1577}</code></pre>
1578
1579    <h3 class="field-label">Produces</h3>
1580    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1581    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1582    <ul>
1583      <li><code>application/json</code></li>
1584    </ul>
1585
1586    <h3 class="field-label">Responses</h3>
1587    <h4 class="field-label">200</h4>
1588    Successful response
[3b5daf8]1589        <a href="#inline_response_200_5">inline_response_200_5</a>
[ac8b234e]1590  </div> <!-- method -->
1591  <hr/>
1592  <div class="method"><a name="ousOuidReposGet"/>
1593    <div class="method-path">
1594    <a class="up" href="#__Methods">Up</a>
1595    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
1596    <div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
1597    <div class="method-notes">Get all &#x60;repo&#x60; objects defined in an &#x60;OU&#x60;.</div>
1598
1599    <h3 class="field-label">Path parameters</h3>
1600    <div class="field-items">
1601      <div class="param">ouid (required)</div>
1602
1603      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div>
1604    </div>  <!-- field-items -->
1605
1606    <h3 class="field-label">Consumes</h3>
1607    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1608    <ul>
1609      <li><code>application/json</code></li>
1610    </ul>
1611
1612
1613
1614
1615
1616    <h3 class="field-label">Return type</h3>
1617    <div class="return-type">
[3b5daf8]1618      array[<a href="#inline_response_200_10">inline_response_200_10</a>]
[ac8b234e]1619     
1620    </div>
1621
1622    <!--Todo: process Response Object and its headers, schema, examples -->
1623
1624    <h3 class="field-label">Example data</h3>
1625    <div class="example-data-content-type">Content-Type: application/json</div>
1626    <pre class="example"><code>[ {
1627  "ou" : {
[3b5daf8]1628    "id" : 123
[ac8b234e]1629  },
1630  "name" : "aeiou",
[3b5daf8]1631  "id" : 123
[ac8b234e]1632} ]</code></pre>
1633
1634    <h3 class="field-label">Produces</h3>
1635    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1636    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1637    <ul>
1638      <li><code>application/json</code></li>
1639    </ul>
1640
1641    <h3 class="field-label">Responses</h3>
1642    <h4 class="field-label">200</h4>
1643    Successful response
1644       
1645  </div> <!-- method -->
1646  <hr/>
1647  <div class="method"><a name="ousOuidReposRepoidGet"/>
1648    <div class="method-path">
1649    <a class="up" href="#__Methods">Up</a>
1650    <pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
1651    <div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
1652    <div class="method-notes">Get a &#x60;repo&#x60; object.</div>
1653
1654    <h3 class="field-label">Path parameters</h3>
1655    <div class="field-items">
1656      <div class="param">ouid (required)</div>
1657
1658      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; OU identificator </div><div class="param">repoid (required)</div>
1659
1660      <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; repository identificator </div>
1661    </div>  <!-- field-items -->
1662
1663    <h3 class="field-label">Consumes</h3>
1664    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1665    <ul>
1666      <li><code>application/json</code></li>
1667    </ul>
1668
1669
1670
1671
1672
1673    <h3 class="field-label">Return type</h3>
1674    <div class="return-type">
[3b5daf8]1675      <a href="#inline_response_200_11">inline_response_200_11</a>
[ac8b234e]1676     
1677    </div>
1678
1679    <!--Todo: process Response Object and its headers, schema, examples -->
1680
1681    <h3 class="field-label">Example data</h3>
1682    <div class="example-data-content-type">Content-Type: application/json</div>
1683    <pre class="example"><code>{
1684  "ip" : "aeiou",
1685  "name" : "aeiou",
1686  "description" : "aeiou",
[3b5daf8]1687  "id" : 123
[ac8b234e]1688}</code></pre>
1689
1690    <h3 class="field-label">Produces</h3>
1691    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1692    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1693    <ul>
1694      <li><code>application/json</code></li>
1695    </ul>
1696
1697    <h3 class="field-label">Responses</h3>
1698    <h4 class="field-label">200</h4>
1699    Successful response
[3b5daf8]1700        <a href="#inline_response_200_11">inline_response_200_11</a>
[ac8b234e]1701  </div> <!-- method -->
1702  <hr/>
1703  <div class="method"><a name="loginPost"/>
1704    <div class="method-path">
1705    <a class="up" href="#__Methods">Up</a>
1706    <pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
1707    <div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
1708    <div class="method-notes">Check user login and returns his/her API key.</div>
1709
1710
1711    <h3 class="field-label">Consumes</h3>
1712    This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1713    <ul>
1714      <li><code>application/json</code></li>
1715    </ul>
1716
1717    <h3 class="field-label">Request body</h3>
1718    <div class="field-items">
1719      <div class="param">authdata (required)</div>
1720
1721      <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; JSON authentication data </div>
1722    </div>  <!-- field-items -->
1723
1724
1725
1726
1727    <h3 class="field-label">Return type</h3>
1728    <div class="return-type">
1729      <a href="#inline_response_200">inline_response_200</a>
1730     
1731    </div>
1732
1733    <!--Todo: process Response Object and its headers, schema, examples -->
1734
1735    <h3 class="field-label">Example data</h3>
1736    <div class="example-data-content-type">Content-Type: application/json</div>
1737    <pre class="example"><code>{
1738  "apikey" : "aeiou",
[3b5daf8]1739  "userid" : 123
[ac8b234e]1740}</code></pre>
1741
1742    <h3 class="field-label">Produces</h3>
1743    This API call produces the following media types according to the <span class="header">Accept</span> request header;
1744    the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1745    <ul>
1746      <li><code>application/json</code></li>
1747    </ul>
1748
1749    <h3 class="field-label">Responses</h3>
1750    <h4 class="field-label">200</h4>
1751    Successful login
1752        <a href="#inline_response_200">inline_response_200</a>
1753    <h4 class="field-label">400</h4>
1754    Missing parameters
1755        <a href="#"></a>
1756    <h4 class="field-label">500</h4>
1757    Authentication error
1758        <a href="#"></a>
1759  </div> <!-- method -->
1760  <hr/>
1761
1762  <div class="up"><a href="#__Models">Up</a></div>
1763  <h2><a name="__Models">Models</a></h2>
1764  [ Jump to <a href="#__Methods">Methods</a> ]
1765
1766  <h2>Table of Contents</h2>
1767  <ol>
1768    <li><a href="#authdata"><code>authdata</code></a></li>
1769    <li><a href="#inline_response_200"><code>inline_response_200</code></a></li>
1770    <li><a href="#inline_response_200_1"><code>inline_response_200_1</code></a></li>
1771    <li><a href="#inline_response_200_10"><code>inline_response_200_10</code></a></li>
[3b5daf8]1772    <li><a href="#inline_response_200_11"><code>inline_response_200_11</code></a></li>
[ac8b234e]1773    <li><a href="#inline_response_200_2"><code>inline_response_200_2</code></a></li>
1774    <li><a href="#inline_response_200_3"><code>inline_response_200_3</code></a></li>
1775    <li><a href="#inline_response_200_4"><code>inline_response_200_4</code></a></li>
[3b5daf8]1776    <li><a href="#inline_response_200_4_client"><code>inline_response_200_4_client</code></a></li>
1777    <li><a href="#inline_response_200_4_repo"><code>inline_response_200_4_repo</code></a></li>
[ac8b234e]1778    <li><a href="#inline_response_200_5"><code>inline_response_200_5</code></a></li>
1779    <li><a href="#inline_response_200_6"><code>inline_response_200_6</code></a></li>
1780    <li><a href="#inline_response_200_7"><code>inline_response_200_7</code></a></li>
1781    <li><a href="#inline_response_200_8"><code>inline_response_200_8</code></a></li>
[3b5daf8]1782    <li><a href="#inline_response_200_8_hardware"><code>inline_response_200_8_hardware</code></a></li>
[ac8b234e]1783    <li><a href="#inline_response_200_9"><code>inline_response_200_9</code></a></li>
[3b5daf8]1784    <li><a href="#ousouidimages_ou"><code>ousouidimages_ou</code></a></li>
[ac8b234e]1785  </ol>
1786
1787  <div class="model">
1788    <h3 class="field-label"><a name="authdata">authdata</a> <a class="up" href="#__Models">Up</a></h3>
1789    <div class="field-items">
1790      <div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
[3b5daf8]1791<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: password</div>
[ac8b234e]1792    </div>  <!-- field-items -->
1793  </div>
1794  <div class="model">
1795    <h3 class="field-label"><a name="inline_response_200">inline_response_200</a> <a class="up" href="#__Models">Up</a></h3>
1796    <div class="field-items">
[3b5daf8]1797      <div class="param">userid (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
[ac8b234e]1798<div class="param">apikey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1799    </div>  <!-- field-items -->
1800  </div>
1801  <div class="model">
1802    <h3 class="field-label"><a name="inline_response_200_1">inline_response_200_1</a> <a class="up" href="#__Models">Up</a></h3>
1803    <div class="field-items">
[3b5daf8]1804      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
[ac8b234e]1805<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1806    </div>  <!-- field-items -->
1807  </div>
1808  <div class="model">
1809    <h3 class="field-label"><a name="inline_response_200_10">inline_response_200_10</a> <a class="up" href="#__Models">Up</a></h3>
1810    <div class="field-items">
[3b5daf8]1811      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
1812<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1813<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span>  </div>
1814    </div>  <!-- field-items -->
1815  </div>
1816  <div class="model">
1817    <h3 class="field-label"><a name="inline_response_200_11">inline_response_200_11</a> <a class="up" href="#__Models">Up</a></h3>
1818    <div class="field-items">
1819      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> repository id format: int32</div>
[ac8b234e]1820<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository name </div>
1821<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository description </div>
1822<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository IP address </div>
1823    </div>  <!-- field-items -->
1824  </div>
1825  <div class="model">
1826    <h3 class="field-label"><a name="inline_response_200_2">inline_response_200_2</a> <a class="up" href="#__Models">Up</a></h3>
1827    <div class="field-items">
1828      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  </div>
1829<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1830<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1831    </div>  <!-- field-items -->
1832  </div>
1833  <div class="model">
1834    <h3 class="field-label"><a name="inline_response_200_3">inline_response_200_3</a> <a class="up" href="#__Models">Up</a></h3>
1835    <div class="field-items">
[3b5daf8]1836      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
[ac8b234e]1837<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
1838<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span>  </div>
[3b5daf8]1839<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span>  </div>
[ac8b234e]1840    </div>  <!-- field-items -->
1841  </div>
1842  <div class="model">
1843    <h3 class="field-label"><a name="inline_response_200_4">inline_response_200_4</a> <a class="up" href="#__Models">Up</a></h3>
1844    <div class="field-items">
[3b5daf8]1845      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> image id format: int32</div>
1846<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image name </div>
1847<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image description </div>
1848<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> usable in Remote PC Project flag </div>
1849<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image type (&#x60;&#x60;monolithic&#x60;&#x60;, &#x60;&#x60;basic&#x60;&#x60;, &#x60;&#x60;incremental&#x60;&#x60;) </div>
1850<div class="param">baseimg (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> base image for an incremental image (if &#x60;&#x60;type&#x60;&#x60; is &#x60;&#x60;incremental&#x60;&#x60;) </div>
1851<div class="param">path (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image path (if &#x60;&#x60;type&#x60;&#x60; is &#x60;&#x60;incremental&#x60;&#x60;) </div>
1852<div class="param">repo (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_4_repo">inline_response_200_4_repo</a></span>  </div>
1853<div class="param">client (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_4_client">inline_response_200_4_client</a></span>  </div>
1854<div class="param">creationdate (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> image creation date format: date-time</div>
1855<div class="param">release (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image creation release </div>
1856    </div>  <!-- field-items -->
1857  </div>
1858  <div class="model">
1859    <h3 class="field-label"><a name="inline_response_200_4_client">inline_response_200_4_client</a> <a class="up" href="#__Models">Up</a></h3>
1860    <div class="field-items">
1861      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> model client&#39;s id. format: int32</div>
1862<div class="param">disk (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> model client&#39;s id. format: int32</div>
1863<div class="param">partition (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> model client&#39;s id. format: int32</div>
1864    </div>  <!-- field-items -->
1865  </div>
1866  <div class="model">
1867    <h3 class="field-label"><a name="inline_response_200_4_repo">inline_response_200_4_repo</a> <a class="up" href="#__Models">Up</a></h3>
1868    <div class="field-items">
1869      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
1870    </div>  <!-- field-items -->
1871  </div>
1872  <div class="model">
1873    <h3 class="field-label"><a name="inline_response_200_5">inline_response_200_5</a> <a class="up" href="#__Models">Up</a></h3>
1874    <div class="field-items">
1875      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> laboratory identificator format: int32</div>
[ac8b234e]1876<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory name </div>
1877<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory location </div>
1878<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory description </div>
1879<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>
[3b5daf8]1880<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 format: int32</div>
1881<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 format: int32</div>
[ac8b234e]1882<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>
1883<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>
1884<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>
1885<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>
1886<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>
1887<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>
1888<div class="param">proxyurl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Proxy server URL </div>
[3b5daf8]1889<div class="param">mcastmode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast protocol mode (&#x60;&#x60;full-duplex&#x60;&#x60;, &#x60;&#x60;half-duplex&#x60;&#x60;). </div>
[ac8b234e]1890<div class="param">mcastip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast IP address </div>
[3b5daf8]1891<div class="param">mcastport (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Multicast port format: int32</div>
1892<div class="param">mcastspeed (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Multicast speed (in Mbps) format: int32</div>
[ac8b234e]1893<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>
[3b5daf8]1894<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.) format: int32</div>
[ac8b234e]1895<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>
1896    </div>  <!-- field-items -->
1897  </div>
1898  <div class="model">
[3b5daf8]1899    <h3 class="field-label"><a name="inline_response_200_6">inline_response_200_6</a> <a class="up" href="#__Models">Up</a></h3>
[ac8b234e]1900    <div class="field-items">
[3b5daf8]1901      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
[ac8b234e]1902<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
[3b5daf8]1903<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span>  </div>
1904<div class="param">lab (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span>  </div>
[ac8b234e]1905    </div>  <!-- field-items -->
1906  </div>
1907  <div class="model">
[3b5daf8]1908    <h3 class="field-label"><a name="inline_response_200_7">inline_response_200_7</a> <a class="up" href="#__Models">Up</a></h3>
[ac8b234e]1909    <div class="field-items">
[3b5daf8]1910      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
[ac8b234e]1911<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
1912<div class="param">serialno (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client serial number </div>
1913<div class="param">netiface (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> main network interface </div>
1914<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>
1915<div class="param">mac (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client MAC address </div>
1916<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
1917<div class="param">netmask (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> subnet mask address </div>
1918<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>
[3b5daf8]1919<div class="param">repo (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_4_repo">inline_response_200_4_repo</a></span>  </div>
[ac8b234e]1920<div class="param">validation (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> boot validation flag </div>
1921<div class="param">boottype (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> boot template type </div>
1922<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>
1923    </div>  <!-- field-items -->
1924  </div>
1925  <div class="model">
[3b5daf8]1926    <h3 class="field-label"><a name="inline_response_200_8">inline_response_200_8</a> <a class="up" href="#__Models">Up</a></h3>
[ac8b234e]1927    <div class="field-items">
[3b5daf8]1928      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
[ac8b234e]1929<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
[3b5daf8]1930<div class="param">hardware (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_8_hardware">array[inline_response_200_8_hardware]</a></span> hardware components </div>
[ac8b234e]1931    </div>  <!-- field-items -->
1932  </div>
1933  <div class="model">
[3b5daf8]1934    <h3 class="field-label"><a name="inline_response_200_8_hardware">inline_response_200_8_hardware</a> <a class="up" href="#__Models">Up</a></h3>
[ac8b234e]1935    <div class="field-items">
1936      <div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component type </div>
1937<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component description </div>
1938    </div>  <!-- field-items -->
1939  </div>
1940  <div class="model">
[3b5daf8]1941    <h3 class="field-label"><a name="inline_response_200_9">inline_response_200_9</a> <a class="up" href="#__Models">Up</a></h3>
[ac8b234e]1942    <div class="field-items">
[3b5daf8]1943      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
[ac8b234e]1944<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
1945<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> execution status </div>
1946    </div>  <!-- field-items -->
1947  </div>
1948  <div class="model">
[3b5daf8]1949    <h3 class="field-label"><a name="ousouidimages_ou">ousouidimages_ou</a> <a class="up" href="#__Models">Up</a></h3>
[ac8b234e]1950    <div class="field-items">
[3b5daf8]1951      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span>  format: int32</div>
[ac8b234e]1952    </div>  <!-- field-items -->
1953  </div>
1954  </body>
1955</html>
Note: See TracBrowser for help on using the repository browser.