-
Notifications
You must be signed in to change notification settings - Fork 7
Home
Konstantin Krivopustov edited this page May 8, 2019
·
7 revisions
The universal REST API provides the following functionality:
- CRUD operations on entities.
- Execution of predefined JPQL queries.
- Execution of service methods.
- Getting metadata (entities, views, enumerations, datatypes).
- Getting current user permissions (access to entities, attributes, specific permissions).
- Getting current user information (name, language, time zone, etc.).
- Uploading and downloading files.
REST API uses the OAuth2 protocol for authentication and supports anonymous access.
The detailed documentation of the API endpoints: http://files.cuba-platform.com/swagger/7.0.
The Using REST API section contains a lot of examples demonstrating REST API features in action. Below we provide a formal description of some features and configuration options.
- Home
- Predefined JPQL Queries Configuration
- Services Configuration
- Data Model Versioning
- CORS Settings
- Anonymous Access
- Other REST API Settings
- Creating Custom OAuth2 Protected Controllers
- Security Constraints for Collection Attributes
- Persistent Token Store
- Project-specific Swagger Documentation
- Application Properties
-
Using REST API
- Getting an OAuth Token
- REST API Authentication with LDAP
- Custom Authentication
- Getting an Entity Instances List
- New Entity Instance Creation
- Existing Entity Instance Update
- Executing a JPQL Query (GET)
- Executing a JPQL Query (POST)
- Service Method Invocation (GET)
- Service Method Invocation (POST)
- Files Downloading
- Files Uploading
- JavaScript Usage Example
- Getting Localized Messages
- Data Model Versioning Example
- Using Entities Search Filter