Фильтры

Фильтры помогают получить только нужные строки, например заявки со статусом «Новая» или договоры, которые истекают в этом месяце. В API работают те же фильтры, что и в представлениях таблицы. Какие из них подходят конкретному полю, написано рядом с полем в документации API базы.

Есть два способа передать фильтр в запрос списка строк.

Дерево filters

Параметр filters принимает JSON. Внутри filter_type (AND или OR) и массив filters. У условия есть field, type и value.

С названиями полей (user_field_names):

{"filter_type":"AND","filters":[{"field":"Name","type":"equal","value":"test"}]}

Без названий, по ID поля:

{"filter_type":"AND","filters":[{"field":1,"type":"equal","value":"test"}]}

Если filters передан, параметры filter__{field}__{filter} и filter_type игнорируются.

Короткий фильтр

Формат: filter__{field}__{filter}=значение.

С названием поля: filter__Name__equal=test. Если поля с таким названием нет, поиск идёт по field_id.

Без названий: filter__field_1__equal=test.

filter_type задаёт связь нескольких коротких фильтров. По умолчанию AND: строка должна подойти под все. OR: достаточно одного. Параметр работает, когда фильтров два или больше.

Типы фильтров

В документации базы часть старых фильтров дат помечена как устаревшие. Для новых запросов их не используйте. Ниже типы, которые в справочнике не помечены как устаревшие.

Пример UTC??today и числа в колонке «Пример значения» взяты из документации базы: это образцы, а не обязательный формат для каждого поля.