Update View Post-it (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.

Update an existing Post-it associated with a specific view within an application and domain.
This operation requires a JSON payload containing the Post-it’s id, along with the updated title and description.

URI

PUT /rest/applications/{name}/views/{view}/post-it

Path parameters

name (string)

This parameter identifies the analyzed application. The application name must be properly encoded if it is required. Character back-quote is not allowed.

view (string)

The viewType of the view Enum: [application, module, transaction, datagraph, level, saved, architecture, projectStructure, service]

Request Body

{
  "id": "98765",
  "title": "Updated Notes",
  "description": "Revised documentation for the order modules"
}
Property Type Required Description
id string Yes Identifier of the Post-it to update.
title string Yes Updated title of the Post-it.
description string Yes Updated description of the Post-it.

Responses

application/json

Example:

{
  "id": "9876adbqidqeqwehqe34623i2bef5",
  "title": "Updated Notes",
  "description": "Revised documentation for the order modules",
  "isAIGenerated": false,
  "view": {
    "id": "12345",
    "aggregatedBy": "castTaxonomy",
    "type": "module"
  }
}

JSON representation

Property Type Description
id string The updated Post-it identifier.
title string The updated Post-it title.
description string The updated Post-it description.
isAIGenerated boolean Indicates whether the Post-it is AI-generated (false for user-updated).
view structure Metadata about the associated view.
view.id string The view identifier.
view.aggregatedBy string The aggregation used (service, module, castTaxonomy, rdbmsInventory, classesInheritance, projectStructure).
view.type string The type of the view. Enum: [application, module, transaction, datagraph, level, saved, architecture, projectStructure, service].