Перейти к содержанию

Обзор

Основные характеристики

Характеристика Значение
Наименование locations
Компоненты Cruddy
Появился в версии 4.2.0
Доступен в версиях 4.2.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс locations отвечает за управление локациями активов.

Список методов для работы с ресурсом

Тип Метод Описание
POST /locations/create Создание локации
PUT /locations/update Редактирование локации
POST /locations/search Поиск локаций
GET /locations/{id} Получение локации
DELETE /locations/{id} Удаление локации

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
422 Внутренняя ошибка удаления
500 Ошибка сервера

Модели объектов

Название Описание
Location Модель данных ресурса locations