REST API Query Designer

The REST query designer allows you to define a named JPQL query that can be executed via REST API.

Name is the query name which will be specified in REST requests to execute the query.

View is the entity view for fetching instances.

Configuration file is a path to the configuration file where this query is defined. A project can have multiple configuration files specified in the cuba.rest.queriesConfig application property. In this case, you can choose a file to store the current query definition.

JPQL query is a query to execute. It must return entities, scalar expressions are not supported.

Parameters - names and types of query parameters.