ICicepanel
Model Objects

Update

Changed on
patch/landscapes/{landscapeId}/versions/{versionId}/model/objects/{modelObjectId}

Request

  • Base URL
    https://api.icepanel.io/v1
  • URL
    https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/model/objects/{modelObjectId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

landscapeIdstring required
versionIdstring required
modelObjectIdstring required

Request body

captionstring

Short summary of the object shown as the display description

commitnumber
descriptionstring
externalboolean
labelsobject

Generic key value store used for creating custom integrations

namestring
parentIdstring nullable

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

status'deprecated' | 'future' | 'live' | 'removed'
teamOnlyEditingboolean

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

type'actor' | 'app' | 'component' | 'group' | 'root' | 'store' | 'system'

Response

OK

Changes