Комментарий

Комментарий - это текстовое сообщение созданное пользователем под объектом в системе.

API

Установить

POST /api/v1/comment/set

Добавляет или меняет комментарий.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный только для действия Изменить. Идентификатор комментария.
parent	UUID		Необязательный. Идентификатор комментария родителя. Указывается при ответе на ранее созданный комментарий.
object	UUID		Обязательный. Идентификатор объекта.
priority	INTEGER		Рекомендуемый. Приоритет комментария. По умолчанию 0.
text	STRING		Обязательный. Текст комментария.
data	JSON		Необязательный. Данные в произвольном формате.

ВНИМАНИЕ: Если значение ключа id не указано или равно null, то действие считается как Добавить, иначе как Изменить.

ВНИМАНИЕ: Значения не указанных ключей считаются как null.

ВНИМАНИЕ: Для действия Изменить не нужно передавать значения всех ключей, достаточно передать только те, которые требуется поменять.

ВНИМАНИЕ: Ответом на запрос будут данные действия Получить.

Получить

POST /api/v1/comment/get

Возвращает комментарий.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный. Идентификатор комментария.

Формат ответа:

Поле	Тип	Описание
id	UUID	* Идентификатор комментария.
parent	UUID	Идентификатор комментария родителя. Указывается при ответе на ранее созданный комментарий.
object	UUID	* Идентификатор объекта.
entity	UUID	* Идентификатор сущности.
entitycode	STRING	* Код сущности.
entityname	STRING	* Наименование сущности.
class	UUID	* Идентификатор класса.
classcode	STRING	* Код класса.
classlabel	STRING	* Метка класса.
type	UUID	* Идентификатор типа.
typecode	STRING	* Код типа.
typename	STRING	* Наименование типа.
typedescription	STRING	* Описание типа.
label	STRING	Метка объекта.
owner	UUID	* Идентификатор учётной записи пользователя.
username	STRING	* Наименование учётной записи пользователя.
name	STRING	* Наименование пользователя.
given_name	STRING	Имя пользователя.
family_name	STRING	Фамилия пользователя.
patronymic_name	STRING	Отчество пользователя.
email	STRING	Электронный адрес пользователя.
email_verified	BOOLEAN	Подтвержден ли электронный адрес пользователя.
phone	STRING	Телефон пользователя.
phone_verified	BOOLEAN	Подтвержден ли телефон пользователя.
priority	INTEGER	* Приоритет комментария. По умолчанию 0.
created	TIMESTAMP	* Дата и время создания извещения.
updated	TIMESTAMP	* Дата и время обновления извещения.
text	STRING	* Текст комментария.
data	JSON	Данные в произвольном формате.

* - Не может быть пустым.

Количество

POST /api/v1/comment/count

Количество комментариев с возможностью указания фильтра отбора данных.

Параметры запроса: Общие параметры запроса для списка

POST /api/v1/comment/list

Возвращает комментарий в виде списка.

Параметры запроса: Общие параметры запроса для списка