Project Diagram
To enable this feature, please reach out to your Customer Success Manager (CSM).
Get a Project Diagram
This endpoint retrieves a project diagram.
The diagram is formatted in JSON according to a proprietary JSON Schema. The schema is hosted on your instance and its location is included in the schema property of a diagram response.
GET /api/v2/projects/{project_id}/diagram/
URL Parameters
| Parameter | Description |
|---|---|
| project_id | The ID of the Project |
Sample Diagram
The example payload represents the diagram below.
GET /api/v2/projects/{project_id}/diagram/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
"last_updated": "2024-07-22T22:41:00.792198-04:00",
"updated_by": "admin@sdelements.com",
"data": {
"nodes": [
{
"parent": null,
"label": "Amazon Aurora",
"id": "ec190e36-d276-486b-81c3-07b49f05796b",
"component_id": "SC12",
"type": "component",
"representations": {
"diagram": {
"position": {
"x": 266,
"y": 115
}
}
}
},
{
"parent": null,
"label": "Azure Active Directory",
"id": "be67adbc-8010-419f-afab-2b0b9f6031bf",
"component_id": "SC18",
"type": "component",
"representations": {
"diagram": {
"position": {
"x": 592,
"y": 130
}
}
}
},
{
"parent": "85d6e089-b845-4869-952d-5c4845e1f9bb",
"label": "Google Cloud DNS",
"id": "5fb74279-524a-4263-87df-850adbd6148b",
"component_id": "SC16",
"type": "component",
"representations": {
"diagram": {
"position": {
"x": 258,
"y": 233
}
}
}
},
{
"parent": null,
"label": "Zone",
"id": "85d6e089-b845-4869-952d-5c4845e1f9bb",
"type": "zone",
"representations": {
"diagram": {
"position": {
"x": 258,
"y": 247.5
}
}
}
}
],
"edges": [
{
"id": "2b5731cc-2415-41f7-b60f-e9041d4136c0",
"label": "",
"source": "ec190e36-d276-486b-81c3-07b49f05796b",
"target": "be67adbc-8010-419f-afab-2b0b9f6031bf",
"out_of_scope": false,
"directionality": "single",
"representations": {
"diagram": {
"line_style": "solid"
}
}
},
{
"id": "73146252-a14f-45ed-993e-a80c40e834d5",
"label": "",
"source": "be67adbc-8010-419f-afab-2b0b9f6031bf",
"target": "ec190e36-d276-486b-81c3-07b49f05796b",
"out_of_scope": false,
"directionality": "single",
"representations": {
"diagram": {
"line_style": "solid"
}
}
}
],
"representations": {
"diagram": {
"annotations": [
{
"text": "Hello!",
"left": 556.5,
"top": 294,
"width": 116,
"height": 15.82,
"angle": 0
}
]
}
},
"sdelements": {
"type": "system-graph"
}
}