Get Dynamic Aggregation (RESERVED)

RESERVED: The keyword RESERVED annotation means that the API is available for use but is not yet part of the officially supported specification. Its behavior, interface, or output may change in future releases without backward compatibility guarantees.

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.

Use this endpoint only for custom views whose aggregationType is Dynamic in the custom view list response.

URI

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

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.

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 virtual relationships between custom nodes. Default is false.

Notes

  • This endpoint is intended for dynamic custom views.
  • If the target custom view is static, the API returns a client error and the caller should use:
GET /rest/applications/{name}/custom-views/{viewId}

Responses

application/json

Graph Response (type=graph)

{
    "success": {
        "graph": {
            "nodes": [
                {
                    "id": "4:abc:123",
                    "data": {
                        "Name": "node1",
                        "Count": 94
                    }
                },
                {
                    "id": "4:abc:456",
                    "data": {
                        "Name": "node2",
                        "Count": 46
                    }
                }
            ],
            "edges": [
                {
                    "id": "4:abc:123_IMPLEMENT_4:abc:456",
                    "source": "4:abc:123",
                    "target": "4:abc:456",
                    "type": "IMPLEMENT",
                    "data": {
                        "Count": 12,
                        "Type": "IMPLEMENT"
                    }
                },
                {
                    "id": "4:abc:123_Shared_4:abc:456",
                    "source": "4:abc:123",
                    "target": "4:abc:456",
                    "type": "Shared",
                    "data": {
                        "Count": 46,
                        "Type": "Shared"
                    }
                }
            ]
        },
        "documents": []
    }
}

Details Response (type=details)

{
    "success": {
        "duplicated": 0,
        "total": 140,
        "grouped": 140
    }
}

JSON representation (Graph)

Property Type Description
success.graph.nodes []object Array of custom nodes in the view.
success.graph.nodes[].id string The node’s unique identifier.
success.graph.nodes[].data object Node metadata, including name, count, parameters, and labels.
success.graph.edges []object Array of relationships between custom nodes.
success.graph.edges[].id string Unique identifier of the relationship.
success.graph.edges[].source string Source custom node ID.
success.graph.edges[].target string Target custom node ID.
success.graph.edges[].type string Relationship type, for example CALL, IMPLEMENT, or Shared.
success.graph.edges[].data object Relationship metadata, including Count.
success.documents []object Associated documents for the aggregation response.

JSON representation (Details)

Property Type Description
success.duplicated integer Number of duplicated objects in the aggregation.
success.total integer Total number of objects considered by the aggregation.
success.grouped integer Number of objects currently grouped in the custom view.