Create Object Post-it

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

URI

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

{
    "title": "Post-it Title",
    "description": "A description of the Post-it."
}

A JSON object describing the new Post-it:

Responses

application/json

Example:

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

JSON representation