Get Dynamic Aggregation (Reserved)


Overview

Get the dynamic aggregation graph for a custom view. This returns the visual representation of the custom view including all nodes and their relationships.

URI

GET /rest/applications/{application}/custom-views/{viewId}/dynamic

Path parameters

application (string)

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

viewId (string)

The unique identifier of the custom view.

Query parameters

type (string)

Optional. The response type. Default is “graph”. Options:

  • graph: Returns the full graph with nodes and edges.
  • details: Returns metadata details about the aggregation.
shared (boolean)

Optional. Whether to include shared/published view data. Default is false.

Responses

application/json

Graph Response (type=graph)

{
    "success": {
        "nodes": [
            {
                "id": "node-xyz789",
                "name": "Cloud Blockers",
                "count": 42,
                "type": "customNode"
            },
            {
                "id": "node-uvw012",
                "name": "Java Services",
                "count": 15,
                "type": "customNode"
            }
        ],
        "edges": [
            {
                "source": "node-xyz789",
                "target": "node-uvw012",
                "count": 8,
                "types": ["callLink"]
            }
        ],
        "aggregationType": "custom",
        "viewName": "Cloud Migration Analysis"
    }
}

Details Response (type=details)

{
    "success": {
        "id": "abc123-def456",
        "name": "Cloud Migration Analysis",
        "mode": "dynamic",
        "nodeCount": 5,
        "totalObjects": 127,
        "createdBy": "admin",
        "createdAt": "2024-01-15T10:30:00",
        "published": true
    }
}

JSON representation (Graph)

PropertyTypeDescription
success.nodes[]objectArray of custom nodes in the view.
success.nodes[].idstringThe node’s unique identifier.
success.nodes[].namestringThe node name.
success.nodes[].countintegerNumber of objects in the node.
success.nodes[].typestringNode type (typically “customNode”).
success.edges[]objectArray of relationships between nodes.
success.edges[].sourcestringSource node ID.
success.edges[].targetstringTarget node ID.
success.edges[].countintegerNumber of relationships.
success.edges[].types[]stringTypes of relationships (e.g., “callLink”).
success.aggregationTypestringThe aggregation type (“custom”).
success.viewNamestringThe custom view name.

JSON representation (Details)

PropertyTypeDescription
success.idstringThe view’s unique identifier.
success.namestringThe view name.
success.modestringThe view mode (“dynamic” or “static”).
success.nodeCountintegerNumber of custom nodes in the view.
success.totalObjectsintegerTotal number of objects across all nodes.
success.createdBystringUsername of the view creator.
success.createdAtstringTimestamp when the view was created.
success.publishedbooleanWhether the view is published.