/v2/projects/{project_id}/drawings¶
GET /v2/projects/{project_id}/drawings¶
List drawings of a project
Parameters¶
project_id: Project UUID
Response status codes¶
200: List of drawings returned
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/projects/de7a5304-5089-4d87-b131-ab463aa9d708/drawings'
GET /v2/projects/de7a5304-5089-4d87-b131-ab463aa9d708/drawings HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 388
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": "2ebb202d-7cd6-4e0e-8448-736f6aa9c873",
"locked": false,
"project_id": "de7a5304-5089-4d87-b131-ab463aa9d708",
"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
}
]
POST /v2/projects/{project_id}/drawings¶
Create a new drawing instance
Parameters¶
project_id: Project UUID
Response status codes¶
201: Drawing created
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 POST 'http://localhost:3080/v2/projects/db6a5cdc-2bed-4769-bc5e-3f260ca6d0ea/drawings' -d '{"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}'
POST /v2/projects/db6a5cdc-2bed-4769-bc5e-3f260ca6d0ea/drawings HTTP/1.1
{
"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
}
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": "62afa856-4a43-4444-a376-60f6f963bb3d",
"locked": false,
"project_id": "db6a5cdc-2bed-4769-bc5e-3f260ca6d0ea",
"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
}