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

Создать группу и отправить на подписание

POST 
/api/v1/clients/:clientId/documentGroups/sendToSigning

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

Сервер создаёт группу из одного или нескольких документов и ставит их в очередь на отправку подписантам. В ответе сервер синхронно возвращает sendToSigningTask.id — идентификатор фоновой задачи; сами документы на этот момент ещё не созданы.

Дальнейшие шаги выполняются асинхронно: сервер конвертирует файлы в PDF/A, создаёт документы и рассылает уведомления первым подписантам. Когда задача завершается успешно, документы переходят в статус «на подписании».

Если конвертация или другая часть подготовки падает с ошибкой (например, файл не удалось привести к PDF/A), документы не создаются и на подписание не уходят. В этом случае сервер отправляет email с описанием ошибки пользователю, который вызвал метод.

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

ТенантTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. и лицензии

  • Активный пакет СМС существует, лимит СМС в пакете лицензий не исчерпан.
  • Операция не превысит лимит тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. на конвертацию файлов в PDF/A.
  • Операция не превысит лимит тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. на создание печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. файла.

Клиент и пользователь

  • Клиент существует, не удалён; пользователь, вызывающий метод, относится к этому клиенту.
  • У пользователя клиента есть право создавать документы.
  • У пользователя клиента есть право отправлять каждый из документов группы на подписание.
  • Если ни одна сущность в теле запроса не привязана к юрлицу, право проверяется на уровне клиента или сотрудника клиента.
  • Если хотя бы одна сущность привязана к юрлицу, право проверяется в этом юрлице на уровне пользователя клиента или сотрудника.
  • У пользователя клиента есть право создавать документ с указанными сотрудниками-подписантами на уровне доступа к отделам клиента.
  • Создатель документа определён; если в запросе указан другой пользователь клиента — у вызывающего есть право назначать создателем другого пользователя.

Группа документов

  • Тело запроса передано.
  • Название группы документов задано.
  • Список документов не пуст, среди элементов нет пустых.
  • Внешний IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. документа уникален в пределах группы.
  • Документ с таким внешним IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. не существует у этого клиента.
  • Списки в данных документов либо не заданы, либо не содержат пустых элементов.

Тип документа

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

Файл документа

  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. файла документа указывает на корректный файл, либо корректно заданы ссылки на документ-источник.

Юрлицо документа

  • Если IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлица задан, юрлицо существует и принадлежит указанному клиенту.
  • Сотрудник-подписант, наблюдатели, участники маршрута и сам документ относятся к одному юрлицу.

Порядок подписания (signingOrder)

  • Данные документа соответствуют выбранному signingOrder.
  • EMPLOYEE_FIRST или MANAGER_FIRST: наблюдатели, участники маршрута и IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. шаблона маршрута не передаются.
  • MANAGER_ONLY: сотрудники-подписанты, участники маршрута и IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. шаблона маршрута не передаются.
  • EMPLOYEE_ONLY: руководитель, наблюдатели, участники маршрута и IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. шаблона маршрута не передаются.
  • ROUTE: задан корректный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. шаблона маршрута подписания; данные документа согласованы с этапами шаблона.
  • Если signingOrder не равен ROUTE, участники маршрута не передаются.

Шаблон маршрута подписания

  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. шаблона задан (внутренний или внешний); шаблон существует.
  • Шаблон относится к указанному клиенту и не деактивирован.
  • Тип подписываемого объекта в шаблоне совпадает с типом документа и имеет корректный формат.
  • Если список юрлиц шаблона пуст — шаблон доступен всем юрлицам.
  • Если у документа нет юрлица, ему доступен только шаблон без ограничений по юрлицам.
  • Если у документа есть юрлицо, а у шаблона список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц непустой — IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлица документа входит в этот список.

Сотрудники-подписанты

  • Если переданы IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сотрудников-подписантов (внутренние или внешние), каждый IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. указывает на существующего сотрудника.
  • Сотрудники принадлежат указанному клиенту.
  • Сотрудник не уволен и работает.
  • Если IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. списка сотрудников передан, среди элементов нет пустых.
  • Если юрлицо указано — существование сотрудника проверяется в этом юрлице; иначе — в клиенте.
  • Сотрудники-подписанты соответствуют требованиям подписания в своей очереди.

