Create 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.

Create a new Post-it associated with a specific view within an application and domain.
This operation requires a JSON payload containing the Post-it’s viewId, aggregatedBy, title, and description.

URI

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

{
  "viewId": "12345",
  "aggregatedBy": "module",
  "title": "Module-Level Notes",
  "description": "Documentation for all order-related modules"
}

A JSON object describing the new Post-it:

Property Type Required Description
viewId string Yes Identifier of the view this Post-it belongs to.
aggregatedBy string Yes Aggregation level (service, module, castTaxonomy, rdbmsInventory, classesInheritance, projectStructure).
title string Yes Title of the Post-it.
description string Yes Description of the Post-it.

Responses

application/json

Example:

{
  "id": "98765",
  "title": "Module-Level Notes",
  "description": "Documentation for all order-related modules",
  "isAIGenerated": false,
  "view": {
    "id": "12345",
    "aggregatedBy": "castTaxonomy",
    "type": "module"
  }
}

JSON representation

Property Type Description
id string The created Post-it identifier.
title string The Post-it title.
description string The Post-it description.
isAIGenerated boolean Indicates whether the Post-it is AI-generated (false for user-created).
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].