### List Organization Users with Go HTTP Client Source: https://developer.icepanel.io/api-reference/organizations/users/list This Go example shows how to fetch organization users by making an HTTP GET request. Remember to set the 'X-API-Key' header. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/organizations/organizationId/users" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### List Tags via HTTP GET Request (Go) Source: https://developer.icepanel.io/api-reference/tags/list A Go example for listing tags by performing an HTTP GET request to the IcePanel API. It demonstrates setting the API key and reading the response body. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/tags" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Version using IcePanel SDK (Java) Source: https://developer.icepanel.io/api-reference/versions/get Retrieve a version using the Java SDK. This example shows how to build the request with landscape and version IDs and execute the get operation. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.types.VersionFindRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.versions().get( VersionFindRequest .builder() .landscapeId("landscapeId") .versionId("versionId") .build() ); } } ``` -------------------------------- ### Get Landscape Action Log with Go HTTP Client Source: https://developer.icepanel.io/api-reference/landscapes/logs/get Retrieve a landscape action log using Go's standard net/http package. This example shows how to make a GET request to the IcePanel API. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/action-logs/actionLogId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Draft using Go HTTP Client Source: https://developer.icepanel.io/api-reference/drafts/get Provides an example of retrieving a draft using Go's standard `net/http` package. The API key is set in the request headers. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/drafts/draftId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Organization Logs Stats by Entity (Go) Source: https://developer.icepanel.io/api-reference/organizations/logs/stats/by-entity This Go example shows how to make an HTTP GET request to retrieve organization log statistics by entity. Ensure the 'X-API-Key' header is set correctly. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/organizations/organizationId/logs/stats/by-entity" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Successful Response Example Source: https://developer.icepanel.io/api-reference/versions/create This is an example of a successful response when creating a new landscape version. It outlines the structure of the returned version object. ```json { "version": { "modelHandleId": "string", "name": "string", "notes": "string", "createdAt": "2024-01-15T09:30:00Z", "createdBy": "user", "createdById": "string", "diagramHandleIds": [ "string" ], "id": "string", "landscapeId": "string", "tags": [ "string" ], "updatedAt": "2024-01-15T09:30:00Z", "updatedBy": "user", "updatedById": "string", "completedAt": "2024-01-15T09:30:00Z" } } ``` -------------------------------- ### List Children using Python Requests Source: https://developer.icepanel.io/api-reference/landscapes/logs/list-children This example shows how to list children of an action log by making a direct HTTP GET request using the Python `requests` library. Include your API key in the `X-API-Key` header. ```python import requests url = "https://api.icepanel.io/v1/landscapes/landscapeId/action-logs/actionLogId/children" headers = {"X-API-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` -------------------------------- ### Get Landscape Action Log with Python Requests Source: https://developer.icepanel.io/api-reference/landscapes/logs/get Fetch a landscape action log using the Python requests library. This example demonstrates a direct REST API call. ```python import requests url = "https://api.icepanel.io/v1/landscapes/landscapeId/action-logs/actionLogId" headers = {"X-API-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` -------------------------------- ### Get Landscape with IcePanel SDK (Java) Source: https://developer.icepanel.io/api-reference/landscapes/get Retrieve a landscape using the IcePanel Java SDK. This example shows how to build the client with an API key and specify the landscape ID for the request. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.types.LandscapeFindRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.landscapes().get( LandscapeFindRequest .builder() .landscapeId("landscapeId") .build() ); } } ``` -------------------------------- ### Get Organization Technology with Go HTTP Client Source: https://developer.icepanel.io/api-reference/organizations/technologies/get Use Go's standard HTTP client to make a GET request for organization technology. Include your API key in the 'X-API-Key' header. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/organizations/organizationId/technologies/catalogTechnologyId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Model Connection (Java SDK) Source: https://developer.icepanel.io/api-reference/model/connections/get Utilize the IcePanel Java SDK to fetch a model connection. This example demonstrates building the client with an API key and constructing the request using ModelConnectionFindRequest. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.model.types.ModelConnectionFindRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.model().connections().get( ModelConnectionFindRequest .builder() .landscapeId("landscapeId") .versionId("versionId") .modelConnectionId("modelConnectionId") .build() ); } } ``` -------------------------------- ### Example Response for Action Log Statistics Source: https://developer.icepanel.io/api-reference/landscapes/logs/stats/by-type This is an example of a successful response when retrieving action log statistics by type. It includes counts per date and total counts. ```json { "contributors": {}, "dates": [ { "actions": {}, "date": "2024-01-15T09:30:00Z" } ], "totalCount": 1.1 } ``` -------------------------------- ### Create Organization Technology with HTTP POST (Go) Source: https://developer.icepanel.io/api-reference/organizations/technologies/create Send an HTTP POST request using Go to create an organization technology. This example demonstrates setting up the request body, headers, and executing the request. ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/organizations/organizationId/technologies" payload := strings.NewReader("{\"color\": \"blue\",\n \"name\": \"string\",\n \"provider\": \"aws\",\n \"restrictions\": [\n \"actor\"\n ],\n \"type\": \"data-storage\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### List Organization User Invites with Go HTTP Client Source: https://developer.icepanel.io/api-reference/organizations/users/invites/list This Go example shows how to fetch organization user invites using the standard net/http package. It includes setting the API key in the request header and printing the response. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/organizations/organizationId/users/invites" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Comment Reply with C# RestSharp Source: https://developer.icepanel.io/api-reference/comments/replies/get Use the RestSharp library in C# to make a GET request for a comment reply. This example shows how to set up the client, request, and add the API key header. ```csharp using RestSharp; var client = new RestClient("https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/comments/commentId/replies/commentReplyId"); var request = new RestRequest(Method.GET); request.AddHeader("X-API-Key", ""); IRestResponse response = client.Execute(request); ``` -------------------------------- ### Create Diagram with Go HTTP Client Source: https://developer.icepanel.io/api-reference/diagrams/create This Go example demonstrates creating a diagram by sending a POST request to the IcePanel API. It includes setting the necessary headers and request body. ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/diagrams" payload := strings.NewReader("{\n \"index\": 1.1,\n \"modelId\": \"string\",\n \"name\": \"string\",\n \"type\": \"app-diagram\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Create Tag with Go HTTP Client Source: https://developer.icepanel.io/api-reference/tags/create This Go example demonstrates creating a tag by making an HTTP POST request to the IcePanel API. The API key and content type headers are essential. ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/tags" payload := strings.NewReader("{\n \"color\": \"blue\",\n \"groupId\": \"string\",\n \"index\": 1.1,\n \"name\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Model Connection (Python HTTP Request) Source: https://developer.icepanel.io/api-reference/model/connections/get Make a direct HTTP GET request to the IcePanel API to retrieve a model connection. This example uses the `requests` library and requires your API key in the headers. ```python import requests url = "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/model/connections/modelConnectionId" headers = {"X-API-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` -------------------------------- ### List Organization Users with Java SDK Source: https://developer.icepanel.io/api-reference/organizations/users/list This Java example demonstrates how to list users for an organization using the IcePanel Java SDK. The client must be built with an API key. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.organizations.types.OrganizationUsersListRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.organizations().users().list( OrganizationUsersListRequest .builder() .organizationId("organizationId") .build() ); } } ``` -------------------------------- ### List Landscapes using IcePanel SDK Source: https://developer.icepanel.io/api-reference/teams/list-landscapes Demonstrates how to use the IcePanel SDK to fetch a list of landscapes for a given organization and team. Ensure you have the SDK installed and replace placeholder API keys and IDs. ```typescript import { IcePanelClient } from "@icepanel/sdk"; async function main() { const client = new IcePanelClient({ apiKey: "YOUR_API_KEY_HERE", }); await client.teams.listLandscapes("organizationId", "teamId"); } main(); ``` -------------------------------- ### Copy Landscape using HTTP Request (Go) Source: https://developer.icepanel.io/api-reference/landscapes/copy This Go example demonstrates copying a landscape via an HTTP POST request. It constructs the URL with query parameters and sets the necessary API key header. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/copy?targetLandscapeId=targetLandscapeId" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Create Diagram with Java SDK Source: https://developer.icepanel.io/api-reference/diagrams/create This Java example shows how to create a diagram using the IcePanel Java SDK. It requires setting up the IcePanelClient with an API key. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.types.DiagramCreate; import com.icepanel.types.DiagramCreateRequest; import com.icepanel.types.DiagramType; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.diagrams().create( DiagramCreateRequest .builder() .landscapeId("landscapeId") .versionId("versionId") .body( DiagramCreate .builder() .index(1.1) .modelId("string") .name("string") .type(DiagramType.APP_DIAGRAM) .build() ) .build() ); } } ``` -------------------------------- ### Copy Landscape using IcePanel SDK (Java) Source: https://developer.icepanel.io/api-reference/landscapes/copy This Java example demonstrates copying a landscape using the IcePanel SDK. It requires setting up the client with your API key and providing the necessary landscape IDs. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.types.LandscapeCopyRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.landscapes().copy( LandscapeCopyRequest .builder() .landscapeId("landscapeId") .targetLandscapeId("targetLandscapeId") .build() ); } } ``` -------------------------------- ### Get Comment Reply with Java SDK Source: https://developer.icepanel.io/api-reference/comments/replies/get Retrieve a comment reply using the Java SDK. This example shows how to build the request object with all necessary IDs and authenticate with your API key. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.comments.types.CommentReplyFindRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.comments().replies().get( CommentReplyFindRequest .builder() .landscapeId("landscapeId") .versionId("versionId") .commentId("commentId") .commentReplyId("commentReplyId") .build() ); } } ``` -------------------------------- ### Create Draft via HTTP POST (Go) Source: https://developer.icepanel.io/api-reference/drafts/create This Go snippet demonstrates making an HTTP POST request to create a draft. It includes setting the necessary headers and reading the response body. ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/drafts" payload := strings.NewReader("{\n \"name\": \"string\",\n \"status\": \"in-progress\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Create Tag Group with Go HTTP Client Source: https://developer.icepanel.io/api-reference/tags/groups/create This Go example demonstrates creating a tag group using the standard net/http package. It constructs the request with the necessary headers and payload. ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/tag-groups" payload := strings.NewReader("{\n \"icon\": \"bug\",\n \"index\": 1.1,\n \"name\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Create Tag with Java SDK Source: https://developer.icepanel.io/api-reference/tags/create This Java example shows how to create a tag using the IcePanel Java SDK. The client must be built with an API key. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.types.TagColor; import com.icepanel.types.TagCreateRequest; import com.icepanel.types.TagRequired; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.tags().create( TagCreateRequest .builder() .landscapeId("landscapeId") .versionId("versionId") .body( TagRequired .builder() .color(TagColor.BLUE) .groupId("string") .index(1.1) .name("string") .build() ) .build() ); } } ``` -------------------------------- ### Export CSV using HTTP Request (Go) Source: https://developer.icepanel.io/api-reference/model/connections/export/csv This Go example illustrates making an HTTP GET request to the CSV export endpoint. Ensure your API key and IDs are correctly substituted. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/model/connections/export/csv" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Organization Log by ID Source: https://developer.icepanel.io/api-reference/organizations/logs/get Use this TypeScript snippet to retrieve a specific organization log entry. Ensure you have the IcePanel SDK installed and replace placeholder values with your actual API key and IDs. ```typescript import { IcePanelClient } from "@icepanel/sdk"; async function main() { const client = new IcePanelClient({ apiKey: "YOUR_API_KEY_HERE", }); await client.organizations.logs.get("organizationId", "organizationLogId"); } main(); ``` -------------------------------- ### List Organization User Invites with Java SDK Source: https://developer.icepanel.io/api-reference/organizations/users/invites/list This Java example demonstrates how to list user invites using the IcePanel Java SDK. Initialize the client with your API key and specify the organization ID. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.organizations.users.types.OrganizationUserInvitesListRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.organizations().users().invites().list( OrganizationUserInvitesListRequest .builder() .organizationId("organizationId") .build() ); } } ``` -------------------------------- ### Get Flow Thumbnail using SDK Source: https://developer.icepanel.io/api-reference/flows/get-thumbnail Demonstrates how to use the IcePanel SDK in TypeScript to retrieve a flow's thumbnail. Ensure you have the SDK installed and replace placeholder values with your actual API key and IDs. ```typescript import { IcePanelClient } from "@icepanel/sdk"; async function main() { const client = new IcePanelClient({ apiKey: "YOUR_API_KEY_HERE", }); await client.flows.getThumbnail("landscapeId", "versionId", "flowId"); } main(); ``` -------------------------------- ### List Landscape Logs with Go HTTP Client Source: https://developer.icepanel.io/api-reference/landscapes/logs/list Use Go's standard net/http package to perform a GET request to the action logs endpoint. Pass your API key via the 'X-API-Key' header. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/action-logs" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### Get Comment Reply with REST API Source: https://developer.icepanel.io/api-reference/comments/replies/get Fetch a comment reply directly via the REST API using Python's requests library. This example includes setting the correct URL and API key header. ```python import requests url = "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/comments/commentId/replies/commentReplyId" headers = {"X-API-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` -------------------------------- ### List Diagrams using SDK Source: https://developer.icepanel.io/api-reference/diagrams/list Demonstrates how to use the IcePanel SDK to fetch a list of diagrams. Ensure you have your API key and the correct landscape and version IDs. ```typescript import { IcePanelClient } from "@icepanel/sdk"; async function main() { const client = new IcePanelClient({ apiKey: "YOUR_API_KEY_HERE", }); await client.diagrams.list("landscapeId", "versionId", {}); } main(); ``` -------------------------------- ### Get Organization Logs Stats by Entity (Java SDK) Source: https://developer.icepanel.io/api-reference/organizations/logs/stats/by-entity This Java example demonstrates using the IcePanel SDK to fetch organization log statistics by entity. The client must be built with an API key, and the request object should specify the organization ID. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.organizations.logs.types.OrganizationLogStatsByEntityRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.organizations().logs().stats().byEntity( OrganizationLogStatsByEntityRequest .builder() .organizationId("organizationId") .build() ); } } ``` -------------------------------- ### Create Organization Technology with Java SDK Source: https://developer.icepanel.io/api-reference/organizations/technologies/create Utilize the IcePanel Java SDK to programmatically create an organization technology. This example shows how to build the request object with all necessary parameters. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.organizations.types.OrganizationTechnologyCreateRequest; import com.icepanel.types.CatalogProviderNullable; import com.icepanel.types.CatalogRestriction; import com.icepanel.types.CatalogTechnologyRequired; import com.icepanel.types.CatalogTechnologyTypeNullable; import com.icepanel.types.TagColor; import java.util.Arrays; import java.util.Optional; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.organizations().technologies().create( OrganizationTechnologyCreateRequest .builder() .organizationId("organizationId") .body( CatalogTechnologyRequired .builder() .color(TagColor.BLUE) .name("string") .provider(CatalogProviderNullable.AWS) .restrictions( Optional.of( Arrays.asList(CatalogRestriction.ACTOR) ) ) .type(CatalogTechnologyTypeNullable.DATA_STORAGE) .build() ) .build() ); } } ``` -------------------------------- ### Get Landscape Export Status Source: https://developer.icepanel.io/api-reference/landscapes/export/get Get the status of a landscape export job. ```APIDOC ## GET /landscapes/{landscapeId}/versions/{versionId}/export/{landscapeExportId} ### Description Get the status of a landscape export job. ### Method GET ### Endpoint /landscapes/{landscapeId}/versions/{versionId}/export/{landscapeExportId} ### Parameters #### Path Parameters - **landscapeId** (string) - Required - The ID of the landscape. - **versionId** (string) - Required - The ID of the landscape version. - **landscapeExportId** (string) - Required - The ID of the landscape export job. #### Header Parameters - **X-API-Key** (string) - Required - API key authentication ### Responses #### Success Response (200) - **landscapeExport** (object) - Details of the landscape export job. - **id** (string) - **landscapeId** (string) - **versionId** (string) - **type** (string) - The type of export (e.g., pdf, markdown, html, llms, json). - **createdAt** (string) - The timestamp when the export job was created. - **completedAt** (string) - The timestamp when the export job was completed. - **deleteAt** (string) - The timestamp when the export job will be deleted. - **error** (string | null) - Any error message if the export failed. - **fileUrl** (string | null) - The URL to the exported file if the export was successful. - **filter** (object) - Filter criteria used for the export. - **diagramId** (string) - **flowId** (string) - **includeDiagrams** (boolean) - Whether or not to include diagrams in PDF exports, defaults to true. - **includeFlows** (boolean) - Whether or not to include flows in PDF exports, defaults to true. - **modelObjectId** (string) - **options** (object) - Options used for the export. - **draftId** (string) - Fetch and apply draft tasks before producing the export. - **orientation** (string) - Orientation to use when exporting to PDF (portrait or landscape). #### Error Responses - **401** - Unauthorized - **404** - Not Found - **422** - Unprocessable Entity - **500** - Internal Server Error ### Response Example (200) ```json { "landscapeExport": { "id": "export-123", "landscapeId": "landscape-abc", "versionId": "version-xyz", "type": "pdf", "createdAt": "2023-10-27T10:00:00Z", "completedAt": "2023-10-27T10:05:00Z", "deleteAt": "2023-11-27T10:00:00Z", "error": null, "fileUrl": "https://api.icepanel.io/exports/landscape-abc/export-123.pdf", "filter": { "includeDiagrams": true, "includeFlows": true }, "options": { "orientation": "portrait" } } } ``` ``` -------------------------------- ### ActionVersionCreate Source: https://developer.icepanel.io/api-reference/landscapes/logs/list-children Creates a new version. Requires context with domain information, ID, and version properties. ```APIDOC ## ActionVersionCreate ### Description Creates a new version. Requires context with domain information, ID, and version properties. ### Properties - **context** (ActionVersionCreateContext) - Required - The context for the version creation, including domain details. - **id** (string) - Required - The unique identifier for this action. - **props** (VersionRequired) - Required - The properties of the version to be created. - **type** (ActionVersionCreateType) - Required - The type of action, must be 'version-create'. ``` -------------------------------- ### Get Organization Technology Source: https://developer.icepanel.io/api-reference/organizations/technologies/get Fetches a specific technology associated with an organization. This can be done using the IcePanel SDK or a direct HTTP GET request. ```APIDOC ## GET /organizations/{organizationId}/technologies/{catalogTechnologyId} ### Description Retrieves details for a specific technology within an organization's catalog. ### Method GET ### Endpoint /organizations/{organizationId}/technologies/{catalogTechnologyId} ### Parameters #### Path Parameters - **organizationId** (string) - Required - The unique identifier for the organization. - **catalogTechnologyId** (string) - Required - The unique identifier for the technology within the organization's catalog. ### Request Example ```http GET /v1/organizations/organizationId/technologies/catalogTechnologyId HTTP/1.1 Host: api.icepanel.io X-API-Key: ``` ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Draft OpenAPI Specification Source: https://developer.icepanel.io/api-reference/drafts/get This OpenAPI specification defines the GET endpoint for retrieving a draft, including parameters, authentication, and response structures. ```yaml openapi: 3.1.0 info: title: IcePanel API version: 1.0.0 paths: /landscapes/{landscapeId}/versions/{versionId}/drafts/{draftId}: get: operationId: get summary: Get tags: - subpackage_drafts parameters: - name: landscapeId in: path required: true schema: type: string - name: versionId in: path required: true schema: type: string - name: draftId in: path required: true schema: type: string - name: X-API-Key in: header description: API key authentication required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/drafts_get_Response_200' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal Server content: application/json: schema: $ref: '#/components/schemas/Error' servers: - url: https://api.icepanel.io/v1 components: schemas: DraftChangeSummary: type: object properties: createdAt: type: string format: date-time summary: type: string updatedAt: type: string format: date-time required: - createdAt - summary - updatedAt title: DraftChangeSummary DraftStatus: type: string enum: - in-progress - merged - archived title: DraftStatus AuthType: type: string enum: - user - api-key - notification-key - service title: AuthType Draft: type: object properties: changeSummary: $ref: '#/components/schemas/DraftChangeSummary' commit: type: number format: double handleId: type: string labels: type: object additionalProperties: type: string name: type: string status: $ref: '#/components/schemas/DraftStatus' summaryDirtiedAt: type: string format: date-time createdAt: type: string format: date-time createdBy: $ref: '#/components/schemas/AuthType' createdById: type: string deletedAt: type: string format: date-time deletedBy: $ref: '#/components/schemas/AuthType' deletedById: type: string id: type: string landscapeId: type: string latestEntityId: type: string mergedAt: type: string format: date-time mergedBy: $ref: '#/components/schemas/AuthType' mergedById: type: string originVersionId: type: string updatedAt: type: string format: date-time updatedBy: $ref: '#/components/schemas/AuthType' updatedById: type: string version: type: number format: double versionId: type: string viewedAt: type: string format: date-time viewedBy: $ref: '#/components/schemas/AuthType' viewedById: type: string required: - commit - handleId - labels - name - status - createdAt - createdBy - createdById - id - landscapeId - originVersionId - updatedAt - updatedBy - updatedById - version - versionId title: Draft drafts_get_Response_200: type: object properties: draft: $ref: '#/components/schemas/Draft' required: - draft title: drafts_get_Response_200 Error: type: object properties: code: type: string errors: type: array items: type: string message: type: string required: - message title: Error securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: API key authentication BearerAuth: ``` -------------------------------- ### Get Domain using HTTP Request (Go) Source: https://developer.icepanel.io/api-reference/domains/get Fetch domain information via an HTTP GET request in Go. The API key is included in the request headers. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/domains/domainId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### List Tags with Java SDK Source: https://developer.icepanel.io/api-reference/tags/list Demonstrates listing tags using the Java SDK. The IcePanelClient needs to be built with your API key, and a TagsListRequest object should be constructed. ```java package com.example.usage; import com.icepanel.IcePanelClient; import com.icepanel.types.TagsListRequest; public class Example { public static void main(String[] args) { IcePanelClient client = IcePanelClient .builder() .apiKey("YOUR_API_KEY_HERE") .build(); client.tags().list( TagsListRequest .builder() .landscapeId("landscapeId") .versionId("versionId") .build() ); } } ``` -------------------------------- ### List Organization Technologies with HTTP Request (Go) Source: https://developer.icepanel.io/api-reference/organizations/technologies/list Perform an HTTP GET request using Go's standard library to retrieve organization technologies. The API key must be included in the request headers. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.icepanel.io/v1/organizations/organizationId/technologies" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` -------------------------------- ### OpenAPI Specification for Get Version Source: https://developer.icepanel.io/api-reference/versions/get This OpenAPI 3.1.0 specification defines the GET endpoint for retrieving a specific version of a landscape. It includes parameters, request/response schemas, and security schemes. ```yaml openapi: 3.1.0 info: title: IcePanel API version: 1.0.0 paths: /landscapes/{landscapeId}/versions/{versionId}: get: operationId: get summary: Get tags: - subpackage_versions parameters: - name: landscapeId in: path required: true schema: type: string - name: versionId in: path required: true schema: type: string - name: X-API-Key in: header description: API key authentication required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/versions_get_Response_200' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal Server content: application/json: schema: $ref: '#/components/schemas/Error' servers: - url: https://api.icepanel.io/v1 components: schemas: AuthType: type: string enum: - user - api-key - notification-key - service title: AuthType Version: type: object properties: modelHandleId: type: - string - 'null' name: type: string notes: type: string completedAt: type: string format: date-time createdAt: type: string format: date-time createdBy: $ref: '#/components/schemas/AuthType' createdById: type: string diagramHandleIds: type: array items: type: string id: type: string landscapeId: type: string tags: type: array items: type: string updatedAt: type: string format: date-time updatedBy: $ref: '#/components/schemas/AuthType' updatedById: type: string required: - modelHandleId - name - notes - createdAt - createdBy - createdById - diagramHandleIds - id - landscapeId - tags - updatedAt - updatedBy - updatedById title: Version versions_get_Response_200: type: object properties: version: $ref: '#/components/schemas/Version' required: - version title: versions_get_Response_200 Error: type: object properties: code: type: string errors: type: array items: type: string message: type: string required: - message title: Error securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: API key authentication BearerAuth: type: http scheme: bearer description: Bearer token authentication ``` -------------------------------- ### Get Organization Technology with C# RestSharp Source: https://developer.icepanel.io/api-reference/organizations/technologies/get Make a GET request to retrieve organization technology using the RestSharp library in C#. The API key should be passed in the 'X-API-Key' header. ```csharp using RestSharp; var client = new RestClient("https://api.icepanel.io/v1/organizations/organizationId/technologies/catalogTechnologyId"); var request = new RestRequest(Method.GET); request.AddHeader("X-API-Key", ""); IRestResponse response = client.Execute(request); ```