Model Objects
List
Action Logs
Bitbucket Server
Catalog News Articles
Catalog Technologies
Code Repos
Comment Replies
Diagram Contents
Diagrams
Flows
Health
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
Model Objects
List
GET
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
model
/
objects
curl --request GET \
--url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/model/objects \
--header 'Authorization: <authorization>'{
"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": "live",
"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>"
}
]
}Headers
Query Parameters
Available options:
live, future, deprecated, removed Available options:
actor, app, component, group, root, store, system Response
200
application/json
OK
IDs of the groups this model object belongs to
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"
]
Generic key value store used for creating custom integrations
Available options:
valid, invalid Available options:
programming, data, markup, prose Available options:
azure-devops-repo Parent model object ID, null for the root level model object
Available options:
live, future, deprecated, removed 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
Catalog 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 Available options:
blue, green, yellow, orange, red, beaver, dark-blue, purple, pink, white, grey, black Available options:
aws, azure, gcp, microsoft, salesforce, atlassian, apache, supabase Available options:
data-storage, deployment, framework-library, gateway, other, language, message-broker, network, protocol, runtime, service-tool Use either iconUrlDark or iconUrlLight
curl --request GET \
--url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/model/objects \
--header 'Authorization: <authorization>'{
"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": "live",
"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>"
}
]
}