List Custom Views (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 list of custom aggregation views for an application. Returns views created by the current user and views shared with them.

URI

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

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.

Responses

application/json

Example:

{
    "success": {
        "count": 2,
        "aggregationList": [
            {
                "id": "abc123-def456",
                "name": "Cloud Migration Analysis",
                "mode": "CustomAggregation",
                "count": 5,
                "collaborators": ["user1", "user2"],
                "isCreator": true,
                "published": true,
                "populatedBy": "",
                "aggregationType": "Dynamic",
                "createdBy": "admin",
                "createdAt": "2024-01-15T10:30:00"
            },
            {
                "id": "xyz789-uvw012",
                "name": "Technical Debt Review",
                "mode": "CustomAggregation",
                "count": 2,
                "collaborators": [],
                "isCreator": true,
                "published": false,
                "populatedBy": "",
                "aggregationType": "Static",
                "createdBy": "admin",
                "createdAt": "2024-01-16T14:00:00"
            }
        ]
    }
}

Notes:

mode identifies the view family and is typically CustomAggregation for custom views.
aggregationType is the field that differentiates the view implementation: Dynamic or Static.

JSON representation

Property	Type	Description
success.count	integer	Total number of views returned.
success.aggregationList	[]object	Array of custom view objects.
success.aggregationList[].id	string	The unique identifier for the view.
success.aggregationList[].name	string	The view name.
success.aggregationList[].mode	string	The view family identifier, typically `CustomAggregation`.
success.aggregationList[].count	integer	Number of custom nodes in the view.
success.aggregationList[].collaborators	[]string	List of collaborator usernames.
success.aggregationList[].isCreator	boolean	Whether the current user is the creator.
success.aggregationList[].published	boolean	Whether the view is published for sharing.
success.aggregationList[].populatedBy	string	How the view was populated (empty for manual).
success.aggregationList[].aggregationType	string	View implementation type: `Dynamic` or `Static`.
success.aggregationList[].createdBy	string	Username of the view creator.
success.aggregationList[].createdAt	string	Timestamp when the view was created.