@cplace/mcp-server 1.6.0 → 1.6.2

package/dist/plugins/core-app-catalog/cf.cplace.projektplanung.projektplanungExtended/README.md

@@ -0,0 +1,216 @@
+# Project Planning (Extended) (cf.cplace.projektplanung.projektplanungExtended)
+
+## Overview
+
+The "Project Planning (Extended)" app is the foundation for hybrid project management. In addition to the features included in the "Project Planning (Basic)" app, this app gives you advanced features such as delegating and subscribing tasks, choosing between forward and backward scheduling, and combining classic and agile project management.
+
+**Key capabilities:**
+- Task delegation across schedules
+- Task/milestone subscriptions (cross-schedule references)
+- Forward and backward scheduling modes
+- Protection controls for subscriptions
+- Constraint-based scheduling (must start, must finish, startline, deadline)
+
+## Dependencies
+
+Installing this app automatically installs:
+
+| App | Qualified Name | Purpose |
+|-----|----------------|---------|
+| cplace Basis | `cf.cplace.platform` | Base platform (always installed) |
+| Project Planning (Basic) | `cf.cplace.projektplanung.projektplanungBasic` | Core Gantt functionality, Schedule/Task/Milestone types |
+
+## Types Provided
+
+The types below are provided by this app and its dependencies. All three types work together to form a hierarchical schedule structure.
+
+### cf.schedule (Schedule)
+
+The root container for project planning. Contains all tasks and milestones.
+
+| Attribute | Internal Name | Type | Required | Description |
+|-----------|---------------|------|----------|-------------|
+| Start | `startDate` | Date | No | Schedule starts in the morning of the specified day |
+| Finish | `endDate` | Date | No | Schedule finishes in the evening of the specified day |
+| Duration | `duration` | Number | Yes | Duration value |
+| Duration Unit | `durationUnit` | Enumeration | Yes | Unit for duration |
+| % Completed | `percentComplete` | Number | Yes | Completion percentage |
+| RAG Rating | `ratingLight` | Enumeration | No | Red/Amber/Green status indicator |
+| Note | `note` | Text | No | Free-text notes |
+| Calendar ID | `calendarId` | Text | Yes | Calendar for working days |
+| Task Class | `activityClass` | Reference | No | Visual styling category |
+| **Extended Features:** | | | | |
+| Backwards scheduling | `scheduleBackwards` | Boolean | Yes | Forward vs backward scheduling mode |
+| Allow Subscribing | `allowSubscription` | Boolean | Yes | Enable subscriptions in this schedule |
+| Allow Delegating | `allowDelegation` | Boolean | Yes | Enable delegations in this schedule |
+| Restricted Read Access for Subscriptions | `protectSubscriptions` | Boolean | No | Protect subscription visibility |
+| Parent Project | `parentProject` | Reference | No | Parent project for hierarchy |
+| Links to Other Projects | `additionalProjectLinks` | Reference (multi) | No | Cross-project references |
+| **Baseline/Target:** | | | | |
+| Target Start | `baselineStartDate` | Date | No | Baseline start date |
+| Target Finish | `baselineEndDate` | Date | No | Baseline end date |
+| Target Duration (Days) | `baselineDuration` | Number | No | Baseline duration |
+| Target % Done | `baselinePercentComplete` | Number | No | Baseline completion |
+| **Display Options:** | | | | |
+| Rollup | `rollup` | Boolean | No | Display in parent object row |
+| Hide at Rollup of Subtasks | `hideOnSubtaskRollup` | Boolean | No | Hide when subtasks roll up |
+| Alias | `alias` | Text | No | Alternative display name |
+| Gantt Version | `cf.cplace.gantt.ganttVersion` | Text | No | "2.0" for New Gantt Widget |
+| **Integration:** | | | | |
+| Print Profile | `printProfile` | Reference | No | Default print profile |
+| PG Profile | `pgProfile` | Reference | No | Presentation Graphic profile |
+
+### cf.activity (Task)
+
+Work items with duration within a schedule.
+
+| Attribute | Internal Name | Type | Required | Description |
+|-----------|---------------|------|----------|-------------|
+| Parent object | `parent` | Reference | Yes | Parent schedule or task (for hierarchy) |
+| Schedule | `containingSchedule` | Reference | No | Containing schedule (computed) |
+| Start | `startDate` | Date | No | Task starts in the morning |
+| Finish | `endDate` | Date | No | Task finishes in the evening |
+| Duration | `duration` | Number | Yes | Duration value |
+| Duration Unit | `durationUnit` | Enumeration | Yes | Unit for duration |
+| % Completed | `percentComplete` | Number | Yes | Completion percentage |
+| RAG Rating | `ratingLight` | Enumeration | No | Status indicator |
+| Automatically scheduled | `automaticScheduling` | Boolean | No | Auto-reschedule on predecessor changes |
+| Note | `note` | Text | No | Free-text notes |
+| Calendar ID | `calendarId` | Text | Yes | Calendar for working days |
+| Task Class | `activityClass` | Reference | No | Visual styling category |
+| **Extended Features:** | | | | |
+| Delegated from subscribed task | `delegationSource` | Reference | No | Source of delegation |
+| Additional delegation data | `delegationData` | Text | No | Delegation metadata |
+| Additional subscription data | `mirrorData` | Text | No | Subscription metadata |
+| Restricted Read Access | `protectSubscriptions` | Boolean | No | Protect subscription visibility |
+| **Constraints:** | | | | |
+| Must Start | `mustStartOnDate` | Boolean | No | Task must start on start date |
+| Must End | `mustFinishOnDate` | Boolean | No | Task must end on end date |
+| Startline | `startlineDate` | Date | No | Earliest possible start |
+| Deadline | `deadlineDate` | Date | No | Latest possible end |
+| Task Position | `taskPosition` | Enumeration | No | "as soon as possible" or "as late as possible" |
+| **Baseline/Target:** | | | | |
+| Target Start | `baselineStartDate` | Date | No | Baseline start |
+| Target Finish | `baselineEndDate` | Date | No | Baseline end |
+| Target Duration (Days) | `baselineDuration` | Number | No | Baseline duration |
+| Target % Done | `baselinePercentComplete` | Number | No | Baseline completion |
+| **Display Options:** | | | | |
+| Rollup | `rollup` | Boolean | No | Display in parent row |
+| Hide at Rollup of Subtasks | `hideOnSubtaskRollup` | Boolean | No | Hide when subtasks roll up |
+| Alias | `alias` | Text | No | Alternative display name |
+
+### cf.milestone (Milestone)
+
+Point-in-time markers within a schedule (zero duration).
+
+| Attribute | Internal Name | Type | Required | Description |
+|-----------|---------------|------|----------|-------------|
+| Parent object | `parent` | Reference | Yes | Parent schedule or task |
+| Schedule | `containingSchedule` | Reference | No | Containing schedule (computed) |
+| Date | `date` | Date | No | Milestone date (evening of day) |
+| % Completed | `percentComplete` | Number | Yes | Completion percentage (0 or 100) |
+| RAG Rating | `ratingLight` | Enumeration | No | Status indicator |
+| Automatically scheduled | `automaticScheduling` | Boolean | No | Auto-reschedule on predecessor changes |
+| Note | `note` | Text | No | Free-text notes |
+| Calendar ID | `calendarId` | Text | Yes | Calendar reference |
+| Task Class | `activityClass` | Reference | No | Visual styling category |
+| **Extended Features:** | | | | |
+| Delegated from original milestone | `delegationSource` | Reference | No | Source of delegation |
+| Additional delegation data | `delegationData` | Text | No | Delegation metadata |
+| Additional subscription data | `mirrorData` | Text | No | Subscription metadata |
+| Restricted Read Access | `protectSubscriptions` | Boolean | No | Protect subscription visibility |
+| **Constraints:** | | | | |
+| Must Start | `mustStartOnDate` | Boolean | No | Must occur on date |
+| Must End | `mustFinishOnDate` | Boolean | No | Must occur on date |
+| Startline | `startlineDate` | Date | No | Earliest possible date |
+| Deadline | `deadlineDate` | Date | No | Latest possible date |
+| Task Position | `taskPosition` | Enumeration | No | Scheduling preference |
+| **Baseline/Target:** | | | | |
+| Target Start | `baselineStartDate` | Date | No | Baseline date |
+| Target Finish | `baselineEndDate` | Date | No | Baseline date |
+| Target Duration (Days) | `baselineDuration` | Number | No | Always 0 for milestones |
+| Target % Done | `baselinePercentComplete` | Number | No | Baseline completion |
+| **Display Options:** | | | | |
+| Rollup | `rollup` | Boolean | No | Display in parent row |
+| Hide at Rollup of Subtasks | `hideOnSubtaskRollup` | Boolean | No | Hide when subtasks roll up |
+| Alias | `alias` | Text | No | Alternative display name |
+| Show time interval | `cf.cplace.projektplanung.pptexport.showMilestoneTimeInterval` | Boolean | No | Show interval in PG export |
+
+## Widgets Provided
+
+### From Project Planning (Extended)
+
+| Widget | Kind | Description | Use Case |
+|--------|------|-------------|----------|
+| Subscriptions | `cf.cplace.projektplanung.subscriptions` | Shows subscriptions of a planning element in a table | Display cross-schedule references for Tasks and Milestones |
+
+### From Project Planning (Basic) (Dependency)
+
+| Widget | Kind | Description | Use Case |
+|--------|------|-------------|----------|
+| Gantt chart | `cf.projektplanung.singleGantt` | Gantt chart of all tasks and milestones of a schedule | Primary visualization for single schedule |
+| Multi Gantt Chart | `cf.projektplanung.multiGantt` | Displays multiple schedules simultaneously | Portfolio views, program dashboards |
+| Structured Table for Schedules | `cf.projektplanung.scheduleTreeTable` | Tree table showing tasks and milestones | Spreadsheet-like editing of task properties |
+| Schedule Edit State | `cf.projektplanung.scheduleLockState` | Shows who is editing the schedule | Collaborative editing coordination |
+| Open Gantt Chart | `cf.projektplanung.singleGanttLink` | Button to open Gantt in new tab | Quick access from overview pages |
+
+## Key Concepts
+
+### Hierarchy Structure
+
+```
+Schedule (cf.schedule)
+  |-- Task (cf.activity) [parent -> Schedule]
+  |     |-- Task (cf.activity) [parent -> Task] (sub-task)
+  |     |-- Milestone (cf.milestone) [parent -> Task]
+  |-- Milestone (cf.milestone) [parent -> Schedule]
+```
+
+### Delegation vs Subscription
+
+- **Subscription**: Read-only mirror of a task/milestone from another schedule. Changes sync automatically.
+- **Delegation**: Creates a new task/milestone that references the original, allowing independent editing while maintaining a link.
+
+### Scheduling Modes
+
+- **Forward scheduling** (`scheduleBackwards: false`): Calculate dates from start to end
+- **Backward scheduling** (`scheduleBackwards: true`): Calculate dates from end to start
+
+### Constraints
+
+Tasks and milestones support constraint-based scheduling:
+- **Must Start/Must End**: Fixed date constraints
+- **Startline**: Earliest allowed start (like "start no earlier than")
+- **Deadline**: Latest allowed end (like "finish no later than")
+- **Task Position**: "as soon as possible" vs "as late as possible"
+
+## Usage Notes
+
+### When to use this app
+
+- When you need cross-schedule coordination (subscriptions, delegations)
+- When you need backward scheduling
+- When you need constraint-based scheduling (must start, deadline, etc.)
+- For hybrid project management combining classic and agile approaches
+
+### When to use Project Planning (Basic) instead
+
+- Simple single-schedule Gantt charts
+- Basic task/milestone tracking without cross-schedule features
+- Smaller projects without complex scheduling constraints
+
+### Related Apps
+
+| App | Purpose |
+|-----|---------|
+| Task Classes (`cf.cplace.projektplanungMasterData`) | Visual styling for tasks in Gantt |
+| Project Structure (`cf.cplace.projectTree`) | Project hierarchy management |
+| New Gantt (`cf.cplace.projectPlanning.app.gantt2.gantt2`) | Modern Gantt widget (Bryntum-based) |
+| Presentation Graphic (`cf.cplace.pptexport`) | Schedule export to PowerPoint |
+| Project Planning Calendar (`cf.cplace.projektplanungCalendar`) | Non-working days configuration |
+
+## Investigation Metadata
+
+- **Investigation Date**: 2026-02-02
+- **Workspace Used**: `[App Investigation] cf.cplace.projektplanung.projektplanungExtended`
+- **Workspace ID**: `fsy78ggmnkcbyp1om5ofe6xkb`

