Get Saved View (Reserved)

Overview

Retrieve a single saved view by its ID, including the full canvas state with object positions, edges, comments, and groups.

URI

GET /rest/applications/{name}/saved-views/{id}

Path parameters

name (string)

This parameter identifies the analyzed application. The application name must be properly encoded if it is required. Character back-quote is not allowed.

id (string)

The Neo4j element ID of the saved view to retrieve.

Responses

application/json

Success Response

{
    "name": "Architecture View",
    "app": "MyApp",
    "id": "4:abc123:456",
    "custom": true,
    "createdBy": "admin",
    "createdAt": "2026-02-10 14:30:00",
    "updatedBy": "admin",
    "updatedAt": "2026-02-10 14:30:00",
    "canvas": {
        "x": 0,
        "y": -0.059,
        "zoom": 16.21,
        "angle": 0,
        "height": 651,
        "width": 672,
        "isMethodsView": false,
        "isObjectsView": true,
        "isCommunities": false,
        "graph": {
            "nodes": [
                {
                    "id": "4:abc123:100",
                    "data": {
                        "AipId": "1744",
                        "Name": "COBASV01",
                        "Type": "Cobol Batch Program",
                        "X": 10.0,
                        "Y": 0.0,
                        "Opacity": 1,
                        "Color": ""
                    }
                }
            ],
            "edges": [
                {
                    "id": "5:abc123:200",
                    "source": "4:abc123:100",
                    "target": "4:abc123:101",
                    "type": "CALL"
                }
            ]
        }
    },
    "callGraphData": {
        "Id": "",
        "type": ""
    },
    "graphOptionsData": {
        "version": "3.6.0",
        "viewName": "",
        "isReducedGraph": false,
        "externalReferences": false
    }
}

Error Response

View not found:

{
    "code": 1,
    "message": "view not found",
    "status": 404
}

JSON representation

Response

Property Type Description
name string Name of the saved view.
app string Application name.
id string Neo4j element ID of the view.
custom boolean Whether this is a user-created custom view.
createdBy string Username of the creator.
createdAt string Creation timestamp (format: YYYY-MM-DD HH:MM:SS).
updatedBy string Username of the last updater.
updatedAt string Last update timestamp (format: YYYY-MM-DD HH:MM:SS).
drillDownMode string Drill-down mode for community views.
drillDownNode string Drill-down node for community views.
drillDownPath []string Drill-down path for community views.
levelXDrill object Level drill-down configuration.
canvas object Full canvas state.
callGraphData object Call graph configuration.
graphOptionsData object Graph rendering options.
levelNodeData []object Level-specific node data.

Canvas object

Property Type Description
x number Canvas pan X position.
y number Canvas pan Y position.
zoom number Canvas zoom level.
angle number Canvas rotation angle.
height number Canvas height.
width number Canvas width.
level string Level label for level views.
isMethodsView boolean Whether this is a methods view.
isObjectsView boolean Whether this is an objects view.
isCommunities boolean Whether communities mode is enabled.
levelTransformation integer Level transformation identifier.
graph object Graph containing nodes and edges.
comments []object List of comments on the canvas.
groups []object List of groups on the canvas.

Graph node object

Property Type Description
id string Neo4j element ID of the object.
data.AipId string Application-level identifier of the object.
data.Name string Name of the object.
data.Type string Type of the object.
data.X number X position on the canvas.
data.Y number Y position on the canvas.
data.Opacity number Node opacity.
data.Color string Node color override.

Edge object

Property Type Description
id string Neo4j element ID of the relationship.
source string Element ID of the source node.
target string Element ID of the target node.
type string Relationship type (e.g., CALL, USE).