causeway
Quick Start
Starter Apps Hello World Simple App
Learning & Tutorials Reference App Petclinic
Resources Cheatsheet Icons
Guides
Core User Guide Reference Guide Testing Guide Security Guide
For use in apps Value Types
Development Setup Guide Contributors' Guide
Components
Security Bypass Simple Spring Keycloak
Viewers Web UI (Wicket) GraphQL API REST API (Restful Objects)
Persistence JPA (EclipseLink)
Extensions
Core Command Log Doc Gen Execution Log Execution Outbox Execution Republisher Excel Flyway Layout Loaders Title Cache
Security Secman Audit Trail Spring OAuth2 Integration Session Log
Web UI (Wicket) Full Calendar pdf.js Server Side Events Tabular Download
REST API (Restful Objects) CORS
Persistence QueryDSL
Support
Contact Slack Mailing Lists JIRA Stack Overflow
Releases Downloads Release Notes
Framework
Process Committers' Guide Tooling
Automated Analysis SonarCloud.io
Interim Builds Nightly builds Weekly builds Website Preview (not ASF hosted)
Development Internal Design Docs Regression Tests Incubator
Thanks Acknowledgements
ASF
Apache Homepage Events License Security Privacy Sponsorship Thanks
PMC board minutes

Reference Guide

    • Domain Services
      • AcceptHeaderService
      • ApplicationFeatureMenu
      • ApplicationFeatureRepository
      • BookmarkService
      • BookmarkUiService
      • ClockService
      • CommandDtoProcessorService
      • CommandExecutorService
      • CommandSubscriber
        • CommandLogger
      • ConfigurationMenu
      • ConfigurationViewService
      • ContentMappingService
        • ContentMappingServiceForCommandDto
        • ContentMappingServiceForCommandsDto
      • DeepLinkService
      • EmailNotificationService
      • EmailService
      • EntityChangesSubscriber
        • EntityChangesLogger
      • EntityPropertyChangeSubscriber
        • EntityPropertyChangeLogger
      • ExecutionSubscriber
        • ExecutionLogger
      • ErrorReportingService
      • EventBusService
      • ExceptionRecognizerService
      • FactoryService
      • GridLoaderService
      • GridService
      • GridSystemService
      • HealthCheckService
      • HintIdProvider
      • HintStore
      • HomePageResolverService
      • IdStringifier
      • ImpersonateMenu
      • ImpersonateMenuAdvisor
      • InteractionProvider
      • InteractionLayerTracker
      • InteractionService
      • JaxbService
      • LayoutService
      • LayoutServiceMenu
      • LanguageProvider
      • LocaleChoiceProvider
      • MenuBarsLoaderService
      • MenuBarsService
      • MessageService
      • MetaModelService
      • MetaModelServiceMenu
      • MetricsService
      • QueryResultsCache
      • RepositoryService
      • RoutingService
      • Scratchpad
      • ServiceInjector
      • ServiceRegistry
      • SessionSubscriber
      • SitemapService
      • SitemapServiceMenu
      • SudoService
      • SwaggerService
      • TableColumnOrderService
      • TableColumnVisibilityService
      • TitleService
      • TranslationService
      • TranslationsResolver
      • TransactionProcessor
      • TransactionService
      • UrlEncodingService
      • UserMenu
      • UserRegistrationService
      • UserService
      • WrapperFactory
      • XmlService
      • XmlSnapshotService
      • Core Transaction
        • EntityChangeTracker
        • EntityChangesPublisher
      • Viewer Common Applib
        • UserProfileUiService
      • Persistence JPA Applib
        • JpaSupportService
      • Persistence QueryDsl Applib
        • AutoCompleteGeneratedQueryService
        • QueryDslRepository
        • DetachedQueryFactory
        • QueryDslSupport
    • Annotations
      • @Action
      • @ActionLayout
      • @Collection
      • @CollectionLayout
      • @DomainObject
      • @DomainObjectLayout
      • @DomainService
      • @DomainServiceLayout
      • @Parameter
      • @ParameterLayout
      • @Property
      • @PropertyLayout
      • Other Causeway Annotations
        • @HomePage
        • @Title
        • @MinLength
        • include/exclude
          • @Domain.Include
          • @Domain.Exclude
          • @MemberSupport
          • @ObjectSupport
          • @ObjectLifecycle
          • @Programmatic
        • architecture
          • @Module
          • @InteractionScope
        • custom value type support
          • @Value
          • @ValueSemantics
      • Java EE Annotations
        • @Digits
        • @Nullable
        • @Pattern
      • JAXB
        • @XmlJavaTypeAdapter
        • @XmlRootElement
      • JPA
        • @Entity
        • @Table
        • @Transient
        • @Column
    • Methods
      • Supporting Methods
      • UI Hint Methods
      • Lifecycle Methods
    • Classes
      • Events
      • Non-persisted objects
        • ViewModel
      • Layout
      • Value Types
        • Blob
        • Clob
        • Markup
        • LocalResourcePath
        • Password
      • Utility Classes
        • Enums
        • ObjectContracts
        • Reasons
        • ReasonBuffer
        • ReasonBuffer2
        • TitleBuffer
      • Mixees and Mixins
        • Object_downloadLayout
        • Object_downloadMetamodelXml
        • Object_rebuildMetamodel
        • Object_logicalTypeName
        • Object_objectIdentifier
        • Object_clearHints
        • Object_openRestApi
        • Dto_downloadXml
        • Dto_downloadXsd
        • Command Log
          • Object_recentCommands
          • HasInteraction_commandLogEntry
          • HasUsername_recentCommandsByUser
        • Execution Log
          • Object_recentExecutions
          • HasInteractionId_executionLogEntries
        • HasTarget_openTargetObject
      • Specification pattern
    • Configuration
      • Applib
      • Core Configuration
      • Core MetaModel
      • Core MetaModel Introspection
      • Core MetaModel Validator
      • Core Runtime
      • Core Runtime Services
      • Core Persistence Schema
      • Core Persistence Commons
      • Prototyping
      • Keycloak Security Implementation
      • Spring Security Implementation
      • Common Config for Viewers
      • GraphQL API
      • REST API (Restful Objects Viewer)
      • Wicket Viewer
      • Eclipselink Configuration
      • Extensions
      • Value types
      • Testing
      • Other
    • Schema
      • MetaModel
      • Command
      • Interaction
      • Changes
      • Common
Reference Guide 3.5.0
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Committers' Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Contributors' Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Design Docs
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Extensions
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • GraphQL Viewer
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Incubator Catalog
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • JDO/DataNucleus
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • JPA
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • QueryDSL
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
  • Reference Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • regressiontests
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Release Notes
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • REST API (Restful Objects Viewer)
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Security Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Setup Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Testing Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Tutorials
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • User Guide
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Value Types Catalog
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
  • Web UI (Wicket Viewer)
    • 4.0.0-M1
    • 3.5.0
    • 3.4.0
    • 3.3.0
    • 3.2.0
    • 3.1.0
    • 3.0.0
    • 2.1.0
    • 2.0.0
4.0.0-M1 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.1.0 2.0.0
Edit

Implementation

The REST API (Restful Objects) provides an implementation of the service, SwaggerServiceDefault.

On this page

Copyright © 2010~2024 The Apache Software Foundation, licensed under the Apache License, v2.0.
Apache, the Apache feather logo, Apache Causeway, and the Apache Causeway project logo are all trademarks of The Apache Software Foundation.

Revision: build-website.20251118-0002