package/dist/plugins/core-app-catalog/cf.cplace.projektplanungCalendar/README.md

@@ -0,0 +1,84 @@
+# Project Planning Calendar (cf.cplace.projektplanungCalendar)
+
+## Overview
+
+The **Project Planning Calendar** app enables the creation of calendars with non-working days (holidays, company closures, etc.) that can be assigned to tasks or milestones. When a calendar is assigned to planning elements, the non-working days are automatically taken into account when calculating dates in Gantt charts and schedule management.
+
+**Key Use Cases:**
+- Define company-wide or regional holiday calendars
+- Create project-specific calendars with custom non-working days
+- Support accurate scheduling that respects holidays and closures
+
+## Dependencies
+
+This app has **no additional dependencies** beyond the cplace platform:
+- `cf.cplace.platform` (cplace Basis) - always pre-installed
+
+## Singleton Restriction
+
+**Important:** This app can only be installed in **one workspace per tenant**. It is designed to provide a central calendar repository that can be referenced from other workspaces using cross-workspace references.
+
+## Types Provided
+
+### cf.cplace.projektplanungCalendar.calendar
+
+**Purpose:** Represents a named calendar that collects non-working days and can be assigned to schedules, tasks, or milestones.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|---------------|------|----------|----------|-------------|
+| Base Calendar | `cf.cplace.projektplanungCalendar.baseCalendar` | (Reference/Enum) | Yes | No | Basis calendar to inherit from - specifies the standard week structure |
+| Description | `cf.cplace.projektplanungCalendar.description` | String | No | No | Description of the calendar's meaning and usage |
+| Non Working Days | `cf.cplace.projektplanungCalendar.nonWorkingDays` | Reference | No | Yes | Collection of non-working day definitions |
+
+**Configuration:**
+- `namesAreUnique: true` - Calendar names must be unique
+- `showInExplorer: false` - Not shown in workspace explorer
+- `showInGlobalSearch: true` - Can be found via global search
+- Icon: `fa-calendar`
+
+### cf.cplace.projektplanungCalendar.nonWorkingDay
+
+**Purpose:** Represents a single non-working day (holiday, closure, etc.) that belongs to a calendar.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|---------------|------|----------|----------|-------------|
+| Date | `cf.cplace.projektplanungCalendar.date` | Date | Yes | No | The specific date that is a non-working day |
+
+**Configuration:**
+- `namesAreUnique: false` - Names can repeat (e.g., "Christmas" each year)
+- `showInExplorer: false` - Not shown in workspace explorer
+- `showInGlobalSearch: false` - Not indexed for search (search the parent calendar instead)
+- Icon: `fa-calendar`
+
+## Widgets Provided
+
+This app does **not provide any widgets**. It focuses purely on data types for calendar management.
+
+## Integration with Project Planning
+
+The calendars created with this app integrate with:
+- **Project Planning (Basic)** - Tasks and milestones can reference calendars
+- **Project Planning (Extended)** - Advanced scheduling respects calendar constraints
+- **Schedule Management apps** - Calendar-aware date calculations
+
+When a calendar is assigned to a planning element, the Gantt chart calculations automatically:
+- Skip non-working days when calculating duration
+- Adjust start/end dates to avoid landing on non-working days
+- Provide accurate working-day-based scheduling
+
+## Typical Setup
+
+1. Install this app in a dedicated "Calendar" workspace
+2. Create calendars for different regions/departments:
+   - "Germany Holidays 2024"
+   - "US Federal Holidays 2024"
+   - "Company Shutdown Days"
+3. Add Non Working Day pages as children of each calendar
+4. Reference these calendars from schedules in other workspaces
+
+## Usage Notes
+
+- **Centralized Management:** Since this is a singleton app, plan to use one workspace as the central calendar repository
+- **Cross-Workspace References:** Schedules in other workspaces can reference calendars via cross-workspace references
+- **Annual Updates:** Non-working days typically need to be updated annually for holiday calendars
+- **Base Calendar:** The Base Calendar attribute allows inheritance of standard weekly patterns (e.g., Mon-Fri working week)

