GET
/
share-links
/
{shortId}
/
landscape
curl --request GET \
  --url https://api.icepanel.io/v1/share-links/{shortId}/landscape
{
  "comments": [
    {
      "body": {
        "content": "<string>",
        "showContentPreview": true,
        "status": "open",
        "type": "question"
      },
      "commit": 123,
      "mentionedUserIds": [
        "<string>"
      ],
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "diagrams": {},
      "id": "<string>",
      "landscapeId": "<string>",
      "replyCount": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "diagramContents": [
    {
      "comments": {},
      "commit": 123,
      "connections": {},
      "objects": {},
      "tasksProposed": [
        {
          "proposedAt": "2023-11-07T05:31:56Z",
          "proposedBy": "user",
          "proposedById": "<string>",
          "task": {
            "tasks": [
              "<any>"
            ],
            "type": "batch"
          }
        }
      ],
      "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>"
    }
  ],
  "diagramGroups": [
    {
      "commit": 123,
      "index": 123,
      "labels": {},
      "modelId": "<string>",
      "name": "<string>",
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "id": "<string>",
      "landscapeId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "diagramThumbnails": {},
  "diagrams": [
    {
      "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",
      "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>"
    }
  ],
  "domains": [
    {
      "commit": 123,
      "index": 123,
      "labels": {},
      "name": "<string>",
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "id": "<string>",
      "landscapeId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "flowThumbnails": {},
  "flows": [
    {
      "commit": 123,
      "index": 123,
      "labels": {},
      "name": "<string>",
      "pinned": true,
      "pinnedAt": "2023-11-07T05:31:56Z",
      "pinnedIndex": 123,
      "showAllSteps": true,
      "showConnectionNames": true,
      "steps": {},
      "diagramId": "<string>",
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "id": "<string>",
      "landscapeId": "<string>",
      "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>",
      "viewedAt": "2023-11-07T05:31:56Z",
      "viewedBy": "user",
      "viewedById": "<string>"
    }
  ],
  "landscape": {
    "name": "<string>",
    "scheduledVersions": true,
    "organizationId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "id": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>"
  },
  "landscapeThumbnailsSignedUrl": "<string>",
  "modelConnections": [
    {
      "commit": 123,
      "description": "<string>",
      "direction": "outgoing",
      "labels": {},
      "name": "<string>",
      "originId": "<string>",
      "status": "deprecated",
      "tagIds": [
        "<string>"
      ],
      "targetId": "<string>",
      "technologyIds": [
        "<string>"
      ],
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "diagrams": {},
      "flows": {},
      "id": "<string>",
      "landscapeId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "modelObjects": [
    {
      "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": {},
      "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>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "diagrams": {},
      "flows": {},
      "id": "<string>",
      "landscapeId": "<string>",
      "parentIds": [
        "<string>"
      ],
      "technologies": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "organizationBrand": {
    "name": "<string>"
  },
  "organizationIconsSignedUrl": "<string>",
  "organizationTechnologies": [
    {
      "category": "<string>",
      "color": "blue",
      "deprecatedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "docsUrl": "<string>",
      "iconUrlDark": [
        "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
        "/dark/{catalogTechnologyId}.png"
      ],
      "iconUrlLight": [
        "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
        "/light/{catalogTechnologyId}.png"
      ],
      "name": "<string>",
      "nameShort": "<string>",
      "provider": "aws",
      "rejectionMessage": "<string>",
      "rejectionReason": "duplicate",
      "restrictions": [
        "actor"
      ],
      "status": "approved",
      "type": "data-storage",
      "updatesUrl": "<string>",
      "websiteUrl": "<string>",
      "awsXmlSelector": "<string>",
      "azureUpdatesKeyword": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "defaultSlug": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "disabled": true,
      "iconUrl": "<string>",
      "id": "<string>",
      "organizationId": "<string>",
      "slugs": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "updatesXmlUrl": "<string>"
    }
  ],
  "publicTechnologies": [
    {
      "category": "<string>",
      "color": "blue",
      "deprecatedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "docsUrl": "<string>",
      "iconUrlDark": [
        "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
        "/dark/{catalogTechnologyId}.png"
      ],
      "iconUrlLight": [
        "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
        "/light/{catalogTechnologyId}.png"
      ],
      "name": "<string>",
      "nameShort": "<string>",
      "provider": "aws",
      "rejectionMessage": "<string>",
      "rejectionReason": "duplicate",
      "restrictions": [
        "actor"
      ],
      "status": "approved",
      "type": "data-storage",
      "updatesUrl": "<string>",
      "websiteUrl": "<string>",
      "awsXmlSelector": "<string>",
      "azureUpdatesKeyword": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "defaultSlug": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "disabled": true,
      "iconUrl": "<string>",
      "id": "<string>",
      "organizationId": "<string>",
      "slugs": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "updatesXmlUrl": "<string>"
    }
  ],
  "tagGroups": [
    {
      "commit": 123,
      "icon": "bug",
      "index": 123,
      "labels": {},
      "name": "<string>",
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "id": "<string>",
      "landscapeId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "tags": [
    {
      "color": "blue",
      "commit": 123,
      "groupId": "<string>",
      "index": 123,
      "labels": {},
      "name": "<string>",
      "handleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "user",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "user",
      "deletedById": "<string>",
      "id": "<string>",
      "landscapeId": "<string>",
      "modelConnectionIds": [
        "<string>"
      ],
      "modelObjectIds": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "user",
      "updatedById": "<string>",
      "version": 123,
      "versionId": "<string>"
    }
  ],
  "version": {
    "modelHandleId": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "completedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "diagramHandleIds": [
      "<string>"
    ],
    "id": "<string>",
    "landscapeId": "<string>",
    "tags": [
      "<string>"
    ],
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>"
  }
}

Headers

Authorization
string

Path Parameters

shortId
string
required

Query Parameters

inFrame
boolean
frameLocation
enum<string>
Available options:
notion,
miro,
confluence,
sharepoint,
powerpoint

Response

200
application/json
OK
comments
object[]
required
diagramContents
object[]
required
diagramGroups
object[]
required
diagramThumbnails
object
required
diagrams
object[]
required
domains
object[]
required
flowThumbnails
object
required
flows
object[]
required
landscape
object
required
landscapeThumbnailsSignedUrl
string
required
modelConnections
object[]
required
modelObjects
object[]
required
organizationIconsSignedUrl
string
required
organizationTechnologies
object[]
required
publicTechnologies
object[]
required
tagGroups
object[]
required
tags
object[]
required
version
object
required
organizationBrand
object