Служит для указания, по какому полю и в каком порядке нужно сортировать результаты при получении данных. У каждой сущности (модели) свой набор доступных значений для column — этот список нужно смотреть в документации конкретной модели.
Общая модель и принципы сортировки
Модель сортировки представляет собой массив объектов, каждый объект задаёт одну ступень сортировки. Элементы применяются в указанном порядке: сначала применяется первая запись массива, затем в пределах равных значений — вторая и т.д.
Если параметр сортировки не указан, порядок возвращаемых данных не гарантируется. Если в sort_orders указано поле column, которого нет в списке допустимых для данной модели, сервер вернет ошибку валидации.
Модель сортировки выходных параметров
| Название | Тип данных | Описание |
|---|---|---|
column |
Enum | Значение для сортировки. Список допустимых значений определяется для каждой модели (например: id, name, code, last_update и т. п.). |
direction |
Enum | Порядок сортировки: <ASC > — по возрастанию, <DESC> — по убыванию. |
Пример JSON
Пример сортировки: сначала по name по возрастанию, затем по id по убыванию.
{
"sort_orders": [
{ "column": "name", "direction": "asc" },
{ "column": "id", "direction": "desc" }
]
}