package/dist/plugins/core-app-catalog/cf.cplace.projektplanungMasterData/README.md

@@ -0,0 +1,78 @@
+# Task Classes (cf.cplace.projektplanungMasterData)
+
+## Overview
+
+Task Classes enables visual categorization and grouping of tasks and milestones in project planning. It provides customizable shapes, colors, and patterns to differentiate planning elements in Gantt charts and Presentation Graphics. This app enhances visual communication by allowing distinct styling for different task categories (e.g., critical path activities, external dependencies, milestones by phase).
+
+**Note**: This app is designed to work in conjunction with the "Project Planning (Extended)" app (`cf.cplace.projektplanung.projektplanungExtended`) for full functionality in Gantt visualizations.
+
+## Dependencies
+
+When installed, the following apps are automatically included:
+- `cf.cplace.platform` (cplace Basis) - Base platform, always present
+
+No additional dependencies are required for this app.
+
+## Types Provided
+
+### cf.activityClass (Task class / Vorgangsklasse)
+
+A configuration type that defines the visual appearance of tasks and milestones in Gantt charts.
+
+| Attribute | Internal Name | Type | Required | Description |
+|-----------|---------------|------|----------|-------------|
+| Activity shape | `activityShape` | Enumeration | Yes | Shape used to display tasks/activities in Gantt |
+| Milestone shape | `milestoneShape` | Enumeration | Yes | Shape used to display milestones in Gantt |
+| Color | `barColor` | Color | No | Fill color for the bar/shape |
+| Border color | `borderColor` | Color | No | Border/outline color |
+| Color pattern | `barPattern` | Enumeration | Yes | Fill pattern (solid, hatched, etc.) |
+| Rollup fill color | `rollupBarColor` | Color | No | Fill color for summary/rollup bars |
+| Rollup border color | `rollupBorderColor` | Color | No | Border color for summary/rollup bars |
+| Label left | `leftLabelField` | Enumeration | No | Attribute to display as label to the left of the bar |
+| Label right | `rightLabelField` | Enumeration | No | Attribute to display as label to the right of the bar |
+| Label top | `topLabelField` | Enumeration | No | Attribute to display as label above the bar |
+| Label bottom | `bottomLabelField` | Enumeration | No | Attribute to display as label below the bar |
+
+**Note**: Label fields allow selecting which task/milestone attribute values to display at each position around the Gantt bar. The default display is the task name on the left.
+
+## Widgets Provided
+
+| Widget | Widget Kind | Description | Use Case |
+|--------|-------------|-------------|----------|
+| Task Class Preview | `cf.projektplanung.ganttTaskDemo` | Shows a live visual preview of how tasks and milestones will appear in Gantt charts based on their configured styling properties | Use when configuring Task Classes to see real-time feedback on colors, shapes, patterns, and label positions |
+
+## Usage Notes
+
+### When to Use This App
+
+- **Visual differentiation**: When you need to distinguish different categories of tasks (e.g., internal vs. external, critical vs. non-critical)
+- **Executive reporting**: When creating Presentation Graphics that require consistent color coding across schedules
+- **Multi-project environments**: When standardizing task visualization across multiple schedules
+
+### Common Patterns
+
+1. **Create task class pages** as children of the workspace root or a dedicated "Master Data" container page
+2. **Reference task classes from tasks/milestones** via a reference attribute (added by Project Planning Extended)
+3. **Configure Gantt widgets** to apply styling based on the referenced task class
+
+### Integration with Project Planning
+
+This app provides the **data type** for task classes. The actual **application of styling** to Gantt charts requires:
+- `cf.cplace.projektplanung.projektplanungBasic` or `cf.cplace.projektplanung.projektplanungExtended` for Gantt widgets
+- Tasks and Milestones must have a reference attribute pointing to Task Class (provided by the Extended app)
+
+### Example Task Class Setup
+
+A typical workspace might include task classes like:
+- **Critical Path** - Red bars with diamond milestones
+- **External Dependency** - Blue hatched bars
+- **Internal Work** - Green solid bars
+- **Review Gate** - Yellow triangle milestones
+
+## Investigation Metadata
+
+- **Investigation Date**: 2026-02-02
+- **Investigation Workspace**: `ac0ymd686n2lpg0quupvw122w`
+- **Pre-installed Apps**: `cf.cplace.platform`
+- **Types Added**: 1 (`cf.activityClass`)
+- **Widgets Added**: 1 (`cf.projektplanung.ganttTaskDemo`)

