Get Object Post-its


Get the Post-its associated with a specific object.

The Post-its can either be AI-generated or user-provided. Pagination is supported through the limit and skip query parameters.

URI

GET /rest/applications/{name}/objects/{id}/post-its

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.

Query parameters

source (string)

Optional. Filter Post-its by source. Enum: [“ai”, “user”]

limit (integer)

Required. Maximum number of Post-its to return.

skip (integer)

Optional. Number of Post-its to skip before including results in the response.

Responses

application/json

Example:

{
  "limit": 10,
  "skip": 0,
  "total": 2,
  "results": [
    {
      "id": "9876adbqidqeqwehqe34623i2bef5",
      "title": "Post-it Title",
      "description": "Detailed description of the Post-it.",
      "isAIGenerated": false,
      "object": {
        "id": "67890",
        "name": "M_PriceList_Create",
        "type": "Oracle Procedure"
      }
    },
    {
      "id": "9876adbqidqewqfefwe345i2bef5",
      "title": "AI Generated Post-it",
      "description": "This Post-it was generated by AI.",
      "isAIGenerated": true,
      "object": {
        "id": "67890",
        "name": "M_PriceList_Create",
        "type": "Oracle Procedure"
      }
    }
  ]
}

JSON representation

Property Type Description
limit integer The maximum number of Post-its returned in this response.
skip integer The number of Post-its skipped before this response.
total integer The total number of available Post-its.
results[] array The list of Post-its.
results[].id string The Post-it identifier.
results[].title string The Post-it title.
results[].description string The Post-it description.
results[].isAIGenerated boolean Indicates if the Post-it is AI-generated (true) or user-created (false).
results[].object structure The associated object metadata.
results[].object.id string The object ID.
results[].object.name string The object name.
results[].object.type string The object type.