REST API: Сложные фильтры справочников: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) Нет описания правки |
||
Строка 9: | Строка 9: | ||
*'''operator''' — оператор фильтра, одно из значений списка (equal, notequal, gt, lt). У разных фильтров могут быть разные допустимые операторы. | *'''operator''' — оператор фильтра, одно из значений списка (equal, notequal, gt, lt). У разных фильтров могут быть разные допустимые операторы. | ||
*'''value''' — значение фильтра, в зависимости от типа фильтра может быть строкой, числом или сложным объектом. | *'''value''' — значение фильтра, в зависимости от типа фильтра может быть строкой, числом или сложным объектом. | ||
*'''field''' — идентификатор пользовательского поля | *'''field''' — идентификатор пользовательского поля справочника, по которому выполняется фильтр. | ||
Версия от 10:16, 16 января 2023
Сложные фильтры в REST API ПланФикса применяются в методе «/directory/{id}/entry/list» при получении записей справочников. Фильтры справочников задаются следующим набором параметров:
- type — числовой идентификатор фильтра.
- operator — оператор фильтра, одно из значений списка (equal, notequal, gt, lt). У разных фильтров могут быть разные допустимые операторы.
- value — значение фильтра, в зависимости от типа фильтра может быть строкой, числом или сложным объектом.
- field — идентификатор пользовательского поля справочника, по которому выполняется фильтр.
Пример запроса получения списка записей справочника с передачей нескольких фильтров, по пользовательскому полю типа «Дата» и пользовательскому полю типа «Список сотрудников» (используется логика И):
{ "offset": 0, "pageSize": 100, "fields": "directory,parentKey,key,3,5", "filters": [ { "type": 6103, "field": 3, "operator": "equal", "value": { "dateType": "otherRange", "dateFrom": "15-12-2022", "dateTo": "17-12-2022" } }, { "type": 6109, "field": 5, "operator": "equal", "value": "user:50" } ] }
Тип | Название | Операторы | Формат value |
---|---|---|---|
6103 | Поле справочника типа Дата |
|
Объект :
"value": { "dateType": string, "dateValue": string, "dateFrom": string, "dateTo": string }
Даты считаются переданными в часовом поясе сотрудника, от имени которого сделан запрос. Примеры: "value": { "dateType": "thisWeek" } "value": { "dateType": "otherRange", "dateFrom": "01-12-2022", "dateTo": "06-12-2022" } "value": { "dateType": "otherDate_withTime", "dateFrom": "30-12-2022 12:00", } |
6108 | Поле справочника типа Контакт |
|
string - номер сотрудника/контакта/группы с префиксом.
Например: “user:1”, “contact:5”, “group:3” |
6109 | Поле справочника типа Сотрудник | ||
6110 | Поле справочника типа Контрагент | ||
6112 | Поле справочника типа Группа, сотрудник, контакт | ||
6113 | Поле справочника типа Список сотрудников | ||
6101 | Поле справочника типа Строка |
|
string - осуществляется фильтр содержит / не содержит |
6102 | Поле справочника типа Число |
|
int |
6105 | Поле справочника типа Чекбокс |
|
int - 1/0 boolean |
6106 | Поле справочника типа Список |
|
string |
6107 | Поле справочника типа Запись справочника |
|
int - идентификатор записи |
6114 | Поле справочника типа Набор записей справочника |
|
int — идентификатор записи, для условия по нескольким записям — идентификаторы через ; (точку с запятой) |
6115 | Поле справочника типа Задача |
|
int — номер задачи |
6117 | Поле справочника типа Проект |
|
int — номер проекта |