/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
locked		boolean	Whether the element locked or not
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 ¶

curl -i -X GET 'http://localhost:3080/v2/projects/a4ef9f61-07ca-4744-8e65-079ced0e4fdf/drawings/2ca0b412-917d-4ba3-85c5-c75c72565d39'

GET /v2/projects/a4ef9f61-07ca-4744-8e65-079ced0e4fdf/drawings/2ca0b412-917d-4ba3-85c5-c75c72565d39 HTTP/1.1



HTTP/1.1 200
Connection: close
Content-Length: 344
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:57 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/projects/{project_id}/drawings/{drawing_id}

{
    "drawing_id": "2ca0b412-917d-4ba3-85c5-c75c72565d39",
    "locked": false,
    "project_id": "a4ef9f61-07ca-4744-8e65-079ced0e4fdf",
    "rotation": 0,
    "svg": "<svg height=\"210\" width=\"500\"><line x1=\"0\" y1=\"0\" x2=\"200\" y2=\"200\" style=\"stroke:rgb(255,0,0);stroke-width:2\" /></svg>",
    "x": 10,
    "y": 20,
    "z": 0
}

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
locked		boolean	Whether the element locked or not
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
locked		boolean	Whether the element locked or not
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 ¶

curl -i -X PUT 'http://localhost:3080/v2/projects/6d93155f-b360-4b6e-a036-277cf4f076e5/drawings/fa60bbc1-49d7-4122-92a3-0dff9063058e' -d '{"x": 42}'

PUT /v2/projects/6d93155f-b360-4b6e-a036-277cf4f076e5/drawings/fa60bbc1-49d7-4122-92a3-0dff9063058e HTTP/1.1
{
    "x": 42
}


HTTP/1.1 201
Connection: close
Content-Length: 344
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:57 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/projects/{project_id}/drawings/{drawing_id}

{
    "drawing_id": "fa60bbc1-49d7-4122-92a3-0dff9063058e",
    "locked": false,
    "project_id": "6d93155f-b360-4b6e-a036-277cf4f076e5",
    "rotation": 0,
    "svg": "<svg height=\"210\" width=\"500\"><line x1=\"0\" y1=\"0\" x2=\"200\" y2=\"200\" style=\"stroke:rgb(255,0,0);stroke-width:2\" /></svg>",
    "x": 42,
    "y": 20,
    "z": 0
}

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 ¶

curl -i -X DELETE 'http://localhost:3080/v2/projects/fd4df447-9859-490a-aeeb-a37f30c46754/drawings/e2420e1d-9029-4281-ad88-e0fd24620abe'

DELETE /v2/projects/fd4df447-9859-490a-aeeb-a37f30c46754/drawings/e2420e1d-9029-4281-ad88-e0fd24620abe HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Wed, 08 Jan 2020 02:27:57 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/projects/{project_id}/drawings/{drawing_id}