/v2/projects/{project_id}/drawings/{drawing_id}¶
Contents
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¶
curl -i -X GET 'http://localhost:3080/v2/projects/e45e88b7-4fe3-46c8-9daf-1a60461b6380/drawings/3348ce13-01f1-49ef-9582-057b820fff1f'
GET /v2/projects/e45e88b7-4fe3-46c8-9daf-1a60461b6380/drawings/3348ce13-01f1-49ef-9582-057b820fff1f HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 323
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:35:13 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/drawings/{drawing_id}
{
"drawing_id": "3348ce13-01f1-49ef-9582-057b820fff1f",
"project_id": "e45e88b7-4fe3-46c8-9daf-1a60461b6380",
"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¶
- 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¶
curl -i -X PUT 'http://localhost:3080/v2/projects/600de23c-5af1-44a1-8c67-3023ceb6e6c7/drawings/5f9c48be-d144-4666-a66f-5bc6d93e2f32' -d '{"x": 42}'
PUT /v2/projects/600de23c-5af1-44a1-8c67-3023ceb6e6c7/drawings/5f9c48be-d144-4666-a66f-5bc6d93e2f32 HTTP/1.1
{
"x": 42
}
HTTP/1.1 201
Connection: close
Content-Length: 323
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:35:13 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/drawings/{drawing_id}
{
"drawing_id": "5f9c48be-d144-4666-a66f-5bc6d93e2f32",
"project_id": "600de23c-5af1-44a1-8c67-3023ceb6e6c7",
"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¶
- 400: Invalid request
- 204: Drawing deleted
Sample session¶
curl -i -X DELETE 'http://localhost:3080/v2/projects/74c2978e-03fe-4873-ac04-433fb93cb2b0/drawings/7447cc2c-18fb-4db7-87a7-11b81ebd036d'
DELETE /v2/projects/74c2978e-03fe-4873-ac04-433fb93cb2b0/drawings/7447cc2c-18fb-4db7-87a7-11b81ebd036d HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Thu, 14 Jun 2018 08:35:13 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/drawings/{drawing_id}