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

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

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

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

Обязательных полей нет, но задать json-тело обязательно. В случае, если ни один из фильтров не указан, то как минимум надо задать тело запроса как пустой объект {}. Поля docflowFinishedDateFrom и docflowFinishedDateTo, createdDateFrom и createdDateTo

  • имеют формат даты и времени ISO 8601, где части даты идут в следующем порядке: год, месяц, день, часы, минуты, секунды, миллисекунды, часовой пояс. Год представляется четырьмя цифрами, месяц, день, часы, минуты и секунды — двумя. Если месяц, день, часы, минуты или секунды меньше 10, то перед ними указывается 0. Миллисекунды содержат в себе от 1 до 6 цифр. Дата и время разделяются символом T. Допустимые значения для указания часового пояса: Z (указывает UTC время), ±hh (от -18 до +18)
  • указывает кол-во часов, на которое время отличается от UTC. Ответ автоматически сортируется по ID документа, если в поле sort не указан иной вариант сортировки. ⚠️ Query-параметр dataSet изменяет тело ответа, подробнее можно посмотреть в описании параметра.

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

  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Набора данных задан корректно или не задан вообще.
  • Входные данные для фильтрации документов проходят базовую валидацию.
  • Набор данных задан корректно или не задан вообще.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Набор данных соответствует одному из допустимых значений (FULL, SIGNING_STATE).
  • Количество возвращаемых при запросе элементов корректно.
  • Количество элементов, которое нужно пропустить при выборке с пагинацией, корректно.
  • Данные для сортировки документов реестра документов корректны.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что 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 при создании. Неизменяемый, используется во всех внутренних операциях. отделов клиента не задан.
  • Список 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 при создании. Неизменяемый, используется во всех внутренних операциях. разрешенных элементов пользовательских структур.
  • Проверяет, что ни один IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. отдела клиента не задан пустым.
  • Проверяет, что все UUID, заданные в списке, соответствуют существующим отделам клиента и возвращает список отделов клиента.
  • Проверяет, что ни один 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 при создании. Неизменяемый, используется во всех внутренних операциях., и возвращает список сотрудников.

Request​

Responses​

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