Update Object Post-it

Update an existing Post-it associated with a specific object in an application.
The Post-it is identified by its unique id and updated with the new title and description.

URI

PUT /rest/applications/{name}/objects/{id}/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.

id (integer)

The unique identifier for the object.

Request Body

{
  "id": "9876adbqidqeqwehqe34623i2bef5",
  "title": "Updated Business Logic Notes",
  "description": "Updated documentation for order validation process"
}

Property	Type	Required	Description
id	string	Yes	The Post-it identifier to update.
title	string	Yes	The updated Post-it title.
description	string	Yes	The updated Post-it description.

Responses

application/json

Example:

{
  "id": "9876adbqidqeqwehqe34623i2bef5",
  "title": "Updated Business Logic Notes",
  "description": "Updated documentation for order validation process",
  "isAIGenerated": false,
  "object": {
    "id": "12345",
    "name": "C_Order",
    "type": "Java Method"
  }
}

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).
object	structure	Metadata about the associated object.
object.id	string	The object identifier.
object.name	string	The object name.
object.type	string	The object type.