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

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

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

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

Например: client.passport.seria - позволяет получить серию паспорта клиента, от которого оформлена заявка.

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

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

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

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

"orderByFields": [
     { "field": "creationDate" },
     { "field": "id", "direction": "desc" }
    ]

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

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

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

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

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

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

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

Например: client.passport.seria - позволяет получить серию паспорта клиента, от которого оформлена заявка.

Значение для фильтрации. 

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

Для указания значений этого параметра можно использовать следующие операторы: %, 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": "client.id",
           "value": "123"
       },

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

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

      {
           "field": "creationDate",
           "value": "<=2017-09-01 00:00:00"
       }

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

Пример 1: 

      {
           "field": "sex.id",
           "value": "101251"
       },

      {
           "field": "lastName",
           "value": "Иван%",
           "ornumber": "1",
       },

     {
           "field": "firstName",
           "value": "Иван%",
           "ornumber": "1",
       },
 В этом примере будут искаться все записи, у которых в поле sex.id указано 101251 и при этом одновременно
выполняется одно из условий поле firtsName начинается с Иван или поле lastName начинается с Иван.
То есть, в выражении языка SQL : sex.id = 10134756 AND (lastName like "Иван%" OR firstName like "Иван%")

Пример 2: 

      {
           "field": "lastName",
           "value": "Иван%",
           "ornumber": "1",
       },

     {
           "field": "firstName",
           "value": "Иван%",
           "ornumber": "1",
       },

    {
           "field": "maritalStatus.id",
           "value": "101151",
           "ornumber": "2",
       },

     {
           "field": "maritalStatus.id",
           "value": "101152",
           "ornumber": "2",
       },

 В  выражении языка SQL : (lastName like "Иван%" OR firstName like "Иван%" ) AND (maritalStatus.id = 101151 OR maritalStatus.id = 101152)