37 results for: REST

The Framework > Platform Features > REST API Version 2 > Other REST API Settings
4.8.2.5. Other REST API Settings cuba.rest.client.id - defines a default REST API client...
... Other REST API Settings cuba.rest.client.id - defines a default REST API client id. cuba.rest.client.secret - defines a default REST API...
... REST API client id. cuba.rest.client.secret - defines a default REST API client secret. cuba.rest.client.tokenExpirationTimeSec - defines...
... - defines a maximum file size that can be uploaded with the REST API.
The Framework > Platform Features > REST API Version 1
4.8.1. REST API Version 1 Tip We recommend using the REST API Version 2 for new...
4.8.1. REST API Version 1 Tip We recommend using the REST API Version 2 for new projects. Version 1 exists for backward...
... Version 1 exists for backward compatibilty only. The universal REST API of the platform enables loading and saving any entities defined...
The Framework > Platform Features > REST API Version 2
4.8.2. REST API Version 2 Version 2 of the universal REST API provides the...
4.8.2. REST API Version 2 Version 2 of the universal REST API provides the following functionality: CRUD operations on...
... (name, language, time zone, etc.). Uploading and downloading files. REST API Version 2 uses the OAuth2 protocol for authentication and...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples
4.8.2.8. REST API Usage Examples This section contains REST API usage examples. As...
4.8.2.8. REST API Usage Examples This section contains REST API usage examples. As mentioned earlier, a detailed information...
... usage examples. As mentioned earlier, a detailed information about REST API methods is written according to Swagger specification and is...
The Framework > Platform Features > Dynamic Attributes > Dynamic Attributes in REST API
4.8.5.3. Dynamic Attributes in REST API REST API supports loading and saving dynamic attributes. In order...
4.8.5.3. Dynamic Attributes in REST API REST API supports loading and saving dynamic attributes. In order to load...
... same way as regular attributes, except for the preceding + symbol. REST API also saves dynamic attributes passed to commit.
Appendix B: Application Properties
... cuba.rest.productionMode Activates the REST API production mode that does not return exception text to client....
... Web Client and Web Portal block. cuba.rest.apiVersion Defines the REST API version. If the value is set to 1, the REST API of the platform...
... Defines the REST API version. If the value is set to 1, the REST API of the platform versions before 5.4 is used. Setting the value to...
... versions before 5.4 is used. Setting the value to 2 enables the new REST API version with support for service calls. Default value: 2...
... and Web Portal block. cuba.restApiUrl URL to the application’s REST API. Default value: http://localhost:8080/app-portal/api Stored in...
... a file that contains a list of services available for application REST API calls. The file is loaded using the Resources interface, so it...
... Defines a comma-separated list of origins that can access the REST API Version 2. Default value: * Used in the Web Client and Web Portal...
... cuba.rest.anonymousEnabled Enables an anonymous access to the REST API Version 2 endpoints. Default value: false Used in the Web Client...
... Web Portal blocks. cuba.rest.client.id Defines an identifier of the REST API client. Client in this case is not a platform user, but an...
... user, but an application (some web portal or mobile app) that uses REST API Version 2. Client credentials are used for basic authentication...
And 8 more
The Framework > Platform Features > REST API Version 1 > Including in a Project
4.8.1.1. Including in a Project REST API is included as a dependency to the web and portal modules of the...
... modules of the cuba application component. For the web module the REST API functions will be available by default at the...
... link on the Project properties navigator panel. After that, the REST API functions will be available at the {host:port}/app-portal/api...
... functions will be available at the {host:port}/app-portal/api URL. REST API controllers are registered in the Spring context defined by the...
The Framework > Common Components > Bean Validation > Running Validation
... standard bean validation does. It can be particularly relevant for REST API clients. Validation in REST API Universal REST API automatically...
... It can be particularly relevant for REST API clients. Validation in REST API Universal REST API automatically performs bean validation for...
... relevant for REST API clients. Validation in REST API Universal REST API automatically performs bean validation for create and update...
The Framework > Platform Features > REST API Version 1 > CORS Settings
4.8.1.3. CORS Settings By default, all CORS requests to the REST API are allowed. To restrict the origins list you can define a global...
... a global CORS configuration in the Spring configuration file. If the REST API is attached to the portal module then modify the...
... portal module then modify the portal-dispatcher-spring.xml, if the REST API is included in the web module then modify the web-spring.xml....
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > Getting an OAuth Token
4.8.2.8.1. Getting an OAuth Token An OAuth token is required for any REST API method (except when you are using an anonymous access). A token...
... An access to this endpoint is protected with a basic authentication. REST API client identifier and password is used for basic authentication....
... note that these are not an application user login and password. REST API client id and password are defined in the application properties...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > Service Method Invocation (POST)
4.8.2.8.7. Service Method Invocation (POST) REST API allows execution not only of methods that have arguments of...
... arguments list and returns a POJO. Before the invocation with the REST API the method must be allowed, so we add a record to the...
... must be placed to the Authorization header with the Bearer type. The REST API method returns a serialized POJO: { "success": false,...
The Framework > Portal Components
... of the client block to work with Middleware. Besides, the universal REST API, included to the portal module as a dependency, is turned on by...
... requests to Spring MVC controllers, for both the web interface and REST API. The set of Spring context configuration files is defined by the...
The Framework > Platform Features > REST API Version 1 > Describing Functions
4.8.1.2. Describing Functions Here we suppose that you use REST API included in the portal module, so all requests have the URL...
... have the URL starting with {host:port}/app-portal/api. If you use REST API in web module, the URL should start with...
The Framework > Platform Features > REST API Version 2 > Creating Custom OAuth2 Protected Controllers
... Custom OAuth2 Protected Controllers If you need to create a custom REST controller protected with the OAuth2 authentication then you have to...
... then you have to do the following: Suppose you have the following REST controller: package com.company.test.portal.myapi; import...
The Framework > Platform Features > REST API Version 2 > Security Constraints for Collection Attributes
... for Collection Attributes If an entity that is returned by the REST API has a collection attribute and entities in the collection are...
... may be returned in the result JSON. When you send such entity to REST API methods for update you have to specify the __securityToken...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > New Entity Instance Creation
... } The items collection property is annotated with the @Composition. REST API methods for entity creation and update will create a new entity...
... reference doesn’t have a @Composition annotation, that’s why the REST API will try to find a client with the given id and set it to the...
Security Subsystem > Security Subsystem Components > Permissions
... permissions affect the behavior of the client blocks and the REST API. The permissions are not checked when working with data on the...
... are only checked in the data aware visual components and the REST API. To check the entity attribute permission in the application...
Introduction > Overview
... deployment ensures scalability and failover, while a generic REST API enables easy integration with other systems.
The Framework > Architecture > Application Tiers and Blocks
... on Google Polymer framework and communicates with the middleware via REST API running either in Web Client or in Web Portal blocks. See Polymer...
The Framework > Common Components > Metadata Framework > Datatype
... locale – in system mechanisms, for example, serialization in REST API. Parsing formats ignoring locale are specified in the above...
The Framework > Common Components > Bean Validation
... uniform validation of data on the middleware, in Generic UI and REST API. It is based on the JSR 349 - Bean Validation 1.1 and its...
The Framework > Common Components > Bean Validation > Defining Constraints
... the following constraint groups: RestApiChecks - when validating in REST API. ServiceParametersChecks - when validating service parameters....
The Framework > Middleware Components > Data Stores
... example, with a non-relational database or an external system having REST interface. In any CUBA application, there is always the main data...
The Framework > Polymer User Interface
... components for working with the middleware through the standard CUBA REST API. The components are described below. CUBA Studio enables easy...
The Framework > Polymer User Interface > Polymer UI in Studio
... will contain an application stub that is able to connect to the REST API and login/logout user to the middleware. After creating the...
The Framework > Polymer User Interface > Build System and Project Structure > Using Native Polymer Tools
... will be available at http://localhost:8081 and it will work with the REST API running at http://localhost:8080/app/rest/.
The Framework > Polymer User Interface > CUBA Web Components > Initialization
... element you need to initialize common library and connection to the REST API using cuba-app element : <cuba-app...
The Framework > Polymer User Interface > CUBA Web Components > Working With Data
... } Tip You should enable anonymous access in the REST API if you want to use the examples above without forcing users to...
The Framework > Platform Features > REST API Version 1 > Describing Functions > Login
... 200 or status 401 if the authentication fails. To login through REST API, the user must have cuba.restApi.enabled specific permission....
The Framework > Platform Features > REST API Version 1 > Describing Functions > Service Calls
... file is defined by the cuba.restServicesConfig property. A sample REST API services configuration file: <services...
The Framework > Platform Features > REST API Version 2 > Services Configuration
... Configuration The list of service methods that are available via the REST API must be configured in the CUBA application in files registered in...
The Framework > Platform Features > REST API Version 2 > CORS Settings
4.8.2.3. CORS Settings By default, all CORS requests to the REST API are allowed. To restrict the origins list you can define the...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > Executing a JPQL Query
4.8.2.8.5. Executing a JPQL Query Before the execution with the REST API a query must be described in the configuration file. The...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > Service Method Invocation (GET)
... tx.commit(); } return orderPrice; } } Before the execution with the REST API a service method invocation must be allowed in the configuration...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > JavaScript Usage Example
... JavaScript Usage Example This section contains an example of using REST API v2 from JavaScript running on a HTML page. The page initially...
The Framework > Platform Features > REST API Version 2 > REST API Usage Examples > Getting Localized Messages
4.8.2.8.10. Getting Localized Messages There are methods in the REST API for getting localized messages for entities, their properties and...
Appendix A: Configuration Files > A.dispatcher-spring.xml
... for files uploading and downloading. The latter supports the REST API controllers. If you have created Spring MVC controllers in your...