Skip to main content
PATCH
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
model
/
objects
/
{modelObjectId}
Update
curl --request PATCH \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/model/objects/{modelObjectId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "caption": "<string>",
  "commit": 123,
  "description": "<string>",
  "external": true,
  "groupIds": [
    "<string>"
  ],
  "icon": {
    "catalogTechnologyId": "<string>",
    "name": "<string>",
    "url": "<string>",
    "urlDark": [
      "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
      "/dark/{catalogTechnologyId}.png"
    ],
    "urlLight": [
      "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
      "/light/{catalogTechnologyId}.png"
    ]
  },
  "labels": {},
  "links": {
    "$add": {},
    "$remove": [
      "<string>"
    ],
    "$replace": {},
    "$update": {}
  },
  "name": "<string>",
  "parentId": "<string>",
  "status": "deprecated",
  "tagIds": [
    "<string>"
  ],
  "teamIds": [
    "<string>"
  ],
  "teamOnlyEditing": true,
  "technologyIds": [
    "<string>"
  ],
  "type": "actor"
}
'
{
  "modelObject": {
    "commit": 123,
    "external": true,
    "groupIds": [
      "<string>"
    ],
    "icon": {
      "catalogTechnologyId": "<string>",
      "name": "<string>",
      "url": "<string>",
      "urlDark": [
        "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
        "/dark/{catalogTechnologyId}.png"
      ],
      "urlLight": [
        "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
        "/light/{catalogTechnologyId}.png"
      ]
    },
    "labels": {},
    "links": {},
    "name": "<string>",
    "parentId": "<string>",
    "status": "deprecated",
    "tagIds": [
      "<string>"
    ],
    "teamIds": [
      "<string>"
    ],
    "teamOnlyEditing": true,
    "technologyIds": [
      "<string>"
    ],
    "type": "actor",
    "domainId": "<string>",
    "handleId": "<string>",
    "childDiagramIds": [
      "<string>"
    ],
    "childIds": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "diagrams": {},
    "flows": {},
    "id": "<string>",
    "landscapeId": "<string>",
    "linked": true,
    "parentIds": [
      "<string>"
    ],
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123,
    "versionId": "<string>",
    "caption": "<string>",
    "description": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "user",
    "deletedById": "<string>",
    "latestEntityId": "<string>"
  }
}

Headers

​
Authorization
string
required

Path Parameters

​
landscapeId
string
required
​
versionId
string
required
​
modelObjectId
string
required

Body

application/json
​
caption
string

Short summary of the object shown as the display description

​
commit
number
​
description
string
​
external
boolean
​
groupIds

IDs of the groups this model object belongs to

​
icon
object
​
labels
object

Generic key value store used for creating custom integrations

​
links
object
​
name
string
​
parentId
string | null

Parent model object ID, null for the root level model object

​
status
enum<string>
Available options:
deprecated,
future,
live,
removed
​
tagIds

Tag IDs assigned to this model

​
teamIds

Team IDs that own this model object, does not propergate up or down

​
teamOnlyEditing
boolean

Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins

​
technologyIds

Technology ids assigned to this model

​
type
enum<string>
Available options:
actor,
app,
component,
group,
root,
store,
system

Response

OK

​
modelObject
object
required