Пагінація, фільтри, сортування, пошук

Більшість методів get.*.list підтримують однакову логіку.

Пагінація

• params.limit (int) — скільки рядків повернути

  • мінімум: 1
  • максимум: 5000 (обмеження сервера)

• params.offset (int) — зсув (скільки пропустити)

Приклад:

"params": { "limit": 100, "offset": 200 }

Пошук (q)

• params.q (string) — пошук по основних полях (залежить від довідника)

Наприклад, для товарів шукає по Code та Nt (назва).

Фільтри

• params.filters (object) — точні фільтри поле = значення

Приклад:

"filters": { "Deleted": 0, "Level": 1 }

Важливо: кожна сутність має свій список дозволених полів для фільтрації. Якщо ви передасте поле, яке не дозволене, отримаєте INVALID_FILTER_FIELD або подібну помилку.

Сортування

• params.order_by — поле сортування
• params.order_dir — ASC або DESC

Приклад:

"order_by": "Nt",
"order_dir": "ASC"

with_total

Для деяких list методів доступний параметр:

• params.with_total=true — тоді у відповіді буде total

Це зручно для UI з пагінацією, але може бути повільно на дуже великих таблицях.