4.7.1. REST API Version 1

Tip

We recommend using the REST API Version 2 for new projects. Version 1 exists for backward compatibilty only.

The universal REST API of the platform enables loading and saving any entities defined in the application data model by sending simple HTTP requests. This provides easy way to integrate with a wide range of third-party applications – from the JavaScript code executed in the browser to arbitrary systems running on Java, .NET, PHP or any other platform.

Key API features:

  • Loading entity instances from the database by identifier or by JPQL query with parameters.

  • Saving new and modified instances, deleting instances.

  • Obtaining a description of the data model in HTML format.

  • Data representation in JSON and XML formats.

  • Middleware service calls.

  • User authentication.