REST API: Сложные фильтры аналитик: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) (Новая страница: «{{#seo: |title=REST API: Сложные фильтры аналитик |titlemode=append |keywords=планфикс, фильтры аналитик, апи, api…») |
Artem (обсуждение | вклад) Нет описания правки |
||
Строка 50: | Строка 50: | ||
|- | |- | ||
|3101 || Пользовательское поле типа «Дата» | |3101 || Пользовательское поле типа «Дата» | ||
| | |||
*equal | *equal | ||
*notequal | *notequal | ||
*gt | *gt | ||
*lt | *lt | ||
| | |||
Объект : | Объект : | ||
<pre> | <pre> |
Версия от 08:10, 30 ноября 2022
Сложные фильтры в REST API ПланФикса применяются в методе «/datatag/{id}/entry/list» при получении записей аналитики. Фильтры аналитик задаются следующим набором параметров:
- type — числовой идентификатор фильтра.
- operator — оператор фильтра, одно из значений списка (equal, notequal, gt, lt). У разных фильтров могут быть разные допустимые операторы.
- value — значение фильтра, в зависимости от типа фильтра может быть строкой, числом или сложным объектом.
- field — идентификатор пользовательского поля аналитики, по которому выполняется фильтр.
{ "type": 12, "operator": "equal", "value": { "dateType": "otherDate", "dateValue": "01-07-2022" } }
Пример запроса получения списка контактов с передачей нескольких фильтров (используется логика И):
{ "fields": "name", "filters": [{ "type": 4223, "operator": "equal", "value": { "dateType": "otherDate", "dateValue": "01-12-1990" } }, { "type": 1, "operator": "equal", "value": "user:5" } ] }
Тип | Название | Операторы | Формат value |
---|---|---|---|
3101 | Пользовательское поле типа «Дата» |
|
Объект : "value": { "dateType": string, "dateValue": string, "dateFrom": string, "dateTo": string } dateType принимает следующие значения:
Даты считаются переданными в часовом поясе сотрудника, от имени которого сделан запрос. Примеры: "value": { "dateType": "thisWeek" } "value": { "dateType": "otherRange", "dateFrom": "02-07-2022", "dateTo": "06-07-2022" } "value": { "dateType": "otherDate_withTime", "dateFrom": "30-06-2022 12:00", } |
3106 | Пользовательское поле типа «Контакт» | ||
3104 | Пользовательское поле типа «Сотрудник» | ||
3111 | Пользовательское поле типа «Группа, сотрудник, контакт» | ||
3103 | Пользовательское поле типа «Список сотрудников» | ||
|
string - номер сотрудника/контакта/группы с префиксом.
Например: “user:1”, “contact:5”, “group:3” | ||
3108 | Пользовательское поле типа «Строка» |
|
string - осуществляется фильтр содержит / не содержит |
3109 | Пользовательское поле типа «Число» |
|
int |
3115 | Пользовательское поле типа «Чек-бокс» |
|
int - 1 / 0
boolean |
3105 | Пользовательское поле типа «Справочник» |
|
int - идентификатор записи |