Скачать печатную форму
GET/api/v1/clients/:clientId/documents/:documentId/printFormFile
Описание метода
Валидации запроса
- IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа должен соответствовать формату UUID.
- Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
- Документ с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. должен существовать.
- Документ должен относиться к заданному клиенту.
- Пользователь должен иметь право запрашивать данные документа.
- У документа есть файл печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения..
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа.
- IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
- По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
- Пользователь, выполняющий операцию, относится к клиенту.
- Проверяет, что документ существует по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает документ, если он существует.
- Проверяет, что документ относится к заданному клиенту.
- Выполняет проверку наличия права у пользователя клиента для получения редиректа для скачивания файла печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. документа.
- Проверяет, что у документа есть файл печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения..
- Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
- Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
- Проверяет, что клиент не удален.
- Проверяет существование документа по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.
- У пользователя клиента должен быть доступ к документу, а также к файлам документа, если документ отмечен скрытый от участника после подписания.
- Пользователь клиента является наблюдателем документа, в тот момент, когда документ уже подписан всеми руководителями-подписантами документа.
- Пользователь клиента имеет доступ к связанными сущностям заданной сущности.
- Проверяет наличие прав на файл документа для пользователя с учетом связей.
Request
Responses
- 200
- 303
- 400
- 401
- 403
- 429
Этот код ответа не используется, при успехе выполнения метод всегда возвращает ответ с кодом 303.
HTTP-заголовок Location будет содержать URL, по которому скачивается файл.
✍️ Postman и некоторые другие API-клиенты по умолчанию следуют редиректам и сразу скачивают файл, указанный в
HTTP-заголовке Location. Это поведение настраивается на стороне клиента.
Response Headers
Location
URL, по которому скачивается файл
Example:
https://host.hr-link.ru/api/v1/files?token=<<одноразовый_токен>>Ошибка при валидации данных запроса.
Запрос не аутенифицирован.
Для заданного пользователя доступ к ресурсу запрещен.
Превышен разрешенный лимит запросов за период.