Skip to main content
POST
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
share-link
/
options
Upsert
curl --request POST \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/share-link/options \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectionIds": [
    "<string>"
  ],
  "diagramId": "<string>",
  "domainId": "<string>",
  "drawer": "expanded",
  "expandedIds": [
    "<string>"
  ],
  "filterIds": [
    "<string>"
  ],
  "filterIdsExcluded": [
    "<string>"
  ],
  "filterIdsIncluded": [
    "<string>"
  ],
  "flowId": "<string>",
  "flowParentIds": [
    "<string>"
  ],
  "flowPathIds": [
    "<string>"
  ],
  "flowStepId": "<string>",
  "mode": "overview",
  "modelId": "<string>",
  "objectIds": [
    "<string>"
  ],
  "objectIdsFocused": [
    "<string>"
  ],
  "objectTab": "details",
  "overlayGroupId": "<string>",
  "overlayIdsFocused": [
    "<string>"
  ],
  "overlayIdsHidden": [
    "<string>"
  ],
  "overlayIdsPinned": [
    "<string>"
  ],
  "overlayTab": "tags",
  "preventNavigation": true,
  "search": "<string>",
  "viaId": "<string>",
  "x1": 123,
  "x2": 123,
  "y": 123,
  "y1": 123,
  "y2": 123
}
'
{
  "shareLinkOptions": {
    "connectionIds": [
      "<string>"
    ],
    "diagramId": "<string>",
    "domainId": "<string>",
    "drawer": "expanded",
    "expandedIds": [
      "<string>"
    ],
    "filterIds": [
      "<string>"
    ],
    "filterIdsExcluded": [
      "<string>"
    ],
    "filterIdsIncluded": [
      "<string>"
    ],
    "flowId": "<string>",
    "flowParentIds": [
      "<string>"
    ],
    "flowPathIds": [
      "<string>"
    ],
    "flowStepId": "<string>",
    "mode": "overview",
    "modelId": "<string>",
    "objectIds": [
      "<string>"
    ],
    "objectIdsFocused": [
      "<string>"
    ],
    "objectTab": "details",
    "overlayGroupId": "<string>",
    "overlayIdsFocused": [
      "<string>"
    ],
    "overlayIdsHidden": [
      "<string>"
    ],
    "overlayIdsPinned": [
      "<string>"
    ],
    "overlayTab": "tags",
    "preventNavigation": true,
    "search": "<string>",
    "viaId": "<string>",
    "x1": 123,
    "x2": 123,
    "y": 123,
    "y1": 123,
    "y2": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "hash": "<string>",
    "id": "<string>",
    "shareLinkId": "<string>",
    "shortId": "<string>"
  }
}

Headers

​
Authorization
string
required

Path Parameters

​
landscapeId
string
required
​
versionId
string
required

Body

application/json
​
connectionIds
string[] | null
required
​
diagramId
string | null
required
​
domainId
string | null
required
​
drawer
enum<string> | null
required
Available options:
expanded,
collapsed,
​
expandedIds
string[] | null
required
​
filterIds
string[] | null
required
​
filterIdsExcluded
string[] | null
required
​
filterIdsIncluded
string[] | null
required
​
flowId
string | null
required
​
flowParentIds
string[] | null
required
​
flowPathIds
string[] | null
required
​
flowStepId
string | null
required
​
mode
enum<string>
required
Available options:
overview,
diagrams,
flows,
model-objects,
model-connections,
dependencies,
technologies,
diagram,
flow
​
modelId
string | null
required
​
objectIds
string[] | null
required
​
objectIdsFocused
string[] | null
required
​
objectTab
enum<string> | null
required
Available options:
details,
connections,
history,
​
overlayGroupId
string | null
required
​
overlayIdsFocused
string[] | null
required
​
overlayIdsHidden
string[] | null
required
​
overlayIdsPinned
string[] | null
required
​
overlayTab
enum<string> | null
required
Available options:
tags,
technology,
status,
​
preventNavigation
boolean
required
​
search
string | null
required
​
viaId
string | null
required
​
x1
number | null
required
​
x2
number | null
required
​
y
number | null
required
​
y1
number | null
required
​
y2
number | null
required

Response

OK

​
shareLinkOptions
object
required