Create Custom View (Reserved)


Overview

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

URI

POST /rest/applications/{application}/custom-views

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.

Request Body

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

A JSON object describing the new custom view:

PropertyTypeRequiredDescription
namestringYesName of the custom view.
collaborators[]stringNoList of usernames who can collaborate on this view.
modestringNoView mode. Default is “dynamic”. Options: “dynamic”, “static”.

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

PropertyTypeDescription
success.idstringThe unique identifier for the created view.
success.namestringThe view name.
success.collaborators[]stringList of collaborator usernames.
success.modestringThe view mode (“dynamic” or “static”).
success.publishedbooleanWhether the view is published for sharing.
success.isCreatorbooleanWhether the current user is the creator.
success.createdBystringUsername of the view creator.
success.createdAtstringTimestamp when the view was created.