Data Graph

Overview

Retrieve the visual graph representation of a specific data graph. This endpoint returns a graph structure containing nodes (objects in the data graph) and links (call relationships between them). The graph helps visualize the call hierarchy and data flow from the start point to end points.

URI

GET /rest/applications/{name}/data-graphs/{id}/graph

Path parameters

name (string)

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

id (integer)

required The unique identifier of the data graph for which to retrieve the graph representation.

Responses

application/json

The response contains a graph structure with nodes and links. Example:

{
    "nodes": [
        {
            "id": "123456",
            "name": "processOrder",
            "type": "Java Method",
            "typeId": 12345
        },
        {
            "id": "123457",
            "name": "validateOrder",
            "type": "Java Method",
            "typeId": 12345
        },
        {
            "id": "123458",
            "name": "ORDERS",
            "type": "SQL Table",
            "typeId": 67890
        }
    ],
    "links": [
        {
            "depth": 0,
            "type": "CALL",
            "origin": {
                "id": "123456",
                "isStartPoint": true
            },
            "target": {
                "id": "123457",
                "isEndPoint": false
            }
        },
        {
            "depth": 1,
            "type": "CALL",
            "origin": {
                "id": "123457",
                "isStartPoint": false
            },
            "target": {
                "id": "123458",
                "isEndPoint": true
            }
        }
    ]
}

JSON representation

Property	Type	Description
nodes	array	An array of node objects representing objects in the data graph.
links	array	An array of link objects representing call relationships.

Node Object

Each node in the nodes array contains:

Property	Type	Description
id	string	The unique identifier (AipId) of the object.
name	string	The short name of the object.
type	string	The type of the object (e.g., “Java Method”, “SQL Table”).
typeId	integer	The internal type identifier.

Link Object

Each link in the links array contains:

Property	Type	Description
depth	integer	The depth level in the call hierarchy (0 = from start point).
type	string	The type of relationship (e.g., “CALL”).
origin	object	Information about the calling object.
target	object	Information about the called object.

Origin/Target Object

Property	Type	Description
id	string	The unique identifier (AipId) of the object.
isStartPoint	boolean	True if this is the starting point of the data graph (origin only).
isEndPoint	boolean	True if this is an end point of the data graph (target only).