Перейти к основному содержимому

Создать комментарий к документу

POST 
/api/v1/clients/:clientId/documents/:documentId/comments

Описание метода​

Создаёт комментарий к документу.

Валидации запроса​

  • Тело запроса задано.
  • Текст комментария задан и не является пустой строкой.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа задан корректно.
  • Пользователь имеет доступ к документу.
  • Документ не является черновиком.
  • Документ не является удалённым.
  • Проверяет, что текст комментария задан и не является пустой строкой.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Выполняет проверку, что документ существует по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает документ, если он существует.
  • Проверяет наличие у пользователя клиента прав для получения документа, в том числе через связанные сущности.
  • Выполняет проверку, что документ не является черновиком.
  • Выполняет проверку, что документ не удален.
  • Выполняет проверку, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Выполняет проверку существования клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента в случае, если он существует.
  • Проверяет, что клиент не удален.
  • Выполняет проверку существования документа по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.

Request​

Responses​

Успешная операция.