Search

GET

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/search

GET

/v1/landscapes/:landscapeId/versions/:versionId/search

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.landscapes.search("landscapeId", "versionId", {
8         search: "search",
9     });
10 }
11 main();

1 {
2   "results": [
3     {
4       "id": "string",
5       "name": "string",
6       "score": 1.1,
7       "type": "actor",
8       "data": {
9         "caption": "string",
10         "commit": 1.1,
11         "description": "string",
12         "external": true,
13         "groupIds": [
14           "string"
15         ],
16         "icon": {
17           "catalogTechnologyId": "string",
18           "name": "string",
19           "url": "string",
20           "urlDark": [
21             "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
22             "/dark/{catalogTechnologyId}.png"
23           ],
24           "urlLight": [
25             "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
26             "/light/{catalogTechnologyId}.png"
27           ]
28         },
29         "labels": {},
30         "links": {},
31         "name": "string",
32         "parentId": "string",
33         "status": "deprecated",
34         "tagIds": [
35           "string"
36         ],
37         "teamIds": [
38           "string"
39         ],
40         "teamOnlyEditing": true,
41         "technologyIds": [
42           "string"
43         ],
44         "type": "actor",
45         "domainId": "string",
46         "handleId": "string",
47         "childDiagramIds": [
48           "string"
49         ],
50         "childIds": [
51           "string"
52         ],
53         "createdAt": "2024-01-15T09:30:00Z",
54         "createdBy": "user",
55         "createdById": "string",
56         "deletedAt": "2024-01-15T09:30:00Z",
57         "deletedBy": "user",
58         "deletedById": "string",
59         "diagrams": {},
60         "flows": {},
61         "id": "string",
62         "landscapeId": "string",
63         "latestEntityId": "string",
64         "linked": true,
65         "parentIds": [
66           "string"
67         ],
68         "updatedAt": "2024-01-15T09:30:00Z",
69         "updatedBy": "user",
70         "updatedById": "string",
71         "version": 1.1,
72         "versionId": "string"
73       }
74     }
75   ]
76 }

Search the entire landscape

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

searchstringRequired

filterobjectOptional

includeDatabooleanOptional

maxResultsdoubleOptional

Response

resultslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error