Package io.goobi.viewer.api.rest.model

package io.goobi.viewer.api.rest.model

Shared data transfer objects and helper classes used across REST API versions, including generic request parameters, response wrappers, and user-facing model facades.

Related Packages

Package	Description
io.goobi.viewer.api.rest	Root package for the Goobi viewer REST API, containing shared infrastructure such as the abstract URL manager and sub-packages for bindings, filters, models, and versioned endpoints.
io.goobi.viewer.api.rest.model.index	Model classes representing Solr index field metadata exposed through the REST API, such as field information descriptors used for index inspection endpoints.
io.goobi.viewer.api.rest.model.monitoring	Model classes for the application health and monitoring REST endpoints, encapsulating the aggregated status information returned by monitoring checks.
io.goobi.viewer.api.rest.model.ner	Model classes for named-entity recognition (NER) results exposed through the REST API, representing tags, tag groups, page and document references, and aggregated tag counts.
io.goobi.viewer.api.rest.model.tasks	Model classes for asynchronous background task management in the REST API, representing task descriptors, parameters, and the central task manager.

Class	Description
CurrentUserResponse	Response object for GET /api/v1/users/current.
ErrorMessage	REST API response model that carries an HTTP status code, a human-readable error description, and an optional stack trace.
GenericList<T>	Thin wrapper around a Java List that serializes its contents directly as a JSON array via JsonValue.
IndexerDataRequestParameters	POST request parameters for IndexingResource (indexer version).
IResponseMessage	Common interface for REST API response message objects that carry a human-readable message string.
MediaDeliveryService	Service class that handles HTTP file delivery with support for byte-range requests, conditional caching headers (ETag, If-Modified-Since), and optional GZIP encoding for text content.
MediaResourceHelper	Helper class for serving media resources via the REST API, handling content-type detection, redirect decisions, and HTTP response header configuration based on viewer media-type settings.
PrerenderPdfsRequestParameters	Request parameters for the PRERENDER_PDF task, specifying the record identifier, an optional ContentServer configuration variant, and whether existing PDF files should be overwritten.
RecordsRequestParameters	POST request parameters for RecordsResource.
SitemapRequestParameters	POST request parameters for SitemapResource.
SuccessMessage	REST API response model indicating whether an operation succeeded, together with an optional human-readable result description.
ToolsRequestParameters	POST request parameters for RecordsResource.
UserJsonFacade	Simplified representation of a User object for json (de-)serialization.
ViewerPage	Simple template to create a json-representation of a viewer page, typically a CMS-Page.