Unpublish 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

Unpublish a custom aggregation view to make it private. After unpublishing, only the creator and collaborators can access the view.

URI

POST /rest/applications/{name}/custom-views/{viewId}/unpublish

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 to unpublish.

Request Body

No request body required.

Responses

application/json

Example:

{
    "success": {
        "id": "abc123-def456",
        "name": "Cloud Migration Analysis",
        "collaborators": [],
        "mode": "dynamic",
        "published": false,
        "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 view name.
success.collaborators []string List of collaborator usernames.
success.mode string The view mode. Successful unpublish responses are for dynamic views.
success.published boolean Will be false after unpublishing.
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.