Skip to main content
PUT
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
diagrams
/
{diagramId}
Upsert
curl --request PUT \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "index": 123,
  "modelId": "<string>",
  "name": "<string>",
  "type": "app-diagram",
  "commit": 123,
  "description": "<string>",
  "groupId": "<string>",
  "labels": {},
  "parentId": "<string>",
  "pinned": true,
  "pinnedAt": "2023-11-07T05:31:56Z",
  "pinnedIndex": 123,
  "status": "current",
  "zoomOverrides": {},
  "handleId": "<string>",
  "comments": {},
  "connections": {},
  "objects": {}
}
'
{
  "diagram": {
    "commit": 123,
    "description": "<string>",
    "groupId": "<string>",
    "index": 123,
    "labels": {},
    "modelId": "<string>",
    "name": "<string>",
    "parentId": "<string>",
    "pinned": true,
    "status": "current",
    "handleId": "<string>",
    "type": "app-diagram",
    "commentCount": 123,
    "connectionCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "id": "<string>",
    "landscapeId": "<string>",
    "objectCount": {
      "actor": 123,
      "app": 123,
      "group": 123,
      "component": 123,
      "store": 123,
      "system": 123,
      "area": 123,
      "box": 123
    },
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123,
    "versionId": "<string>",
    "pinnedAt": "2023-11-07T05:31:56Z",
    "pinnedIndex": 123,
    "zoomOverrides": {},
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "user",
    "deletedById": "<string>",
    "latestEntityId": "<string>"
  }
}

Headers

​
Authorization
string
required

Path Parameters

​
landscapeId
string
required
​
versionId
string
required
​
diagramId
string
required

Query Parameters

​
updateViewedAt
boolean

Body

application/json
​
index
number
required
​
modelId
string
required

model object id this object belongs to

​
name
string
required
​
type
enum<string>
required
Available options:
app-diagram,
component-diagram,
context-diagram
​
commit
number
​
description
string
​
groupId
string | null
​
labels
object
​
parentId
string | null
​
pinned
boolean
​
pinnedAt
string<date-time>
​
pinnedIndex
number
​
status
enum<string>
Available options:
current
​
zoomOverrides
object

Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.

​
handleId
string
​
comments
object
​
connections
object
​
objects
object

Response

OK

​
diagram
object
required
​
diagramContent
object