Diagrams
post/landscapes/{landscapeId}/versions/{versionId}/diagrams

Request

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

Path parameters

landscapeIdstring required
versionIdstring required

Query parameters

updateViewedAtboolean

Request body

commitnumber

The commit number of the diagram content, incremented on each change

descriptionstring
groupIdstring nullable
indexnumber required
labelsobject
modelIdstring required

model object id this object belongs to

namestring required
parentIdstring nullable
pinnedboolean
pinnedAtstring date-time
pinnedIndexnumber
status'current'
zoomOverridesDiagramZoomOverridesNullable

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

handleIdstring
type'app-diagram' | 'component-diagram' | 'context-diagram' required
commentsobject

The comments on the diagram, keyed by comment id

connectionsobject

The connections on the diagram, keyed by connection id

objectsobject

The objects on the diagram, keyed by object id

Response

OK

Changes

    • info

      added the new optional request property //////

    • info

      added the optional property /// to the response with the status

    • warning

      the ////// request property's max was set to 100.00

    • warning

      the ////// request property's min was set to 0.00

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional