gns3-server/docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst

/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

• 201: Drawing updated
• 400: Invalid request

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

• 204: Drawing deleted
• 400: Invalid request

Sample session

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