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

Обзор

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

Характеристика Значение
Наименование occurrences
Компоненты 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

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

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

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

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

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

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

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