Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.88 KB

rest_api_v2_ex_query_get.adoc

File metadata and controls

40 lines (26 loc) · 1.88 KB
Raw

Выполнение JPQL-запроса (GET)

Перед выполнением запроса с помощью REST API необходимо описать его в конфигурационном файле. В корневом пакете модуля web (например, com.company.sales) необходимо создать файл rest-queries.xml. Затем этот файл объявляется в файле свойств приложения модуля web (web-app.properties):

cuba.rest.queriesConfig = +com/company/sales/rest-queries.xml

Содержимое файла rest-queries.xml:

link:../../../../source/rest/sales-rest-queries.xml[role=include]

Для выполнения JPQL запроса, необходимо выполнить GET http-запрос к REST API:

http://localhost:8080/app/rest/v2/queries/sales$Order/ordersAfterDate?startDate=2016-11-01&endDate=2017-11-01

Части URL:

  • sales$Order - имя извлекаемой сущности.

  • ordersAfterDate - имя запроса из конфигурационного файла.

  • startDate и endDate - параметры запроса со значениями.

OAuth-токен должен быть передан в заголовке запроса Authorization с типом Bearer.

Метод возвращает JSON-массив со списком извлеченных экземпляров сущности:

link:../../../../source/rest/rest-ordersAfterDate-query-response.json[role=include]

Список других возможных параметров для метода выполнения запросов можно посмотреть в {rest_swagger_url}[Swagger документации].