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

PropertyTypeDescription
namestringName of the saved view.
appstringApplication name.
idstringNeo4j element ID of the view.
custombooleanWhether this is a user-created custom view.
createdBystringUsername of the creator.
createdAtstringCreation timestamp (format: YYYY-MM-DD HH:MM:SS).
updatedBystringUsername of the last updater.
updatedAtstringLast update timestamp (format: YYYY-MM-DD HH:MM:SS).
drillDownModestringDrill-down mode for community views.
drillDownNodestringDrill-down node for community views.
drillDownPath[]stringDrill-down path for community views.
levelXDrillobjectLevel drill-down configuration.
canvasobjectFull canvas state.
callGraphDataobjectCall graph configuration.
graphOptionsDataobjectGraph rendering options.
levelNodeData[]objectLevel-specific node data.

Canvas object

PropertyTypeDescription
xnumberCanvas pan X position.
ynumberCanvas pan Y position.
zoomnumberCanvas zoom level.
anglenumberCanvas rotation angle.
heightnumberCanvas height.
widthnumberCanvas width.
levelstringLevel label for level views.
isMethodsViewbooleanWhether this is a methods view.
isObjectsViewbooleanWhether this is an objects view.
isCommunitiesbooleanWhether communities mode is enabled.
levelTransformationintegerLevel transformation identifier.
graphobjectGraph containing nodes and edges.
comments[]objectList of comments on the canvas.
groups[]objectList of groups on the canvas.

Graph node object

PropertyTypeDescription
idstringNeo4j element ID of the object.
data.AipIdstringApplication-level identifier of the object.
data.NamestringName of the object.
data.TypestringType of the object.
data.XnumberX position on the canvas.
data.YnumberY position on the canvas.
data.OpacitynumberNode opacity.
data.ColorstringNode color override.

Edge object

PropertyTypeDescription
idstringNeo4j element ID of the relationship.
sourcestringElement ID of the source node.
targetstringElement ID of the target node.
typestringRelationship type (e.g., CALL, USE).