Модификаторы параметров API запроса¶
При выполнении фильтрации записей на стороне сервера по умолчанию применяется оператор равенства. Для использования других операторов доступны модификаторы. Модификатор добавляется к имени параметра после двойного подчеркивания «__».
Поддерживаемые модификаторы:
| Модификатор | Описание |
|---|---|
eq |
Точное совпадение. |
noteq |
Отрицание модификатора eq. |
contains |
Регистронезависимая проверка на вхождение подстроки в строку. |
notcontains |
Отрицание модификатора contains. |
in |
Проверка на вхождение в список значений. Для указания в URL нужно передать несколько значений. Например: /?name_in=user&name_in=admin. |
notin |
Отрицание модификатора in. |
gt |
Больше, чем. |
gte |
Больше, чем или равно. |
lt |
Меньше, чем. |
lte |
Меньше, чем или равно |
startswith |
Регистронезависимая проверка, начинается ли поле с указанного значения. |
notstartswith |
Отрицание модификатора startswith. |
endswith |
Регистронезависимая проверка, оканчивается ли поле указанным значением. |
notendswith |
Отрицание модификатора endswith. |
year |
Проверка года для полей типа DateTime. |
month |
Проверка месяца для полей типа DateTime. |
day |
Проверка дня месяца для полей типа DateTime. |
Примеры использования модификаторов:
http://controller:9360/v1/journal/?domain_id=default&object_type__in=server&object_type__in=server
http://controller:9360/v1/journal/?domain_id__not_eq=default&user_name__startswith=user
http://controller:9360/v1/journal/?request_id__notstartswith=req
http://controller:9360/v1/journal/?event_time__year=2018