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

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

DELETE 
/api/v1/clients/:clientId/documents/:documentId

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

Метод для удаления одного документа. При удалении документ лишь помечается как удаленный, а не удаляется целиком из системы. Обязательных полей нет, но задать json-тело обязательно т.е. надо задать тело запроса как пустой объект {}.

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

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

Request​

Responses​

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