Get View Post-its (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.

Retrieve Post-its associated with views of an application.
Supports filtering by view type, view identifier, source (AI or user) The response is paginated using limit and skip.

URI

GET /rest/applications/{name}/views/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.

Query parameters

Parameter Type Required Description
viewType string No Type of view. One of: application, module, transaction, datagraph, saved, level.
id string No Identifier of the view. Interpretation depends on the view type
source string No Filter by source: ai (AI-generated) or user (user-created).
limit int Yes Maximum number of Post-its to return in this page of results.
skip int No Number of Post-its to skip before returning results (for pagination). Defaults to 0.

Responses

application/json

Example:

{
  "limit": 2,
  "skip": 0,
  "total": 12,
  "results": [
    {
      "id": "doc-101",
      "title": "Application Overview",
      "description": "High-level application documentation",
      "isAIGenerated": false,
      "view": {
        "id": "App1",
        "aggregatedBy": "",
        "type": "Application"
      }
    },
    {
      "id": "doc-102",
      "title": "Order Processing Module",
      "description": "Documentation for order processing",
      "isAIGenerated": true,
      "view": {
        "id": "mod-12",
        "aggregatedBy": "-3_CAST Taxonomy",
        "type": "Module"
      }
    }
  ]
}

JSON representation

Property Type Description
limit int Number of Post-its returned in this response.
skip int Number of Post-its skipped.
total int Total number of Post-its matching the query.
results array List of view Post-its.
results[].id string Post-it identifier.
results[].title string Post-it title.
results[].description string Post-it description.
results[].isAIGenerated boolean Indicates if the Post-it was generated by AI.
results[].view structure Metadata about the associated view.
results[].view.id string The view identifier.
results[].view.aggregatedBy string The view aggregation type (e.g., -3_CAST Taxonomy, etc.).
results[].view.type string The view type.