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

Получить документ

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

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

Метод возвращает данные по документообороту

  • данные документа, участников подписания, их данные и статусы. Если параметр baseDocumentId пустой, то документ является черновиком. Если документ был отправлен на подписание, то IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. базового документа будет ссылаться на IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа-черновика, на основе которого был создан этот документ. Если документ отправлен на подписание, то порядковые номера подписантов будут установлены согласно document.signingOrder. Первый подписант имеет порядковый номер равный 0. Если документ является черновиком, то порядковые номера всех подписантов равны 0. document.watchers
  • наблюдатели документа. Наблюдатели не подписывают документ. Они получают уведомление после завершения документооборота, после чего имеют доступ к документу и скачиванию архива с подписями участников документооборота. document.notice
  • Заметка о документе -присутствует в теле ответа только при наличии у пользователя, выполняющего операцию, прав кадровика.

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

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

Request​

Responses​

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