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

Реестр документов (сотрудник)

POST 
/api/v1/clients/:clientId/documents/employeeRegistry

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

Возвращает данные реестра документов сотрудника.

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

  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента является UUID.
  • Клиент существует.
  • Для пользователя существует пользователь клиента.
  • Тело запроса проходит все проверки фильтра реестра документов сотрудника с пагинацией.
  • Смещение в запросе не меньше 0.
  • Количество возвращаемых в ответе записей задано корректно.
  • Клиент с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует.
  • Для текущего пользователя существует пользователь клиента в клиенте из запроса.
  • Тело запроса проходит все проверки фильтра реестра документов сотрудника.
  • Смещение не меньше нуля.
  • Количество возвращаемых элементов больше нуля и не больше максимального разрешённого значения.
  • Параметры сортировки заданы корректно.
  • Тело запроса проходит полный набор проверок фильтра реестра документов сотрудника.
  • Проверяет, что количество элементов, которое нужно пропустить при выборке с пагинацией, корректно.
  • Проверяет, что заданное количество возвращаемых при запросе элементов корректно.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • В списке данных для сортировки не должно быть пустых элементов.
  • Количество данных для сортировки не должно быть больше количества полей документа, по которым можно сортировать.
  • Указано, по какому полю необходимо сортировать.
  • В запросе не указаны пересекающиеся режимы работы (на данный момент проверка фиктивная).
  • Указанные типы документов существуют.
  • Фильтры по сотрудникам (headManagerIdsid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях., employeeIdsid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и employeeSignerEmployeeIdsid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях.) не содержат null значений, все сотрудники существуют и относятся к заданному клиенту.
  • Список юрлиц не содержит null, все юрлица существуют и относятся к заданному клиенту.
  • Список пользователей клиента для фильтра по участникам и получателям не содержит null, все пользователи клиента существуют и относятся к заданному клиенту.
  • Пользователь является руководителем, если запрашивает документы руководителя.
  • Все запрошенные фильтры доступны.
  • Документы по idid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и по внешним idexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга 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 при создании. Неизменяемый, используется во всех внутренних операциях., и возвращает список сотрудников.
  • Проверяет, что все сотрудники принадлежат клиенту с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что все заданные фильтры доступны для работы с текущей версией кэша документов.
  • Проверяет, что все UUID, заданные в списке, соответствуют существующим типам документов и возвращает список типов документов.
  • Проверяет, что все IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. типов документов во внешней системе, заданные в списке, соответствуют существующим типам документов и возвращает список типов документов.
  • Проверяет, что пользователи клиента существуют по всем заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях., и возвращает список пользователей клиента.
  • Проверяет, что заданные пользователи клиента принадлежит клиенту с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что заданный сотрудник относится к заданному клиенту.
  • Проверяет, что заданный пользователь клиента принадлежит клиенту с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..

Request​

Responses​

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