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

Отправить на подписание (частично)

PUT 
/api/v2/clients/:clientId/documents/sendToSigning

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

⚠️ Будьте осторожны!

Методы PUT перезаписывают запись целиком: любые непереданные поля считаются null и затирают данные в БД. Поэтому при обновлении нужно указывать все поля.

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

  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Тело запроса должно быть задано.
  • Список документов должен быть не пуст и не содержать null-элементов.
  • У каждого документа должен быть задан IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и версия.
  • Документы с заданными IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. должны существовать.
  • Документы должны относиться к заданному клиенту.
  • Версия в теле совпадает с версией документа.
  • Состояние каждого документа должно быть корректным для отправки его на подписание.
  • Пользователь должен иметь право отправлять на подписание каждый из заданных документов.
  • Лимит на выполнение операций создания печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. файла для заданного тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. не превышен с учетом активных каналов участников (подписантов и наблюдателей).
  • Лимит СМС в пакете лицензий не должен быть исчерпан.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Список не пуст.
  • В списке нет null-элементов.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. каждого документа задан.
  • Проверяет, что документ существует по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает документ, если он существует.
  • Проверяет, что документ относится к заданному клиенту.
  • Проверяет, что указана корректная версия данных документа.
  • Проверяет, что документ находится в корректном состоянии для отправки на подписание.
  • Проверяет, что у пользователя клиента есть право для отправки документов на подписание для каждого из заданных документов.
  • Проверяет, что если операции в облаке включены, то лимит на выполнение операций создания печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. файла для заданного тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. не превышен.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • Проверяет существование документа по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.
  • Проверяет, что порядок подписания указан.
  • Проверяет, есть ли у пользователя клиента с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заданное право и возвращает кэш наличия прав у пользователя клиента.
  • Проверяет, что лимит на выполнение операций создания печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. файла для заданного тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. не превышен.

Request​

Responses​

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