Action Logs
Action Log Stats
Catalog News Articles
Catalog Technologies
Comment Replies
Diagram Contents
Diagrams
Draft Conflicts
Experiments
Flows
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
Share Link
Share Link Options
Support
User
User Notifications
User Goals
Version Reverts
Find Landscape
Copy
curl --request GET \
--url https://api.icepanel.io/v1/share-links/{shortId}/landscapeCopy
{
"comments": [
{
"body": {
"content": "<string>",
"status": "open",
"type": "question",
"showContentPreview": true
},
"commit": 123,
"mentionedUserIds": [
"<string>"
],
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"diagrams": {},
"id": "<string>",
"landscapeId": "<string>",
"replyCount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"diagramContents": [
{
"comments": {},
"commit": 123,
"connections": {},
"objects": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<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>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<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>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"diagramThumbnails": {},
"diagrams": [
{
"commit": 123,
"description": "<string>",
"groupId": "<string>",
"index": 123,
"labels": {},
"modelId": "<string>",
"name": "<string>",
"parentId": "<string>",
"pinned": true,
"status": "current",
"handleId": "<string>",
"type": "app-diagram",
"commentCount": 123,
"connectionCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"objectCount": {
"actor": 123,
"app": 123,
"group": 123,
"component": 123,
"store": 123,
"system": 123,
"area": 123,
"box": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"pinnedAt": "2023-11-07T05:31:56Z",
"pinnedIndex": 123,
"zoomOverrides": {},
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"domains": [
{
"commit": 123,
"index": 123,
"labels": {},
"name": "<string>",
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"flowThumbnails": {},
"flows": [
{
"commit": 123,
"index": 123,
"labels": {},
"name": "<string>",
"pinned": true,
"showAllSteps": true,
"showConnectionNames": true,
"steps": {},
"diagramId": "<string>",
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"pinnedAt": "2023-11-07T05:31:56Z",
"pinnedIndex": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<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>"
},
"landscapeAlgoliaKey": "<string>",
"landscapeThumbnailsSignedUrl": "<string>",
"modelConnections": [
{
"commit": 123,
"direction": null,
"labels": {},
"name": "<string>",
"originId": "<string>",
"status": "deprecated",
"tagIds": [
"<string>"
],
"targetId": "<string>",
"technologyIds": [
"<string>"
],
"viaId": "<string>",
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"diagrams": {},
"flows": {},
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"description": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"modelObjects": [
{
"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>"
}
],
"organizationIconsSignedUrl": "<string>",
"organizationTechnologies": [
{
"color": "blue",
"iconUrlDark": [
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
],
"iconUrlLight": [
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
],
"name": "<string>",
"provider": "aws",
"restrictions": [
"actor"
],
"type": "data-storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"disabled": false,
"iconUrl": "<string>",
"id": "<string>",
"organizationId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"category": "<string>",
"deprecatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"docsUrl": "<string>",
"nameShort": "<string>",
"rejectionMessage": "<string>",
"rejectionReason": "duplicate",
"status": "approved",
"updatesUrl": "<string>",
"websiteUrl": "<string>",
"awsXmlSelector": "<string>",
"azureUpdatesKeyword": "<string>",
"defaultSlug": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"slugs": [
"<string>"
],
"updatesXmlUrl": "<string>"
}
],
"publicTechnologies": [
{
"color": "blue",
"iconUrlDark": [
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
],
"iconUrlLight": [
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
],
"name": "<string>",
"provider": "aws",
"restrictions": [
"actor"
],
"type": "data-storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"disabled": false,
"iconUrl": "<string>",
"id": "<string>",
"organizationId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"category": "<string>",
"deprecatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"docsUrl": "<string>",
"nameShort": "<string>",
"rejectionMessage": "<string>",
"rejectionReason": "duplicate",
"status": "approved",
"updatesUrl": "<string>",
"websiteUrl": "<string>",
"awsXmlSelector": "<string>",
"azureUpdatesKeyword": "<string>",
"defaultSlug": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"slugs": [
"<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>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<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>",
"id": "<string>",
"landscapeId": "<string>",
"modelConnectionIds": [
"<string>"
],
"modelObjectIds": [
"<string>"
],
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"version": {
"modelHandleId": "<string>",
"name": "<string>",
"notes": "<string>",
"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>",
"completedAt": "2023-11-07T05:31:56Z"
},
"draft": {
"commit": 123,
"handleId": "<string>",
"labels": {},
"name": "<string>",
"status": "in-progress",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"originVersionId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"changeSummary": {
"createdAt": "2023-11-07T05:31:56Z",
"summary": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"summaryDirtiedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>",
"mergedAt": "2023-11-07T05:31:56Z",
"mergedBy": "user",
"mergedById": "<string>",
"viewedAt": "2023-11-07T05:31:56Z",
"viewedBy": "user",
"viewedById": "<string>"
},
"organizationBrand": {
"name": "<string>"
}
}Share Link Public
Find Landscape
GET
/
share-links
/
{shortId}
/
landscape
Find Landscape
Copy
curl --request GET \
--url https://api.icepanel.io/v1/share-links/{shortId}/landscapeCopy
{
"comments": [
{
"body": {
"content": "<string>",
"status": "open",
"type": "question",
"showContentPreview": true
},
"commit": 123,
"mentionedUserIds": [
"<string>"
],
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"diagrams": {},
"id": "<string>",
"landscapeId": "<string>",
"replyCount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"diagramContents": [
{
"comments": {},
"commit": 123,
"connections": {},
"objects": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<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>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<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>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"diagramThumbnails": {},
"diagrams": [
{
"commit": 123,
"description": "<string>",
"groupId": "<string>",
"index": 123,
"labels": {},
"modelId": "<string>",
"name": "<string>",
"parentId": "<string>",
"pinned": true,
"status": "current",
"handleId": "<string>",
"type": "app-diagram",
"commentCount": 123,
"connectionCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"objectCount": {
"actor": 123,
"app": 123,
"group": 123,
"component": 123,
"store": 123,
"system": 123,
"area": 123,
"box": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"pinnedAt": "2023-11-07T05:31:56Z",
"pinnedIndex": 123,
"zoomOverrides": {},
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"domains": [
{
"commit": 123,
"index": 123,
"labels": {},
"name": "<string>",
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"flowThumbnails": {},
"flows": [
{
"commit": 123,
"index": 123,
"labels": {},
"name": "<string>",
"pinned": true,
"showAllSteps": true,
"showConnectionNames": true,
"steps": {},
"diagramId": "<string>",
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"pinnedAt": "2023-11-07T05:31:56Z",
"pinnedIndex": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<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>"
},
"landscapeAlgoliaKey": "<string>",
"landscapeThumbnailsSignedUrl": "<string>",
"modelConnections": [
{
"commit": 123,
"direction": null,
"labels": {},
"name": "<string>",
"originId": "<string>",
"status": "deprecated",
"tagIds": [
"<string>"
],
"targetId": "<string>",
"technologyIds": [
"<string>"
],
"viaId": "<string>",
"handleId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"diagrams": {},
"flows": {},
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"description": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"modelObjects": [
{
"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>"
}
],
"organizationIconsSignedUrl": "<string>",
"organizationTechnologies": [
{
"color": "blue",
"iconUrlDark": [
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
],
"iconUrlLight": [
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
],
"name": "<string>",
"provider": "aws",
"restrictions": [
"actor"
],
"type": "data-storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"disabled": false,
"iconUrl": "<string>",
"id": "<string>",
"organizationId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"category": "<string>",
"deprecatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"docsUrl": "<string>",
"nameShort": "<string>",
"rejectionMessage": "<string>",
"rejectionReason": "duplicate",
"status": "approved",
"updatesUrl": "<string>",
"websiteUrl": "<string>",
"awsXmlSelector": "<string>",
"azureUpdatesKeyword": "<string>",
"defaultSlug": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"slugs": [
"<string>"
],
"updatesXmlUrl": "<string>"
}
],
"publicTechnologies": [
{
"color": "blue",
"iconUrlDark": [
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
],
"iconUrlLight": [
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
],
"name": "<string>",
"provider": "aws",
"restrictions": [
"actor"
],
"type": "data-storage",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"disabled": false,
"iconUrl": "<string>",
"id": "<string>",
"organizationId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"category": "<string>",
"deprecatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"docsUrl": "<string>",
"nameShort": "<string>",
"rejectionMessage": "<string>",
"rejectionReason": "duplicate",
"status": "approved",
"updatesUrl": "<string>",
"websiteUrl": "<string>",
"awsXmlSelector": "<string>",
"azureUpdatesKeyword": "<string>",
"defaultSlug": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"slugs": [
"<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>",
"id": "<string>",
"landscapeId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<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>",
"id": "<string>",
"landscapeId": "<string>",
"modelConnectionIds": [
"<string>"
],
"modelObjectIds": [
"<string>"
],
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>"
}
],
"version": {
"modelHandleId": "<string>",
"name": "<string>",
"notes": "<string>",
"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>",
"completedAt": "2023-11-07T05:31:56Z"
},
"draft": {
"commit": 123,
"handleId": "<string>",
"labels": {},
"name": "<string>",
"status": "in-progress",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"landscapeId": "<string>",
"originVersionId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123,
"versionId": "<string>",
"changeSummary": {
"createdAt": "2023-11-07T05:31:56Z",
"summary": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"summaryDirtiedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": "user",
"deletedById": "<string>",
"latestEntityId": "<string>",
"mergedAt": "2023-11-07T05:31:56Z",
"mergedBy": "user",
"mergedById": "<string>",
"viewedAt": "2023-11-07T05:31:56Z",
"viewedBy": "user",
"viewedById": "<string>"
},
"organizationBrand": {
"name": "<string>"
}
}Headers
Path Parameters
Query Parameters
Available options:
notion, miro, confluence, sharepoint, powerpoint Response
OK
Show child attributes
Show child attributes
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The percentage along the line where the label should be placed
Available options:
curved, straight, square Available options:
top-left, top-center, top-right, right-top, right-middle, right-bottom, bottom-right, bottom-center, bottom-left, left-bottom, left-middle, left-top Available options:
top-left, top-center, top-right, right-top, right-middle, right-bottom, bottom-right, bottom-center, bottom-left, left-bottom, left-middle, left-top Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
area, box Available options:
actor, app, group, component, store, system Available options:
user, api-key, notification-key, service Available options:
current Available options:
app-diagram, component-diagram, context-diagram Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
app-diagram, component-diagram, context-diagram Show child attributes
Show child attributes
model object id this object belongs to
Available options:
current Available options:
app-diagram, component-diagram, context-diagram Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Show child attributes
Show child attributes
diagram id this flow belongs to
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Descriptive name for the flow step
Type of flow step - deprecated values: reply
Available options:
alternate-path, subflow, outgoing, parallel-path, reply, self-action, introduction, information, conclusion, Long description for the flow step
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
outgoing, bidirectional Model object that initiates the connection
Available options:
deprecated, future, live, removed Tag IDs assigned to this model
Model object that receives the message
Technology IDs assigned to this model
Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue
Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
IDs of the groups this model object belongs to
Show child attributes
Show child attributes
Use either urlDark or urlLight
Icon that only works on dark backgrounds
Example:
[
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
]Icon that only works on light backgrounds
Example:
[
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
]Show child attributes
Show child attributes
Show child attributes
Show child attributes
Random 20 character identifier
Resolve the connector from a publicly accessible URL
Links this to a resource in reality, if set periodic checks are performed and the status is updated
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
Friendly name for the link set by the user
URL pointing to the resource in reality, resolved from the last sync
Error message that was received during the last sync
Friendly name describing the resource in reality, resolved from the last sync
Response that was received from the last sync with reality
Available options:
valid, invalid Parent model object ID, null for the root level model object
Available options:
deprecated, future, live, removed Tag IDs assigned to this model
Team IDs that own this model object, does not propergate up or down
Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins
Technology IDs assigned to this model
Available options:
actor, app, component, group, root, store, system Child diagram IDs
Child model object IDs, only one level down
Available options:
user, api-key, notification-key, service Parent model object IDs for the whole hierarchy, ending with the root model object
Available options:
user, api-key, notification-key, service Short summary of the object shown as the display description
Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Technology color used in diagrams
Available options:
blue, green, yellow, orange, red, beaver, dark-blue, purple, pink, white, grey, black Icon that only works on dark backgrounds
Example:
[
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
]Icon that only works on light backgrounds
Example:
[
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
]Long verbose name
Service provider that provides this technology
Available options:
aws, azure, gcp, microsoft, salesforce, atlassian, apache, supabase, Restriction on which model object or connections this technology can be added to
Available options:
actor, app, component, connection, group, store, system, Type or category of technology
Available options:
data-storage, deployment, framework-library, gateway, other, language, message-broker, network, protocol, runtime, service-tool, Available options:
user, api-key, notification-key, service Whether the technology is disabled and not visible to users
Use either iconUrlDark or iconUrlLight
Organization that owns this technology, or null if its publicly accessible
Available options:
user, api-key, notification-key, service Technical description for the technology, avoid marketing language
Documentation or readme url
Short one or two word name to show in places with limited space
If rejected, detail description of why
If rejected, the reason why
Available options:
duplicate, incomplete, invalid, other Current status of the technology, including pending review, approved, and rejected. Approved technologies are visible to all users.
Available options:
approved, pending-review, rejected Release notes or changelog url
Landing page website url
URL path name for the technology, used by stackfeed
Available options:
user, api-key, notification-key, service Current and historical url path names used for the technology, used by stackfeed
Show child attributes
Show child attributes
Technology color used in diagrams
Available options:
blue, green, yellow, orange, red, beaver, dark-blue, purple, pink, white, grey, black Icon that only works on dark backgrounds
Example:
[
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
]Icon that only works on light backgrounds
Example:
[
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
]Long verbose name
Service provider that provides this technology
Available options:
aws, azure, gcp, microsoft, salesforce, atlassian, apache, supabase, Restriction on which model object or connections this technology can be added to
Available options:
actor, app, component, connection, group, store, system, Type or category of technology
Available options:
data-storage, deployment, framework-library, gateway, other, language, message-broker, network, protocol, runtime, service-tool, Available options:
user, api-key, notification-key, service Whether the technology is disabled and not visible to users
Use either iconUrlDark or iconUrlLight
Organization that owns this technology, or null if its publicly accessible
Available options:
user, api-key, notification-key, service Technical description for the technology, avoid marketing language
Documentation or readme url
Short one or two word name to show in places with limited space
If rejected, detail description of why
If rejected, the reason why
Available options:
duplicate, incomplete, invalid, other Current status of the technology, including pending review, approved, and rejected. Approved technologies are visible to all users.
Available options:
approved, pending-review, rejected Release notes or changelog url
Landing page website url
URL path name for the technology, used by stackfeed
Available options:
user, api-key, notification-key, service Current and historical url path names used for the technology, used by stackfeed
Show child attributes
Show child attributes
Available options:
bug, calendar-check, calendar-times, cloud, cog, database, exclamation-triangle, file, globe, laptop-code, lightbulb, lock, microchip, minus, mobile, network-wired, plus, poo, robot, rocket, sack-dollar, server, sledding, snowman, star, times, toolbox, trash, users, wifi Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
blue, green, yellow, orange, red, beaver, dark-blue, purple, pink, white, grey, black Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
10Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Show child attributes
Show child attributes
Available options:
in-progress, merged, archived Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service Available options:
user, api-key, notification-key, service ⌘I