Create Custom View (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

Create a new custom aggregation view for organizing objects within an application. Custom views act as containers for custom nodes.

Only dynamic custom view creation is supported through this API.

URI

POST /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.

Request Body

{
    "name": "My Custom View",
    "collaborators": [],
    "mode": "dynamic"
}

A JSON object describing the new custom view:

Responses

application/json

Example:

{
    "success": {
        "id": "abc123-def456",
        "name": "My Custom View",
        "collaborators": [],
        "mode": "dynamic",
        "published": false,
        "isCreator": true,
        "createdBy": "admin",
        "createdAt": "2024-01-15T10:30:00"
    }
}

JSON representation