Обзор

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

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

Описание: Ресурс messages отвечает за управление сообщениями. Сообщения используются для обмена информацией между пользователями платформы. Например, при изменении информации об инцидентах или активах можно написать ответственному для предоставления дополнительной информации. Сообщения, отправленные подобным образом, отображаются в разделе веб-интерфейса Сообщения. Также, доступна возможность написать другому пользователю, непосредственно из данного раздела.

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

Тип	Метод	Описание
POST	/messages/create	Создание сообщения
PUT	/messages/update	Обновление информации о сообщении
POST	/messages/search	Поиск сообщений
GET	/messages/{id}	Получение сообщения по ID
DELETE	/messages/{id}	Удаление сообщения
POST	/messages/group	Группировка сообщений
POST	/messages/mass_delete	Массовое удаление сообщений
DELETE	/messages/all	Удаление всех сообщений
PUT	/messages/action/bulk_read	Массовое изменение статуса сообщений на выбранный статус
PUT	/messages/action/bulk_unread	Массовое изменение статуса сообщений на непрочитанный
PUT	/messages/action/mark_read/:id/by/:user_id	Пометить как прочитанные для пользователя
GET	/messages/_meta	Получение свойств полей сообщений и действий пользователей

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

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

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

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