Скачать XLS реестра документов
POST/api/v1/clients/:clientId/documents/hrRegistry/downloads/excel
Описание метода
Производит редирект на ссылку для скачивания excel файла с данными реестра документов кадровика.
Валидации запроса
- Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
- Пользователь клиента имеет право выполнять запрос документов для реестра кадровика.
- Данные для фильтрации документов реестра документов корректны.
- 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 при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
- Проверяет, что клиент не удален.
- Список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. отделов клиента не задан.
- Список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. отделов клиента пуст.
- Список содержит только IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существующих отделов клиента.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сотрудников и руководителей, заданных в фильтрах, заданы корректно для реестра кадровика.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц, заданных в фильтрах, заданы корректно для реестра кадровика.
- Список создателей документов не задан или пуст.
- По всем заданным 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 при создании. Неизменяемый, используется во всех внутренних операциях., и возвращает список сотрудников.
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=<<одноразовый_токен>>Ошибка при валидации данных запроса.
Запрос не аутенифицирован.
Для заданного пользователя доступ к ресурсу запрещен.
Превышен разрешенный лимит запросов за период.