Technical Documentation

This part is meant for developers/integrators using the Plone RestAPI.

Contents

• Banner
  • Overview
  • Content Type
    • Schema Fields
  • Configuration
    • Registry Configuration
  • REST API
    • GET @banner
  • Path Matching Logic
    • Path Normalization
  • Caching
    • Cache Tag Headers
    • Cache Invalidation
  • Integration Guide
    • Fetching Banners via REST API
  • File Locations
• Book and Library
  • Overview
  • Content Types
    • Library
    • Book
    • Chapter
    • Paragraph
  • Table of Contents
    • Number Generation
    • TOC Visibility
    • Catalog Index
  • REST API
    • Enhanced Serialization
    • GET @book-toc
    • GET @book-keywords
    • GET @book-keyword-search
    • GET @contextnavigation
    • POST @ask-book-owner
  • PDF Export
    • Configuration
    • PDF Server Endpoints
    • WeasyPrint Views
    • Custom CSS
  • User Access Management
    • Book Owner Behavior
    • Registration Form
    • Request Book Access
    • Approve Access
    • Email URL Configuration
    • Email Templates
    • PDF Views
  • Ask Book Owner
    • Browser View
    • REST API
    • Prerequisites
  • AI Ask (RAG) Configuration
    • Prerequisites
    • Permissions
    • REST API
    • Asking Questions
  • Integration Guide
    • Querying TOC Structure
  • File Locations
• Document Date
  • Overview
  • REST API
    • Reading the Document Date
    • Querying Files by Date
• Empty Trash
  • Overview
  • Usage
  • Scheduling with Cron
  • Logging
  • File Locations
• Exclude Items by Default
  • Overview
  • REST API
    • Default Response (items excluded)
    • Force Including Items
  • Configuration
• ImageReferenceField
  • Field Types
  • REST API Serialization
    • Single Image Reference (GET)
    • Multiple Image References (GET)
  • REST API Deserialization
    • Creating/Updating Content (POST/PATCH)
  • Visibility Filtering
  • Schema Definition
    • Basic Usage
    • With Widget Configuration
• JSON Schema Widget
  • Schema Structure
    • Minimal Schema
    • Schema with Metadata
    • Stored Data Format
  • Supported Field Formats
    • Text (default)
    • Date
    • Time
    • Select (Dropdown / Multi-select)
    • Link
  • Limiting the Number of Entries (maxItems)
  • Default Values
  • Configuration
    • FTI XML (model_source)
    • Python (Interface definition)
  • REST API Serialization
  • Complete Example: Social Links with Icon and maxItems
• Keycloak Integration
  • Architecture Overview
  • Configuration
    • Plugin Connection Settings
    • Keycloak Client Setup
  • KeycloakPlugin (PAS Plugin)
    • Installation
    • Plugin Properties
    • User Enumeration
    • User Creation
  • Group Synchronization
    • Sync Behavior
    • Sync Operations
    • Manual Sync View
    • Login Event Handler
  • KeycloakAdminClient API
    • Initialization
    • User Operations
    • Group Operations
    • Exception Handling
  • OIDC Authentication
    • Registry Settings
    • Custom Callback
  • Testing
    • Test Files
  • Troubleshooting
    • Common Issues
    • Logging
• Public PDF API
  • Configuration
  • Authentication
  • Endpoints
    • POST @pdfserver-pub-convert
    • GET @pdfserver-pub-status
    • GET @pdfserver-pub-download
  • File Locations
• RAG (Retrieval-Augmented Generation)
  • Glossary
  • Architecture
  • Components
    • REST API Endpoints
    • Modules
  • Configuration
    • Environment Variables
    • Plone Registry
  • Elasticsearch Index
  • Data Flow
    • Indexing (Async via Worker)
    • Question-Answering (Async via Worker)
  • Local Development
  • REST API
    • Ask a Question (Async)
    • Ask a Question (Sync)
    • Path Filtering
    • Reindex All Content
    • Index Single Content
    • Check Status
• Responsible Unit
  • Overview
  • Schema Fields
  • Inheritance Logic
  • REST API
    • GET @responsible
    • GET @responsible-backreferences
  • Back-References Viewlet
  • Caching
    • Cache Tag Headers
  • Integration Guide
    • Fetching the Responsible Unit
    • Fetching Back-References
  • File Locations
• Restapi
  • Breadcrumbs
  • File GET
  • Navigation
    • SubTopic Navigation
  • Enhanced Field Serialization
    • File Fields with Download URLs
    • Link Fields Resolution
  • Staging Folder Serialization
    • Working Copy with Baseline Items
  • EasyForm Integration
    • Form Schema Serialization
    • Form Submission
  • Workflow Management
    • Direct State Setting
  • Principals Search
    • Enhanced User/Group Search
  • Navigation Root
    • Navigation Root with Expansion Control
  • Relations
    • Enhanced Relations with Trash Filtering
• Elasticsearch Integration (RESTAPI)
  • Enhanced Search with Aggregations
  • Popular Searches
  • Raw Elasticsearch Queries
  • German Text Analysis
  • Domain-based API Search Filter
  • Configuration via Registry