Skip to main content

Choosing an API

ApplicationsApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. can expose their data elementsData Element (DataElement). A fundamental data concept or entity within an application's domain, acting as an anthropomorphic translation of a real-life object or concept. to the web using an API. We have different APIs available for different use cases.

For UI applications​

The Standard API is a fully generated JAX-RS REST API exposing endpoints directly from JEE element models. No endpoint modelling required. Fully compatible with our Angular and Knockout frontends.

The Standard APIStandard API (stdAPI). A fully generated JAX-RS REST API expanding JSON:API compliant endpoints directly from JEE element models. is built for full-stack support. UI applicationsApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. use it to read and change data, so it covers the full feature set of the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution.: CRUD, findersFinderA search specification combining field-operator pairs to execute standard data queries on a DataElement., data commandsData Command (DataCommand). [Deprecated] A legacy mechanism used for data input and custom action execution on DataElements, replaced by DataOperations., query searchesQuery Search (QuerySearch). An advanced search mechanism using declarative constraints to build complex, multi-variable or cross-component queries. and data operationsData Operation (DataOperation). A type-safe action (e.g., Create, Update, Custom) executed on DataElement instances to modify data or trigger business logic..

The Standard APIStandard API (stdAPI). A fully generated JAX-RS REST API expanding JSON:API compliant endpoints directly from JEE element models. supersedes the Struts API. The Struts API is still maintained, but it no longer receives new features. For new applicationsApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution., use the Standard APIStandard API (stdAPI). A fully generated JAX-RS REST API expanding JSON:API compliant endpoints directly from JEE element models..

For external integrations​

The Service API is built for integrations with third-party systemsSystemA set of interconnected components that work together to achieve a specific purpose or function.. It is a fully generated JAX-RS REST API with an optional Swagger interface.

Because the Service API targets integrations instead of UIs, its feature set is smaller and more focused. It supports CRUD and query searchesQuery Search (QuerySearch). An advanced search mechanism using declarative constraints to build complex, multi-variable or cross-component queries..

Feature comparison​

The table below shows which features and integrations each API supports.

Standard APIStandard API (stdAPI). A fully generated JAX-RS REST API expanding JSON:API compliant endpoints directly from JEE element models.Struts APIService API
CRUD✅✅✅
FindersFinderA search specification combining field-operator pairs to execute standard data queries on a DataElement.✅✅
Data commandsData Command (DataCommand). [Deprecated] A legacy mechanism used for data input and custom action execution on DataElements, replaced by DataOperations.✅✅
QuerySearch✅✅
Data operationsData Operation (DataOperation). A type-safe action (e.g., Create, Update, Custom) executed on DataElement instances to modify data or trigger business logic.✅
Base components✅✅
Asset IO✅✅
Data access✅✅
Angular frontend✅✅
Knockout frontend✅✅