Update - IcePanel

PATCH

playgrounds

{playgroundId}

content

curl --request PATCH \
  --url https://api.icepanel.io/v1/playgrounds/{playgroundId}/content \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "connections": {
    "$add": {},
    "$remove": {},
    "$replace": {},
    "$update": {}
  },
  "objects": {
    "$add": {},
    "$remove": {},
    "$replace": {},
    "$update": {}
  },
  "version": 123
}'

{
  "playgroundContent": {
    "connections": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "id": "<string>",
    "objects": {},
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123
  }
}

Headers

Authorization

string

required

Path Parameters

playgroundId

string

required

Body

application/json

connections

object

connections.$add

object

connections.$remove

object

connections.$replace

object

connections.$update

object

objects

object

objects.$add

object

objects.$add.{key}

object

objects.$add.{key}.external

boolean

required

objects.$add.{key}.height

number

required

objects.$add.{key}.icon

object | null

required

objects.$add.{key}.icon.catalogTechnologyId

string

required

objects.$add.{key}.icon.name

string

required

objects.$add.{key}.icon.urlDark

string

Icon that only works on dark backgrounds

Example:

[
  "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
  "/dark/{catalogTechnologyId}.png"
]

objects.$add.{key}.icon.urlLight

string

Icon that only works on light backgrounds

Example:

[
  "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
  "/light/{catalogTechnologyId}.png"
]

objects.$add.{key}.id

string

required

objects.$add.{key}.name

string

required

objects.$add.{key}.shape

enum<string>

required

Available options:

actor,

area,

box,

store

objects.$add.{key}.technologyIds

string[]

required

objects.$add.{key}.version

number

required

objects.$add.{key}.width

number

required

objects.$add.{key}.x

number

required

objects.$add.{key}.y

number

required

objects.$remove

object

objects.$replace

object

objects.$replace.{key}

object

objects.$replace.{key}.external

boolean

required

objects.$replace.{key}.height

number

required

objects.$replace.{key}.icon

object | null

required

objects.$replace.{key}.icon.catalogTechnologyId

string

required

objects.$replace.{key}.icon.name

string

required

objects.$replace.{key}.icon.urlDark

string

Icon that only works on dark backgrounds

Example:

[
  "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
  "/dark/{catalogTechnologyId}.png"
]

objects.$replace.{key}.icon.urlLight

string

Icon that only works on light backgrounds

Example:

[
  "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
  "/light/{catalogTechnologyId}.png"
]

objects.$replace.{key}.id

string

required

objects.$replace.{key}.name

string

required

objects.$replace.{key}.shape

enum<string>

required

Available options:

actor,

area,

box,

store

objects.$replace.{key}.technologyIds

string[]

required

objects.$replace.{key}.version

number

required

objects.$replace.{key}.width

number

required

objects.$replace.{key}.x

number

required

objects.$replace.{key}.y

number

required

objects.$update

object

objects.$update.{key}

object

objects.$update.{key}.external

boolean

objects.$update.{key}.height

number

objects.$update.{key}.icon

object | null

objects.$update.{key}.icon.catalogTechnologyId

string

required

objects.$update.{key}.icon.name

string

required

objects.$update.{key}.icon.urlDark

string

Icon that only works on dark backgrounds

Example:

[
  "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
  "/dark/{catalogTechnologyId}.png"
]

objects.$update.{key}.icon.urlLight

string

Icon that only works on light backgrounds

Example:

[
  "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
  "/light/{catalogTechnologyId}.png"
]

objects.$update.{key}.id

string

objects.$update.{key}.name

string

objects.$update.{key}.shape

enum<string>

Available options:

actor,

area,

box,

store

objects.$update.{key}.technologyIds

string[]

objects.$update.{key}.version

number

objects.$update.{key}.width

number

objects.$update.{key}.x

number

objects.$update.{key}.y

number

version

number

Response

200

application/json

playgroundContent

object

required

playgroundContent.connections

object

required

playgroundContent.createdAt

string

required

playgroundContent.createdBy

enum<string>

required

Available options:

user,

api-key,

notification-key,

service

playgroundContent.createdById

string

required

playgroundContent.id

string

required

playgroundContent.objects

object

required

playgroundContent.objects.{key}

object

playgroundContent.objects.{key}.external

boolean

required

playgroundContent.objects.{key}.height

number

required

playgroundContent.objects.{key}.icon

object | null

required

playgroundContent.objects.{key}.icon.catalogTechnologyId

string

required

playgroundContent.objects.{key}.icon.name

string

required

playgroundContent.objects.{key}.icon.urlDark

string

Icon that only works on dark backgrounds

Example:

[
  "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
  "/dark/{catalogTechnologyId}.png"
]

playgroundContent.objects.{key}.icon.urlLight

string

Icon that only works on light backgrounds

Example:

[
  "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
  "/light/{catalogTechnologyId}.png"
]

playgroundContent.objects.{key}.id

string

required

playgroundContent.objects.{key}.name

string

required

playgroundContent.objects.{key}.shape

enum<string>

required

Available options:

actor,

area,

box,

store

playgroundContent.objects.{key}.technologyIds

string[]

required

playgroundContent.objects.{key}.version

number

required

playgroundContent.objects.{key}.width

number

required

playgroundContent.objects.{key}.x

number

required

playgroundContent.objects.{key}.y

number

required

playgroundContent.updatedAt

string

required

playgroundContent.updatedBy

enum<string>

required

Available options:

user,

api-key,

notification-key,

service

playgroundContent.updatedById

string

required

playgroundContent.version

number

required

Find Create

curl --request PATCH \
  --url https://api.icepanel.io/v1/playgrounds/{playgroundId}/content \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "connections": {
    "$add": {},
    "$remove": {},
    "$replace": {},
    "$update": {}
  },
  "objects": {
    "$add": {},
    "$remove": {},
    "$replace": {},
    "$update": {}
  },
  "version": 123
}'

{
  "playgroundContent": {
    "connections": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "id": "<string>",
    "objects": {},
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123
  }
}

Action Logs

API Keys

Azure DevOps

Bitbucket

Bitbucket Server

Catalog News Articles

Catalog Technologies

Code Repos

Comment Replies

Comments

Diagram Contents

Diagram Groups

Diagrams

Domains

Flows

Github

Gitlab

Health

Landscapes

Landscape Search

Landscape Templates

Landscape Thumbnails

Model Connections

Model Objects

News

Organization Billing

Organization Icons

Organization Landscapes

Organizations

Organization Technologies

Organization User Invites

Organization Users

Playgrounds

Playground Contents

Playground Shares

Share Link

Share Link Options

Share Link Public

Support

Tag Groups

Tags

Teams

User

User Notifications

User Goals

Version Reverts

Versions

Headers

Path Parameters

Body

Response