REST API: Сложные фильтры контактов: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «{{#seo: |title=REST API: Сложные фильтры контактов |titlemode=append |keywords=планфикс, Фильтры контактов, апи,…»)
 
Нет описания правки
Строка 21: Строка 21:
}
}
</pre>
</pre>


Пример запроса получения списка контактов с передачей нескольких фильтров (используется логика И):
Пример запроса получения списка контактов с передачей нескольких фильтров (используется логика И):

Версия от 12:10, 6 июля 2022

Сложные фильтры в REST API ПланФикса применяются в методе «/contact/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"
     }
  ]
}