Доступ к элементам

Элементы - это отдельные записи в таблицах вашей базы данных

• Объект элемента
• Получить список элементов
  • Параметры запроса
  • Возвращаемое значение
• Получить элемент по уникальному идентификатору
  • Параметры запроса
  • Возвращаемое значение
• Создать элемент
• Создать несколько элементов
• Обновить элемент
• Обновить несколько элементов
• Удалить элемент
• Удалить несколько элементов

Объект элемента

Элементы не имеют заранее определенной схемы. Формат полностью зависит от конфигурации таблиц в базе данных. Описание основных бизнес элементов доступно в разделе Модели данных.
Для документации будем использовать коллекцию грузов:

{
    "id": "6726B53C-2443-11EC-A399-00155D660901",
    "date_created": "2021-10-03T21:09:17",
    "date_updated": "2021-10-18T15:02:42",
    "description": "Тот голям #20671487683",
    "temperature": null,
    "is_deleted": false
}

Получить список элементов

Список доступных элементов текущему пользователю

Параметры запроса

GET /items/:collection

Пример:

GET /items/cargos

Возвращаемое значение

Массив объектов в количестве согласно лимитированию. Если доступных объектов нет, то в результате будет возвращен пустой массив.

Получить элемент по уникальному идентификатору

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

Параметры запроса

GET /items/:collection/:id

Пример:

GET /items/cargos/6726B53C-2443-11EC-A399-00155D660901

Возвращаемое значение

Одиночный объект если идентификатор корректный

Создать элемент

Создать несколько элементов

Обновить элемент

Обновить несколько элементов

Удалить элемент

Удалить несколько элементов