Получить список записей
GET
https://{команда}.{домен}/{проект}/{ресурс}Возвращает одну страницу записей коллекции. Тело ответа — массив; сколько записей всего подходит под текущий фильтр, сказано в заголовке X-Total-Count.
Порядок по умолчанию — по времени создания, от новых к старым.
Параметры запроса
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
_page | integer | 1 | Номер страницы, начиная с единицы |
_limit | integer | 20 | Записей на странице, максимум 200 |
_sort | string | — | Поле сортировки, любое поле схемы |
_order | string | asc | Направление: asc или desc |
{поле} | string | — | Точное совпадение: ?role=admin |
{поле}_like | string | — | Подстрока без учёта регистра |
{поле}_gt | number | — | Больше значения, только числовые поля |
{поле}_lt | number | — | Меньше значения, только числовые поля |
Служебные параметры начинаются с подчёркивания, чтобы не столкнуться с именами ваших полей: поле limit в схеме — обычное дело.
_limit больше 200 уменьшается без ошибки
Значение приводится к диапазону от 1 до 200 молча. Сколько записей пришло на самом деле, смотрите по длине массива, а не по тому, что отправили.
Пример
$ curl -s -D - \
"https://acme.<домен>/shop/users?role=admin&_limit=2"
HTTP/1.1 200 OK
X-Total-Count: 143
Content-Type: application/json
[
{"name":"Анна Петрова","role":"admin","id":"9c1e-a4"},
{"name":"Игорь Лемешев","role":"admin","id":"4b7a-01"}
]
Коды ответа
| Код | Когда возвращается |
|---|---|
200 | Успех. Пустой массив — это не ошибка |
400 | В фильтре указано поле, которого нет в схеме |
401 | Ресурс приватный, заголовок Authorization не передан |
404 | Проект или ресурс не найден |
429 | Исчерпан месячный лимит запросов тарифа |
500 | Включён chaos-режим или сбой на нашей стороне |