package/dist/plugins/core-app-catalog/cf.cplace.qrCodeWidget/README.md

@@ -0,0 +1,69 @@
+# QR Code (cf.cplace.qrCodeWidget)
+
+## Overview
+
+The QR Code app provides a widget that generates a QR code containing the URL of the embedding page. Users can scan this QR code with a mobile device to quickly access the page without manually typing the URL.
+
+The widget uses the ZXing (Zebra Crossing) library for QR code generation with high error correction (Level H) to ensure readability even when a custom logo is overlaid.
+
+## Dependencies
+
+- **cf.cplace.platform** (cplace Basis) - Base platform, always installed
+
+No additional apps are auto-installed with this app.
+
+## Types Provided
+
+This app does **not provide any types**. It is a widget-only app.
+
+## Widgets Provided
+
+| Widget | Widget Kind | Description | Use Case |
+|--------|-------------|-------------|----------|
+| QR Code | `cf.cplace.qrCodeWidget` | Creates a QR code from the URL of the embedding page | Mobile access, physical-digital integration, presentations |
+
+### Widget Configuration: cf.cplace.qrCodeWidget
+
+| Attribute | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `title` | localizedString | No | Widget title |
+| `height` | number | No | Widget height |
+| `cf.cplace.qrCodeWidget.widgetConfig.showFrame` | boolean | Yes | Show widget frame |
+| `cf.cplace.qrCodeWidget.widgetConfig.qrCodeSize` | number | Yes | Size of the QR code in pixels |
+| `cf.cplace.qrCodeWidget.widgetConfig.color` | color | Yes | Color of the QR code |
+| `cf.cplace.qrCodeWidget.widgetConfig.logo` | reference (default.file) | No | Logo file to display centered within the QR code |
+
+## Use Cases
+
+- **Mobile Access to Pages**: Enable quick access to cplace pages from mobile devices by scanning a QR code displayed on screen during presentations
+- **Physical-Digital Integration**: Print QR codes for display in physical spaces (offices, warehouses, production floors) to link physical assets or locations to their corresponding digital pages
+- **Meeting and Presentation Support**: Display QR codes during meetings so attendees can quickly access related pages without manually typing URLs
+- **Asset and Inventory Tracking**: Generate QR codes for equipment, inventory items, or project assets; print and attach codes to physical items for quick lookups
+- **Documentation and Reports**: Include QR codes in exported documents so readers can access the live, up-to-date page version
+
+## Usage Notes
+
+### When to Use
+- URLs are long or difficult to type
+- Users need mobile access to pages displayed on large screens
+- Physical items need links to their digital records
+- Quick touchless access is preferred
+
+### Visual Customization
+- **Size**: Adjustable for presentations (larger) or inline use (smaller)
+- **Color**: Customizable for branding purposes
+- **Logo**: Optional logo overlay for brand recognition
+- **Frame**: Configurable widget frame display
+
+### Error Correction
+The widget uses Level H (highest) error correction, allowing approximately 30% data recovery. This ensures the QR code remains scannable even with:
+- A centered logo overlay
+- Partial damage
+- Reduced print quality
+
+## Investigation Details
+
+- **Investigation Date**: 2026-02-02
+- **Investigation Workspace**: `[App Investigation] cf.cplace.qrCodeWidget` (ID: 9ax8x8lcp8ylosy7n63joxsor)
+- **Apps Installed After**: cf.cplace.platform, cf.cplace.qrCodeWidget
+- **Types Added**: None (widget-only app)

