Get Custom 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 stored aggregation graph for a static custom view. This returns the visual representation of the static custom view including its custom nodes and relationships.

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

URI

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

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 static custom views.
• The shared query parameter is accepted for consistency with dynamic graph retrieval, but static custom-view graphs are stored graphs rather than dynamically recomputed graphs.
• If the target custom view is dynamic, the API returns a client error and the caller should use:

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

Responses

application/json

Graph Response (type=graph)

{
    "success": {
        "graph": {
            "nodes": [
                {
                    "id": "4:abc:123",
                    "data": {
                        "Name": "Business Services",
                        "Count": 42
                    }
                },
                {
                    "id": "4:abc:456",
                    "data": {
                        "Name": "Persistence",
                        "Count": 18
                    }
                }
            ],
            "edges": [
                {
                    "id": "4:abc:123_CALL_4:abc:456",
                    "source": "4:abc:123",
                    "target": "4:abc:456",
                    "type": "CALL",
                    "data": {
                        "Count": 12,
                        "Type": "CALL"
                    }
                }
            ]
        },
        "documents": []
    }
}

Details Response (type=details)

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

JSON representation (Graph)

JSON representation (Details)