PATCH
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
diagrams
/
{diagramId}
Update
curl --request PATCH \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "commit": 123,
  "description": "<string>",
  "groupId": "<string>",
  "index": 123,
  "labels": {},
  "modelId": "<string>",
  "name": "<string>",
  "parentId": "<string>",
  "pinned": true,
  "pinnedAt": "2023-11-07T05:31:56Z",
  "pinnedIndex": 123,
  "status": "current",
  "zoomOverrides": {},
  "comments": {
    "$add": {},
    "$remove": [
      "<string>"
    ],
    "$replace": {},
    "$update": {}
  },
  "connections": {
    "$add": {},
    "$remove": [
      "<string>"
    ],
    "$replace": {},
    "$update": {}
  },
  "objects": {
    "$add": {},
    "$remove": [
      "<string>"
    ],
    "$replace": {},
    "$update": {}
  },
  "tasksProposed": {
    "$append": [
      "<any>"
    ],
    "$replace": [
      "<any>"
    ]
  }
}'
{
  "diagram": {
    "commit": 123,
    "description": "<string>",
    "groupId": "<string>",
    "index": 123,
    "labels": {},
    "modelId": "<string>",
    "name": "<string>",
    "parentId": "<string>",
    "pinned": true,
    "pinnedAt": "2023-11-07T05:31:56Z",
    "pinnedIndex": 123,
    "status": "current",
    "zoomOverrides": {},
    "handleId": "<string>",
    "type": "app-diagram",
    "commentCount": 123,
    "connectionCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "user",
    "deletedById": "<string>",
    "id": "<string>",
    "landscapeId": "<string>",
    "objectCount": {
      "actor": 123,
      "app": 123,
      "group": 123,
      "component": 123,
      "store": 123,
      "system": 123,
      "area": 123,
      "box": 123
    },
    "stats": {
      "edits": {
        "all": {
          "count": 123,
          "users": {}
        },
        "day": {},
        "month": {},
        "week": {}
      },
      "views": {
        "all": {
          "count": 123,
          "users": {}
        },
        "day": {},
        "month": {},
        "week": {}
      }
    },
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123,
    "versionId": "<string>"
  },
  "diagramContent": {
    "comments": {},
    "commit": 123,
    "connections": {},
    "objects": {},
    "tasksProposed": [
      {
        "proposedAt": "2023-11-07T05:31:56Z",
        "proposedBy": "user",
        "proposedById": "<string>",
        "task": "<any>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "user",
    "deletedById": "<string>",
    "groupId": "<string>",
    "handleId": "<string>",
    "id": "<string>",
    "landscapeId": "<string>",
    "modelId": "<string>",
    "name": "<string>",
    "status": "current",
    "type": "app-diagram",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123,
    "versionId": "<string>",
    "viewedAt": "2023-11-07T05:31:56Z",
    "viewedBy": "user",
    "viewedById": "<string>"
  }
}

Headers

Authorization
string
required

Path Parameters

landscapeId
string
required
versionId
string
required
diagramId
string
required

Query Parameters

updateViewedAt
boolean

Body

application/json
commit
number
description
string
groupId
string | null
index
number
labels
object
modelId
string

model object id this object belongs to

name
string
parentId
string | null
pinned
boolean
pinnedAt
string<date-time>
pinnedIndex
number
status
enum<string>
Available options:
current,
draft
zoomOverrides
object | null

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

comments
object
connections
object
objects
object
tasksProposed
object

Response

OK

diagram
object
required
diagramContent
object