ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2025-01-11 23:42:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
0f496907a0
gns3-server/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
grossmj 0f496907a0 Fix API status code for start/stop/suspend/reload a node. Fixes #1353. 
Fix issues with test.
Update documentation.
2018-06-14 16:39:32 +08:00

5.8 KiB
Raw Blame History

/v2/projects/{project_id}/drawings/{drawing_id}

GET /v2/projects/{project_id}/drawings/{drawing_id}

Get a drawing instance

Parameters

  • project_id: Project UUID
  • drawing_id: Drawing UUID

Response status codes

  • 200: Drawing found
  • 400: Invalid request
  • 404: Drawing doesn't exist

Output

Name Mandatory Type Description
drawing_id string Drawing UUID
project_id string Project UUID
rotation integer Rotation of the element
svg string SVG content of the drawing
x integer X property
y integer Y property
z integer Z property

Sample session

../../../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

  • 400: Invalid request
  • 201: Drawing updated

Input

Name Mandatory Type Description
drawing_id string Drawing UUID
project_id string Project UUID
rotation integer Rotation of the element
svg string SVG content of the drawing
x integer X property
y integer Y property
z integer Z property

Output

Name Mandatory Type Description
drawing_id string Drawing UUID
project_id string Project UUID
rotation integer Rotation of the element
svg string SVG content of the drawing
x integer X property
y integer Y property
z integer Z property

Sample session

../../../examples/controller_put_projectsprojectiddrawingsdrawingid.txt

DELETE /v2/projects/{project_id}/drawings/{drawing_id}

Delete a drawing instance

Parameters

  • project_id: Project UUID
  • drawing_id: Drawing UUID

Response status codes

  • 400: Invalid request
  • 204: Drawing deleted

Sample session

../../../examples/controller_delete_projectsprojectiddrawingsdrawingid.txt