Комментарии помогают участникам документооборота обсуждать заявление или документ без изменения его содержимого. Комментарий привязан к одной сущности: заявлению или документу.

API поддерживает получение списка комментариев, создание комментария и удаление одного или нескольких комментариев. Отдельного метода для редактирования комментария нет.

Когда использовать

Используйте комментарии, если участники должны обсудить документ или заявление без изменения файла, реквизитов и статуса.

Что нужно заранее

Что нужно	Где получить
`clientId`	Текущий пользователь
Токен	Аутентификация
`documentId` или `applicationId`	Из сценария работы с документом или заявлением
Доступ пользователя к сущности	Роли и права доступа

Типовые сценарии

Добавить комментарий к документу

Убедитесь, что документ вышел из черновика.
Проверьте, что пользователь имеет доступ к документу.
Вызовите Создать комментарий к документу.

Добавить комментарий к заявлению

Убедитесь, что заявление вышло из черновика.
Проверьте, что пользователь имеет доступ к заявлению.
Вызовите Создать комментарий к заявлению.

Удалить комментарий

Получите список комментариев.
Выберите комментарии текущего пользователя.
Вызовите метод удаления для документа или заявления.

Ограничения и ошибки

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

Доступ к комментариям

HRlink проверяет доступ к сущности перед каждой операцией с комментариями. Пользователь может работать с комментариями только к тем заявлениям и документам, которые ему доступны по ролям, участию в маршруте или связи с сущностью.

При аутентификации через Master-Api-Token передавайте пользователя, от имени которого выполняется запрос:

Заголовок	Назначение
`Impersonated-User-Id`	Идентификатор пользователя
`Impersonated-User-Id-Type`	Тип идентификатора: `HR_LINK_ID`, `SNILS` или `EXTERNAL_ID`
`Impersonated-User-Id-External-System-Type`	Идентификатор внешней системы, если пользователь передан по `EXTERNAL_ID`

Подробнее о запросах от имени пользователя см. Запросы от имени пользователя.

Комментарии к заявлениям

Комментарии к заявлению доступны после того, как заявление вышло из черновика. HRlink проверяет, что заявление существует, относится к клиенту и пользователь имеет доступ к заявлению.

Действие	Метод
Получить комментарии	Получить данные комментариев к заявлению
Создать комментарий	Создать комментарий к заявлению
Удалить комментарии	Удалить комментарии к заявлению

Комментарии к документам

Комментарии к документу доступны после того, как документ вышел из черновика. HRlink проверяет, что документ существует, относится к клиенту и пользователь имеет доступ к документу.

Действие	Метод
Получить комментарии	Получить данные комментариев к документу
Создать комментарий	Создать комментарий к документу
Удалить комментарии	Удалить комментарии к документу

Создание комментария

Для создания комментария передайте поле message:

{
  "message": "Проверьте, пожалуйста, реквизиты перед подписанием."
}

Текст комментария обязателен. HRlink отклонит запрос, если message пустой или состоит только из пробелов.

Успешный ответ содержит созданный комментарий:

{
  "result": true,
  "comment": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "version": 1,
    "user": {
      "userId": "8c2f3f10-2f4c-4b4f-9c31-4f2c3f1c7d10",
      "lastName": "Иванов",
      "firstName": "Пётр",
      "middleName": "Сергеевич"
    },
    "message": "Проверьте, пожалуйста, реквизиты перед подписанием.",
    "createdDate": "2026-05-14T10:30:00Z"
  }
}

Получение комментариев

Метод получения возвращает массив comments. Каждый элемент содержит:

Поле	Описание
`id`	Идентификатор комментария
`version`	Версия комментария
`user`	Автор комментария
`message`	Текст комментария
`createdDate`	Дата создания

Если комментариев нет, HRlink возвращает пустой массив.

Удаление комментариев

Удаление работает пакетно: в одном запросе можно передать несколько комментариев. Пользователь может удалить только свои комментарии.

{
  "comments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "version": 1
    }
  ]
}

Поле id обязательно. Поле version используйте, если хотите защититься от удаления устаревшей версии комментария: когда version передан, HRlink сверяет его с текущей версией комментария.

Успешный ответ:

{
  "result": true
}

Ограничения

Комментарий не изменяет статус заявления или документа.
Комментарий не попадает в файл документа, печатную форму или архив подписания.
API не поддерживает редактирование комментария. Чтобы изменить текст, удалите комментарий и создайте новый.
Удалить можно только комментарии текущего пользователя.

Когда использовать​

Что нужно заранее​

Типовые сценарии​

Добавить комментарий к документу​

Добавить комментарий к заявлению​

Удалить комментарий​

Ограничения и ошибки​

Доступ к комментариям​

Комментарии к заявлениям​

Комментарии к документам​

Создание комментария​

Получение комментариев​

Удаление комментариев​

Ограничения​