Skip to main content

Работа с моделью данных через API

С моделями данных можно работать через API только на чтение.

Для получения списка доступных моделей данных, необходимо вызвать следующий метод API, указав публичный ключ приложения.

https:://api.tpu.ru/v2/entity

Для получения структуры/описания модели данных можно использовать следующие методы API.

https://api.tpu.ru/v2/entity/structure/<id>

Для получения возможного списка параметров, которые можно использовать в модели данных (данный список может быть пуст)

https://api.tpu.ru/v2/entity/parametr/<id>

Для получения возможных фильтров, которые используются при работе с корневым элементом модели данных.

https:://api.tpu.ru/v2/entity/filter/<id>

Фильтры доступны только при работе с моделями данных организованных на источниках данных типа массив.

Сортировка выборки данных

sort=[direction][column]

Для обратной сортировки добавьте минус перед названием столбца


Пример: 

?sort=title,-created

Фильтрация выборки данных:

filter[type][op]=value

Допустимые сравнения: 

Оператор Сравнение Описание
eq equal (=) Эквивалентно (равно) указанному значению
like text search Поиск по тексту
gte >= Больше и равно
lte <= Меньше и равно
gt > Больше
lt < Меньше

Пример: 

?filter[created][eq]=2019-07-16

Все параметры можно комбинировать