Update 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

Update an existing custom aggregation view. You can rename the view, update collaborators, or modify other properties.

URI

PUT /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

{
    "id": "abc123-def456",
    "name": "Updated View Name",
    "collaborators": ["user1", "user2"],
    "mode": "dynamic",
    "unassigned": true
}

A JSON object describing the view update:

Property	Type	Required	Description
id	string	Yes	The unique identifier of the view to update.
name	string	Yes	Updated name of the custom view.
collaborators	[]string	No	Updated list of collaborator usernames.
mode	string	No	View mode. For static views, the API preserves static behavior and only supports rename semantics.
unassigned	boolean	No	Enables or disables the Unassigned node for Dynamic and Architecture views. If omitted, the current setting is preserved.
validated	boolean	No	Architecture views only: `true` validates the view, the same as Validate links in the viewer. Real dependencies between its custom nodes are then computed by Get Architecture Aggregation and Validate Architecture Links. Adding custom nodes or switching the link mode resets it. If omitted, the current setting is preserved.
userLinks	boolean	No	Architecture views only: the saved choice of whether to show the user’s links next to the real dependencies. Get Architecture Aggregation uses it when `userLinks` is not passed. If omitted, the current setting is preserved.

This endpoint does not change the linkMode of an architecture view. Use Switch Aggregation Link Mode instead.

Responses

application/json

Example:

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

JSON representation

Property	Type	Description
success.id	string	The unique identifier for the view.
success.name	string	The updated view name.
success.collaborators	[]string	Updated list of collaborator usernames.
success.mode	string	The resulting view mode. Static views remain static and are treated as rename-only.
success.published	boolean	Whether the view is published for sharing.
success.unassigned	boolean	Whether the Unassigned node is enabled.
success.validated	boolean	Architecture views only: whether the view is validated.
success.userLinks	boolean	Architecture views only: whether the user’s links are shown with the computed dependencies.
success.isCreator	boolean	Whether the current user is the creator.
success.createdBy	string	Username of the view creator.
success.createdAt	string	Timestamp when the view was created.