Breadcrumbs

Metavault API - Get diagram

GetDiagram - GET

Path

/api/projects/{projectId}/model/diagram

Http Method

GET

Overview

Required permissions

  • Read access to the Build module. BUILD read

Request

Request body

JSON
{
  "entityPositions": [
    {
      "entityId": "1d21d08f-1ede-4c24-8e58-3b0b982fdefb",
      "diagramPosition": {
        "x": -250,
        "y": 30
      }
    },
    {
      "entityId": "7cd9a94a-8908-4872-b508-3b1b08746dc0",
      "diagramPosition": {
        "x": -155.34113857064864,
        "y": -73.67490585371965
      }
    },
    {
      "entityId": "778f0882-fc72-413e-b0df-723c51c2372b",
      "diagramPosition": {
        "x": -184.54278414085115,
        "y": 60.54629818513929
      }
    }
  ],
  "draftNodes": [
    {
      "diagramPosition": {
        "x": -240,
        "y": -180
      },
      "name": "DraftHub1",
      "nodeType": "Hub",
      "id": "draft-Hub-DraftHub1"
    },
    {
      "diagramPosition": {
        "x": -372.125,
        "y": -78.8
      },
      "name": "DraftLink1",
      "nodeType": "Link",
      "id": "draft-Link-DraftLink1"
    }
  ],
  "draftConnections": [
    {
      "from": "draft-Hub-DraftHub1",
      "to": "draft-Link-DraftLink1",
      "name": "DraftHub1"
    },
    {
      "from": "1d21d08f-1ede-4c24-8e58-3b0b982fdefb",
      "to": "draft-Link-DraftLink1",
      "name": "Team"
    }
  ]
}

Response

Success response (200 OK)

JSON
{
  "entityPositions": [
    {
      "entityId": "1d21d08f-1ede-4c24-8e58-3b0b982fdefb",
      "diagramPosition": {
        "x": -250,
        "y": 30
      }
    },
    {
      "entityId": "7cd9a94a-8908-4872-b508-3b1b08746dc0",
      "diagramPosition": {
        "x": -155.34113857064864,
        "y": -73.67490585371965
      }
    },
    {
      "entityId": "778f0882-fc72-413e-b0df-723c51c2372b",
      "diagramPosition": {
        "x": -184.54278414085115,
        "y": 60.54629818513929
      }
    }
  ],
  "draftNodes": [
    {
      "id": "draft-Hub-DraftHub1",
      "name": "DraftHub1",
      "nodeType": "Hub",
      "diagramPosition": {
        "x": -240,
        "y": -180
      }
    },
    {
      "id": "draft-Link-DraftLink1",
      "name": "DraftLink1",
      "nodeType": "Link",
      "diagramPosition": {
        "x": -372.125,
        "y": -78.8
      }
    }
  ],
  "draftConnections": [
    {
      "name": "DraftHub1",
      "from": "draft-Hub-DraftHub1",
      "to": "draft-Link-DraftLink1"
    },
    {
      "name": "Team",
      "from": "1d21d08f-1ede-4c24-8e58-3b0b982fdefb",
      "to": "draft-Link-DraftLink1"
    }
  ]
}