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)

Property Type Description
success.nodes []object Array of custom nodes in the view.
success.nodes[].id string The node’s unique identifier.
success.nodes[].name string The node name.
success.nodes[].count integer Number of objects in the node.
success.nodes[].type string Node type (typically “customNode”).
success.edges []object Array of relationships between nodes.
success.edges[].source string Source node ID.
success.edges[].target string Target node ID.
success.edges[].count integer Number of relationships.
success.edges[].types []string Types of relationships (e.g., “callLink”).
success.aggregationType string The aggregation type (“custom”).
success.viewName string The custom view name.

JSON representation (Details)

Property Type Description
success.id string The view’s unique identifier.
success.name string The view name.
success.mode string The view mode (“dynamic” or “static”).
success.nodeCount integer Number of custom nodes in the view.
success.totalObjects integer Total number of objects across all nodes.
success.createdBy string Username of the view creator.
success.createdAt string Timestamp when the view was created.
success.published boolean Whether the view is published.