В качестве элементов списка могут быть указаны любые поля из  группового соглашения, которые не являются внешними ключами.

Например: "name", "date" и так далее. 

Признаком внешнего ключа является указание в описание параметра на метод, который позволяет по ID (по значению параметра - получить объект). Пример: groupId.

Для полей, которые являются внешними ключами - возможно получение любых полей объекта, ID котрого указано в поле. Например: в объекте групповое соглашение есть поле groupId, которое является внешним ключом. Это значит, что мы можем запросить любое поле объекта группы клиентов: group.id, group.creationDate и так далее. 

Направление сортировки результатов поиска

• DESC - по убыванию
• ASC - по позрастанию

С релиза 2.0.0-65 для направления сортировки следует передавать направление в коллекции orderByFields.

Массив полей, по которым происходит сортировка.

"orderByFields": [
     { "field": "date" },
     { "field": "name", "direction": "desc" }
    ]

В этом примере сортировка происходит по полям date и name. Также результат сортируется по убыванию. Для направления сортировки используется параметр name. Если поле direction не указан, то сортировка по полю выполняется по возрастанию. Если в запросе на ядро переданы оба способа сортировки, то старый способ задания сортировки игнорируется. Эти изменения действуют с релиза 2.0.0-65. Смотрите также описание параметров orderBy и orderDirection.

Условия поиска (фильтрации) групповых соглашений, наличие параметра searchFields является обязательным, однако это может быть пустая коллекция (условия поиска могут быть не заданы). Строго рекомендуется задавать параметры фильтрации. 

Название поля, по которому нужно сделать фильтрацию. Правила формирования этого поля следующие: 

В качестве элементов списка могут быть указаны любые поля из сущности групповые соглашения, которые не являются внешними ключами.

Например: "name", "date" и так далее. 

Признаком внешнего ключа является указание в описание параметра на метод, который позволяет по ID (по значению параметра - получить объект). Пример: groupId.

Для полей, которые являются внешними ключами - возможно получение любых полей объекта, ID котрого указано в поле. Например: в объекте групповые соглашения есть поле groupId, которое является внешним ключом. Это значит, что мы можем запросить любое поле объекта группы клиентов: group.id, group.creationDate и так далее. 

В значении параметра может указывается как точное значение, так и нет. Для значений не полного соответствия используются различные параметры.

Для указания значений этого параметра можно использовать следующие операторы: %, like, !=, null, not null, >, <, >=, <=.

Для передачи даты используется следующий формат YYYY-MM-DD (действует с 2.0.0-65 релиза) например 2018-05-25, а для передачи даты и времени YYYY-MM-DD hh:mm:ss (например 2018-05-25 12:22:35).

Пример: 

      {
           "field": "group.id",
           "value": "123"
       },

Так и условия строгого и нестрогого неравенства, например: 

      {
           "field": "group.creationDate",
           "value": ">=2017-09-01"
       },

      {
           "field": "group.creationDate",
           "value": "<=2017-09-01"
       } ​

Значение для группировки параметров поиска (фильтрации) в условии OR.
Поле не обязательное и используется в случаях когда нужно искать по условиям как с логической "И", но также и по условиям с логической "ИЛИ".
Например, нужно найти все записи у которых в поле1 указано значение XXXX, при этом в поле2 указано YYYY или ZZZZ.
В этом случае можно использовать поле ornumber. Значение может быть числом или символом, но уникальным в рамках одной группы условий ИЛИ. Зарезервированным значением является  -1

Пример 1: 

      {
           "field": "group.id",
           "value": "123"
       },

      {
           "field": "id",
           "value": "321",
           "ornumber": "1",
       },

     {
           "field": "id",
           "value": "654",
           "ornumber": "1"
       }
 В этом примере будут искаться все записи, у которых в поле group.id указано 123 и при этом одновременно выполняется одно из условий поле id равно ​321 или поле id равно 654.
То есть, в выражении языка SQL : group.id = 123 AND (id = 321 OR id = 654)

Пример 2 (используют поля не из объекта "групповое соглашение"): 

      {
           "field": "name",
           "value": "1%",
           "ornumber": "1",
       },

     {
           "field": "name",
           "value": "5%",
           "ornumber": "1",
       },

    {
           "field": "loanAmount",
           "value": "10000",
           "ornumber": "2",
       },

     {
           "field": "loanAmount",
           "value": "20000",
           "ornumber": "2",
       }

 В  выражении языка SQL : (name like "1%" OR name like "5%" ) AND (loanAmount = 10000 OR loanAmount = 20000)