2016-03-11 16:16:09 +00:00
|
|
|
/v2/projects
|
2016-03-11 14:21:21 +00:00
|
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
|
2016-03-11 16:16:09 +00:00
|
|
|
POST /v2/projects
|
2016-03-11 14:21:21 +00:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
Create a new project on the server
|
|
|
|
|
|
|
|
|
|
Response status codes
|
|
|
|
|
**********************
|
|
|
|
|
- **201**: Project created
|
|
|
|
|
- **409**: Project already created
|
|
|
|
|
|
|
|
|
|
Input
|
|
|
|
|
*******
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
2016-08-25 12:43:19 +00:00
|
|
|
<tr><td>auto_close</td> <td> </td> <td>boolean</td> <td>Project auto close</td> </tr>
|
2017-03-06 13:35:39 +00:00
|
|
|
<tr><td>name</td> <td>✔</td> <td>['string', 'null']</td> <td>Project name</td> </tr>
|
2016-03-11 14:21:21 +00:00
|
|
|
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
|
|
|
|
|
<tr><td>project_id</td> <td> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
|
2016-09-27 15:15:40 +00:00
|
|
|
<tr><td>scene_height</td> <td> </td> <td>integer</td> <td>Height of the drawing area</td> </tr>
|
|
|
|
|
<tr><td>scene_width</td> <td> </td> <td>integer</td> <td>Width of the drawing area</td> </tr>
|
2016-03-11 14:21:21 +00:00
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
Output
|
|
|
|
|
*******
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
2016-08-25 12:43:19 +00:00
|
|
|
<tr><td>auto_close</td> <td> </td> <td>boolean</td> <td>Project auto close when client cut off the notifications feed</td> </tr>
|
|
|
|
|
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
|
|
|
|
|
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
|
2016-06-17 09:12:22 +00:00
|
|
|
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
|
2016-03-11 14:21:21 +00:00
|
|
|
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
|
|
|
|
|
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
|
|
|
|
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
2016-09-27 15:15:40 +00:00
|
|
|
<tr><td>scene_height</td> <td> </td> <td>integer</td> <td>Height of the drawing area</td> </tr>
|
|
|
|
|
<tr><td>scene_width</td> <td> </td> <td>integer</td> <td>Width of the drawing area</td> </tr>
|
2016-06-17 09:12:22 +00:00
|
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
|
2016-03-11 14:21:21 +00:00
|
|
|
</table>
|
|
|
|
|
|
2017-03-21 12:32:04 +00:00
|
|
|
Sample session
|
|
|
|
|
***************
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_post_projects.txt
|
|
|
|
|
|
2016-05-11 17:35:36 +00:00
|
|
|
|
|
|
|
|
GET /v2/projects
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
List projects
|
|
|
|
|
|
|
|
|
|
Response status codes
|
|
|
|
|
**********************
|
|
|
|
|
- **200**: List of projects
|
|
|
|
|
|
2017-03-21 12:32:04 +00:00
|
|
|
Sample session
|
|
|
|
|
***************
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_get_projects.txt
|
|
|
|
|
|