Руководитель-подписант

  • Если IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. руководителя-подписанта задан, сотрудник существует и принадлежит указанному клиенту.
  • Сотрудник имеет права руководителя в своём юрлице.
  • Если юрлицо руководителя задано (внутренним или внешним IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID.), оно существует и принадлежит указанному клиенту.
  • Если IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. руководителя не задан, но указан внешний IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. руководителя и внутренний или внешний IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. его юрлица — IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлица руководителя задан корректно.
  • Если юрлицо руководителя не совпадает с юрлицом документа: у пользователя есть активный сотрудник-руководитель в юрлице документа либо право руководителя в этом юрлице через связку прав сотрудника.

Наблюдатели

  • Если IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. наблюдателей переданы (внутренние или внешние), среди них нет пустых элементов.
  • Каждый IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. наблюдателя указывает на существующего сотрудника, который принадлежит указанному клиенту.

Участники маршрута подписания (ROUTE)

  • Если список данных участников этапа задан, среди элементов нет пустых.
  • В участниках этапа корректно указаны сотрудники.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. участника этапа маршрута подписания задан.
  • У участника задан IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сотрудника (внутренний или внешний).
  • Все участники относятся к указанному маршруту подписания.
  • В данных участников маршрута нет дублирующихся IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. участников, если маршрут это не допускает.
  • Сотрудник, указанный в данных участника, совпадает с сотрудником соответствующего участника шаблона маршрута.
  • Если участник шаблона имеет тип FIXED_EMPLOYEE, IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сотрудника указывает на того же сотрудника.
  • Этап с типом RECEIVING: такие участники передаются в списке наблюдателей.
  • Этап с типом RECEIVING: для этапа задан участник с типом SELECTABLE_EMPLOYEE.
  • Каждому IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. наблюдателя соответствует участник шаблона с типом FIXED_EMPLOYEE (по IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сотрудника).
  • Участники с типом EMPLOYEE или EMPLOYER передаются в полях для сотрудников и руководителя соответственно.
  • Сотрудники участников маршрута на одном этапе — разные пользователи клиента (с учётом переданных участников, фиксированных участников маршрута и автоопределяемых по правилу).
  • На этапе с типом SIGNING, где участники не EMPLOYEE и не EMPLOYER, сотрудники — разные пользователи клиента.
  • Если среди участников этапов с типом SIGNING в шаблоне нет ни одного участника с типом EMPLOYER, руководитель в запросе не задан.
  • Если в маршруте есть только один этап с типом RECEIVING, список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. наблюдателей задан и не пуст.
  • Если в маршруте есть только этап с получателями и в нём нет фиксированных получателей, IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. наблюдателей передаются явно (внутренние или внешние).

Срок подписания

  • В данных документа передан корректный срок подписания в днях.

Связи с сущностями КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ.

  • У пользователя есть право на создание связей между сущностями КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ. (ENTITY_RELATION_CREATE на уровне пользователя клиента или сотрудника юрлица сущности).
  • Массив данных сущностей КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ. не содержит пустых элементов.
  • У каждого элемента задан внутренний или внешний IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. сущности и тип сущности.
  • Сущность указанного типа существует по переданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Сущность не удалена и (если это явно не разрешено) не находится в статусе черновика.
  • У пользователя есть доступ к этой сущности.

Связь с заявлением

  • Заявление существует по переданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. (внутреннему или внешнему).
  • Заявление не удалено и не находится в черновике (хотя бы один подписант принял решение).
  • Выполнено одно из условий доступа: пользователь клиента — создатель заявления; пользователь — заявитель; пользователь — получатель и документооборот заявления завершён подписанием со стороны всех участников; пользователь — подписант, которому уже доступно подписание; среди доступных подписантов есть участник с типом ROLE и у пользователя есть нужная роль; у пользователя есть право на получение заявления на уровне роли пользователя клиента или сотрудника.

Связь с документом

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

Request​

Responses​

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