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

Обзор

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

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

Описание: Ресурс value_stores отвечает за управление табличными списками. Табличные списки (Rapid Value Store), являются видом активного хранилища -- автоматически изменяемого, в зависимости от условий.

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

Тип Метод Описание
POST /value_stores/create Создание табличного списка
PUT /value_stores/update Обновление информации о табличном списке
POST /value_stores/search Поиск табличных списков
GET /value_stores/{id} Получение табличного списка по ID
DELETE /value_stores/{id} Удаление табличного списка
POST /value_stores/group Группировка табличных списков
POST /value_stores/mass_delete Массовое удаление табличных списков
DELETE /value_stores/all Удаление всех табличных списков
GET /value_stores/_meta Получение свойств полей табличных списков и действий пользователей
POST /value_stores/{id}/create Добавление записи в табличный список
POST /value_stores/{id}/search Поиск записей в табличном списке
PUT /value_stores/{id}/update Обновление записи табличного списка
DELETE /value_stores/{id}/{recordId} Удаление записи табличного списка
POST /value_stores/{id}/mass_delete Удаление списка записей табличного списка
DELETE /value_stores/{id}/deleteAll Удаление всех записей табличного списка
POST /value_stores/{id}/group Группировка записей табличного списка

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

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

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

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