package/dist/plugins/core-app-catalog/cf.cplace.rest.config/README.md

@@ -0,0 +1,204 @@
+# REST-API Configuration (cf.cplace.rest.config)
+
+## Overview
+
+The REST-API Configuration app provides a no-code/low-code framework for exposing cplace entities as RESTful HTTP resources. Configuration is modeled entirely as cplace pages — Endpoint, Schema, Attribute, Conversion, and Resource entities form a hierarchical structure that maps cplace types and attributes to REST API paths and fields.
+
+**There are no UI widgets in this app.** It provides configuration types only; the REST endpoints are served by the companion dispatch plugin.
+
+## Dependencies
+
+- `cf.cplace.platform` (cplace Basis) — always pre-installed
+
+No additional apps are auto-installed with this app. The dispatch runtime (`cf.cplace.rest.dispatch`) is a separate plugin that must also be installed for endpoints to be reachable.
+
+## Types Provided
+
+### cf.cplace.rest.endpoint
+
+The top-level configuration entity. Each Endpoint page represents a distinct REST API base path.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Path Segment | `cf.cplace.rest.pathSegment` | String | Yes | No | URL path segment, e.g. "v1" |
+| Enabled | `cf.cplace.rest.enabled` | Boolean | No | No | Whether the endpoint is active (default: false) |
+| Production Mode | `cf.cplace.rest.productionMode` | Boolean | No | No | Restricts editing when enabled (default: false) |
+| Allowed Principals | `cf.cplace.rest.allowedPrincipals` | Multi Principal Ref | No | Yes | Access control (default: allusers) |
+| OAS Enabled | `cf.cplace.rest.oasEnabled` | Boolean | No | No | Enable OpenAPI spec generation (default: false) |
+| OAS Title | `cf.cplace.rest.oasTitle` | String | No | No | OpenAPI spec title |
+| OAS Description | `cf.cplace.rest.oasDescription` | String | No | No | OpenAPI spec description |
+| OAS Contact Name | `cf.cplace.rest.oasContactName` | String | No | No | OpenAPI contact name |
+| OAS Contact URL | `cf.cplace.rest.oasContactUrl` | String | No | No | OpenAPI contact URL |
+| OAS Contact Email | `cf.cplace.rest.oasContactEmail` | String | No | No | OpenAPI contact email |
+| OAS Document Version | `cf.cplace.rest.oasDocumentVersion` | String | No | No | OpenAPI spec version string |
+
+**Hierarchy**: Endpoint pages are the root of the REST configuration hierarchy. Schema and Resource pages are created as children.
+
+### cf.cplace.rest.schema
+
+Defines what kind of cplace entity is exposed through the REST API.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Entity Kind | `cf.cplace.rest.entityKind` | Dynamic String Enum | Yes | No | The type of cplace entity (see EntityKind values below) |
+| Custom Type | `cf.cplace.rest.customType` | Dynamic String Enum | No | No | Pin to a specific cplace type's internal name |
+| Endpoint | `cf.cplace.rest.endpoint` | Page Ref (Endpoint) | Yes | No | Parent endpoint (hierarchy) |
+
+**EntityKind enum values:**
+| Display | Internal Value | Notes |
+|---------|----------------|-------|
+| Workspace | `pageSpace` | Workspace entities |
+| Page | `page` | Standard cplace pages (most common) |
+| Document | `document` | File/document entities |
+| Group | `group` | User groups |
+| Script | `script` | Script entities |
+| Comment | `comment` | Comment entities |
+| Batch Job | `persistentJob` | Background jobs |
+| Sent Email | `sentEmail` | Email log entries |
+| System Group | `systemGroup` | System groups |
+| Person | `person` | User/person entities |
+
+**Hierarchy**: Schema pages are children of an Endpoint page. Attribute pages are children of Schema pages.
+
+### cf.cplace.rest.attribute
+
+Maps an internal cplace attribute to an external REST API field name.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Schema | `cf.cplace.rest.schema` | Page Ref (Schema) | Yes | No | Parent schema (hierarchy) |
+| Internal Attribute | `cf.cplace.rest.internalAttribute` | Dynamic String Enum | Yes | No | Internal attribute name (e.g. `cf.cplace.title`) |
+| External Name | `cf.cplace.rest.externalName` | String | Yes | No | Field name in the REST API response (camelCase) |
+| Is Queryable | `cf.cplace.rest.queryable` | Boolean | No | No | Allow filtering by this field (default: false) |
+| Is Key | `cf.cplace.rest.isKey` | Boolean | No | No | Use as entity identifier (default: false) |
+| Conversion Parameters | `cf.cplace.rest.conversionParameters` | Page Ref | No | No | Link to a conversion type page |
+
+**Hierarchy**: Attribute pages are children of a Schema page. Conversion pages are linked via `cf.cplace.rest.conversionParameters`.
+
+### cf.cplace.rest.resource
+
+Defines a specific REST resource path with allowed HTTP methods.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Endpoint | `cf.cplace.rest.endpoint` | Page Ref (Endpoint) | Yes | No | Parent endpoint (hierarchy) |
+| Path Segment | `cf.cplace.rest.pathSegment` | String | Yes | No | URL path segment, e.g. "projects" |
+| Method | `cf.cplace.rest.method` | Multi Enum | Yes | Yes | HTTP methods: GET_SINGLE, GET_MULTI, POST, PATCH, DELETE |
+| Search | `cf.cplace.rest.search` | Search constraint | Yes | No | Scopes which entities this resource can access |
+| Schema | `cf.cplace.rest.schema` | Page Ref (Schema) | No | No | Associated schema for this resource |
+| Enabled | `cf.cplace.rest.enabled` | Boolean | No | No | Whether this resource is active (default: true) |
+| File Method | `cf.cplace.rest.fileMethod` | Multi Enum | No | Yes | File HTTP methods: GET_FILE, POST_FILE, PATCH_FILE, DELETE_FILE |
+
+**RequestMethod enum values**: `GET_SINGLE`, `GET_MULTI`, `POST`, `PATCH`, `DELETE`
+
+**Hierarchy**: Resource pages are children of an Endpoint page.
+
+### cf.cplace.rest.referenceConversion
+
+Controls how reference attributes are serialized in the REST response.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Reference Schemas | `cf.cplace.rest.referenceSchemas` | Multi Page Ref (Schema) | No | Yes | Schemas defining the referenced entity structure |
+| Reference Strategy | `cf.cplace.rest.referenceStrategy` | Enum | No | No | ID, UID, NAME, or SCHEMA |
+
+**Use when**: The attribute is a page reference or multi-reference. Default strategy: `UID`.
+
+### cf.cplace.rest.enumConversion
+
+Controls how enum attributes are serialized.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Strategy | `cf.cplace.rest.strategy` | Enum | No | No | NAME or ALL_TRANSLATIONS |
+
+**Use when**: The attribute is an enum or dynamic enum. Default: `NAME`.
+
+### cf.cplace.rest.localizedStringConversion
+
+Controls how localized string attributes are serialized.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Strategy | `cf.cplace.rest.strategy` | String | No | No | Language code (e.g. "en") or "ALL_TRANSLATIONS" |
+
+**Use when**: The attribute is a localized string (multi-language text). Default: `ALL_TRANSLATIONS`.
+
+### cf.cplace.rest.changesetConversion
+
+Controls how changeset/history attributes are serialized.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Max Changes Size | `cf.cplace.rest.maxChangesSize` | Number | No | No | Maximum number of changes to include (default: 10) |
+
+**Use when**: The attribute tracks change history.
+
+### cf.cplace.rest.lowcodeConversion
+
+Allows custom JavaScript scripts to transform attribute values.
+
+| Attribute | Internal Name | Type | Required | Multiple | Description |
+|-----------|--------------|------|----------|----------|-------------|
+| Export Script | `cf.cplace.rest.exportScript` | Script | No | No | Script to transform value for GET responses |
+| Import Script | `cf.cplace.rest.importScript` | Script | No | No | Script to transform value for POST/PATCH requests |
+
+**Use when**: Standard conversions are insufficient and custom transformation logic is needed.
+
+## Entity Hierarchy and Creation Order
+
+The hierarchy determines page parent-child relationships and creation order:
+
+```
+Endpoint (cf.cplace.rest.endpoint)          ← create first
+  ├── Schema (cf.cplace.rest.schema)         ← create second (parent: Endpoint)
+  │     └── Attribute (cf.cplace.rest.attribute)  ← create third (parent: Schema)
+  │           └── Conversion (optional)      ← create fourth (linked via conversionParameters)
+  └── Resource (cf.cplace.rest.resource)     ← create last (parent: Endpoint, links Schema)
+```
+
+**Enable the Endpoint last** after all children are configured: update `cf.cplace.rest.enabled` = true.
+
+## URL Structure
+
+The dispatch plugin routes requests as:
+```
+/rest/{endpoint-pathSegment}/{resource-pathSegment}          — GET multi, POST
+/rest/{endpoint-pathSegment}/{resource-pathSegment}/{id}     — GET single, PATCH, DELETE
+/rest/{endpoint-pathSegment}/{resource-pathSegment}/bulk     — POST bulk, PATCH bulk
+```
+
+## Widgets Provided
+
+None. This app provides configuration types only.
+
+## Usage Notes
+
+### When to Select This App
+
+Select `cf.cplace.rest.config` when requirements mention:
+- "REST API", "REST endpoints", "external API access"
+- "integration", "third-party access", "API consumers"
+- "programmatic access", "API clients"
+- "expose data as API", "CRUD via API"
+
+### Common Patterns
+
+1. **Standard CRUD resource**: Expose a workspace type with GET_SINGLE, GET_MULTI, POST, PATCH, DELETE methods. Map important attributes, make name/title queryable, use referenceConversion(UID) for reference attributes.
+2. **Read-only resource**: Expose a type with GET_SINGLE, GET_MULTI only. Useful for lookup data or master data.
+3. **Workspace-scoped search**: Set resource search to filter by both type and workspace — ensures API users can only access the intended data.
+4. **Multiple schemas per endpoint**: Group logically related types under one endpoint path (e.g., "v1") with separate resource paths per type.
+
+### Integration with AI Builder
+
+- `building-blocks-plan` selects this app when requirements mention REST API, external access, or integrations
+- `workspace-setup` installs the app into the workspace
+- `rest-endpoint-plan` designs the endpoint structure (which types to expose, attribute mappings, methods)
+- `rest-endpoint-build` creates the configuration pages via `cplace_manage_page` in dependency order
+
+### Important Constraints
+
+- Always create entities in order: Endpoint → Schema → Attribute → Conversion → Resource
+- Enable the endpoint LAST (after all configuration is complete)
+- Leave `productionMode` = false during AI Builder sessions
+- The `cf.cplace.rest.search` attribute on Resource requires a serialized cplace search constraint