1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst

117 lines
6.3 KiB
ReStructuredText
Raw Normal View History

2016-06-23 09:17:23 +00:00
/v2/projects/{project_id}/drawings/{drawing_id}
2016-06-21 08:35:43 +00:00
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
2018-01-08 08:26:44 +00:00
GET /v2/projects/**{project_id}**/drawings/**{drawing_id}**
2016-06-21 08:35:43 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2018-01-08 08:26:44 +00:00
Get a drawing instance
2016-06-21 08:35:43 +00:00
Parameters
**********
2018-01-08 04:57:07 +00:00
- **project_id**: Project UUID
2018-01-08 08:26:44 +00:00
- **drawing_id**: Drawing UUID
2016-06-21 08:35:43 +00:00
Response status codes
**********************
2018-01-08 08:26:44 +00:00
- **200**: Drawing found
2017-03-06 13:35:39 +00:00
- **400**: Invalid request
2018-01-08 08:26:44 +00:00
- **404**: Drawing doesn't exist
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
2019-03-30 08:56:26 +00:00
<tr><td>locked</td> <td> </td> <td>boolean</td> <td>Whether the element locked or not</td> </tr>
2018-01-08 08:26:44 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z property</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectiddrawingsdrawingid.txt
PUT /v2/projects/**{project_id}**/drawings/**{drawing_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
Response status codes
**********************
- **201**: Drawing updated
- **400**: Invalid request
2016-06-21 08:35:43 +00:00
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-23 10:29:15 +00:00
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
2019-03-30 08:56:26 +00:00
<tr><td>locked</td> <td> </td> <td>boolean</td> <td>Whether the element locked or not</td> </tr>
2016-06-21 08:35:43 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
2016-06-22 16:14:14 +00:00
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
2016-06-23 09:17:23 +00:00
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
2016-06-21 08:35:43 +00:00
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z property</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-23 10:29:15 +00:00
<tr><td>drawing_id</td> <td> </td> <td>string</td> <td>Drawing UUID</td> </tr>
2019-03-30 08:56:26 +00:00
<tr><td>locked</td> <td> </td> <td>boolean</td> <td>Whether the element locked or not</td> </tr>
2016-06-21 08:35:43 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
2016-06-22 16:14:14 +00:00
<tr><td>rotation</td> <td> </td> <td>integer</td> <td>Rotation of the element</td> </tr>
2016-06-23 09:17:23 +00:00
<tr><td>svg</td> <td> </td> <td>string</td> <td>SVG content of the drawing</td> </tr>
2016-06-21 08:35:43 +00:00
<tr><td>x</td> <td> </td> <td>integer</td> <td>X property</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y property</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z property</td> </tr>
</table>
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectiddrawingsdrawingid.txt
2016-06-21 08:35:43 +00:00
2016-06-23 09:17:23 +00:00
DELETE /v2/projects/**{project_id}**/drawings/**{drawing_id}**
2016-06-21 08:35:43 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-23 09:17:23 +00:00
Delete a drawing instance
2016-06-21 08:35:43 +00:00
Parameters
**********
2018-01-08 04:57:07 +00:00
- **project_id**: Project UUID
2018-01-08 08:26:44 +00:00
- **drawing_id**: Drawing UUID
2016-06-21 08:35:43 +00:00
Response status codes
**********************
- **204**: Drawing deleted
- **400**: Invalid request
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectiddrawingsdrawingid.txt
2017-03-21 12:32:04 +00:00