Excerpt

Info

title	О чём раздел

Под управлением структурой подразумевается:

Юрлица - получение данных, внесение изменений
1. Созданием Юрлиц занимается Администратор → [01. Администратор. Базовые настройки справочников]
Отделы/департаменты/подразделения - создание, обновление и получение данных
Должности - создание, обновление и получение данных
Типы кадровых документов - обновление и получение данных
1. Созданием Типов документов занимается Администратор → [01. Администратор. Базовые настройки справочников]
Типы заявлений - создание, обновление и получение данных

Table of Contents

Управление структурой и Справочниками

Примечание

Info

title	Важно

В данном разделе указаны сценарии для Кадрового специалиста, однако, Администратор может выполнит всё, что может выполнить Кадровик.

В ряде случае для Клиента наиболее простой путь интеграции (особенно если идёт интеграция только кадрового потока процессов, см. раздел [01. Подходы к интеграции]) - использование токена Администратора.

Поэтому можно считать, что все сценарии Кадрового специалиста применимы для Администратора.

Обновление данных Юрлица

Tip

title	Цель

Актуализация информации о Юрлица клиента.

В юрлице может быть задан руководитель имеющий право действовать без МЧД. Также данные данного руководителя (ФИО и Должность в дательном падеже) могут быть использованы для подстановки в шаблоны заявлений, если эти переменные указаны в файле шаблона заявления (на чьё имя подаётся заявление).

Note

title	Предусловие

Администратор выгрузил справочник юрлиц → [01. Администратор. Базовые настройки справочников]

1

API-методы

Примечания

1

Получения полного списка справочника юрлиц
Status
subtle true
colour Green
title redoc

GET /api/v1/clients/:clientId/legalEntities

или

Получение данных юрлица по ID свой ИС
Status
subtle true
colour Green
title redoc

PUT /api/v1/clients/:clientId/legalEntities/:legalEntityExternalId/externalId

Данный шаг можно пропустить, т.к. он нужен только для получения списка идентификаторов, чтобы производить обновления по конкретному ЮЛ.

Кроме получения данных всего списка можно получить данные одного Юрлица.

2

Обновление юрлица по ID своей ИС
Status
subtle true
colour Green
title redoc

PUT /api/v2/clients/:clientId/legalEntities/:externalId/externalId

или

Обновление юрлица по ID своей ИС
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/clients/:clientId/legalEntities/:legalEntityId

или

Обновления юрлица по ID HRL
Status
subtle true
colour Green
title redoc

PUT /api/v2/clients/:clientId/legalEntities/:legalEntityId

или

Обновления юрлица по ID HRL
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/clients/:clientId/legalEntities/:legalEntityId

через поле externalId (Идентификатор ЮЛ в ИС Клиента)

Методы обновления v2 поддерживают возможность обновления большего количества параметров:

Цифровой код региона.
Данные руководителя юридического лица для создания.

рекомендуется использовать v2

3

1) Создать новую задачу массовой синхронизации данных

Status

subtle	true
colour	Green
title	redoc

POST /api/v1/clients/:clientId/bulkDataSyncTasks

2) Получить статус задачи массовой синхронизации данных по идентификатору задачи

Status

subtle	true
colour	Green
title	redoc

GET /api/v1/clients/:clientId/bulkDataSyncTasks/:taskId

Note

Если справочник юрлиц имеет большое количество юрлиц, то его обновление может быть осуществлено с помощью метода пакетной выгрузки.

После создания задачи на пакетную выгрузку для контроля состояния выполнения пакетной выгрузки необходимо обращаться к задаче и определять её статус, поэтому здесь представлена цепочка из двух методов.

только Администратор может используя данный метод осуществить первичную выгрузку юрлиц [01. Администратор. Базовые настройки справочников]

Управление справочником Отделов

Tip

title	Цель

Актуализация информации о действующих Отделах.

Отдел не является обязательным атрибутом для Сотрудника, но отдел используется для:

управления областью видимости Кадровика → [03. Администратор. Настройка областей видимости для Кадровика]
упрощения выбора сотрудников через отдел (важно для использования кадровиком ЛК HRlink)
определения руководителя отдела, который будет подставляться в маршрут согласования Заявления

API-методы

Примечания

1

Получение полного списка справочника отделов
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/clients/:clientId/departments

Данный шаг можно пропустить, т.к. он нужен только для получения списка идентификаторов, чтобы производить обновления по конкретному Отделу

2

Обновление отдела клиента по ID своей ИС
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/clients/:clientId/departments/:externalId/externalId

или

Обновления отдела клиента по ID HRL
Status
subtle true
colour Yellow
title Gdoc

PUT api/v1/clients/:clientId/departments/:departmentId

или использовать пакетный метод, для выгрузки отделов

1) Создать новую задачу массовой синхронизации данных

Status

subtle	true
colour	Green
title	redoc

POST /api/v1/clients/:clientId/bulkDataSyncTasks

2) Получить статус задачи массовой синхронизации данных по идентификатору задачи

Status

subtle	true
colour	Green
title	redoc

GET /api/v1/clients/:clientId/bulkDataSyncTasks/:taskId

Note

Если справочник отделов имеет большое количество отделов, то его создание и обновление может быть осуществлено с помощью метода пакетной выгрузки.

После создания задачи на пакетную выгрузку для контроля состояния выполнения пакетной выгрузки необходимо обращаться к задаче и определять её статус, поэтому здесь представлена цепочка из двух методов.

3

Обновление отдела клиента по ID своей ИС
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/clients/:clientId/departments/:externalId/externalId

или

Обновления отдела клиента по ID HRL
Status
subtle true
colour Yellow
title Gdoc

PUT api/v1/clients/:clientId/departments/:departmentId

Удаление рассматривается как частный случай обновления.

4

Удаление отдела клиента из справочника отделов
Status
subtle true
colour Yellow
title Gdoc

DELETE /api/v1/clients/:clientId/departments/:departmentId

Удаление происходит не через отметку об удалении, а через удаление объекта из базы данных, поэтому удаление отдела возможно только если нет ни одного сотрудника, привязанного к отделу.

Управление справочником Должностей

Tip

title	Цель

Актуализация информации о действующих должностях.

Должность не является обязательным атрибутом для Сотрудника, если интеграция не предполагает использования интерфейса HRlink, то можно отказаться от управления данным справочником.

Однако Использование должностей в значительной степени влияет на использования функционала ЛНА.

API-методы

Примечания

1

Создание должности
Status
subtle true
colour Yellow
title Gdoc

POST/api/v1/clients/:clientId/employeePositions

или использовать пакетный метод, для выгрузки отделов

1) Создать новую задачу массовой синхронизации данных

Status

subtle	true
colour	Green
title	redoc

POST /api/v1/clients/:clientId/bulkDataSyncTasks

2) Получить статус задачи массовой синхронизации данных по идентификатору задачи

Status

subtle	true
colour	Green
title	redoc

GET /api/v1/clients/:clientId/bulkDataSyncTasks/:taskId

Первичное наполнение справочника должностей может быть организовано или через использование пакетного метода выгрузки

Note

Если справочник Должностей имеет большое количество должностей, то его создание и обновление может быть осуществлено с помощью метода пакетной выгрузки.

После создания задачи на пакетную выгрузку для контроля состояния выполнения пакетной выгрузки необходимо обращаться к задаче и определять её статус, поэтому здесь представлена цепочка из двух методов.

2

Метод получения полного списка справочника должностей
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/clients/:clientId/employeePositions

Данный шаг можно пропустить, т.к. он нужен только для получения списка идентификаторов, чтобы производить обновления по конкретной Должности или использовать идентификаторы должностей в связанных методах.

Также при точечном создании должности в ответ возвращается идентификатор должности

3

Обновление должности по ID своей ИС
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/clients/:clientId/employeePositions/:externalId/externalId

или

Обновления Должности по ID HRL
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/clients/:clientId/employeePositions/:positionId

Note
Обновление также возможно через использование пакетного метода выгрузки, см. описанеи выше

4

Удаление Должности из справочника Должностей
Status
subtle true
colour Yellow
title Gdoc

DELETE /api/v1/clients/:clientId/employeePositions/:positionId

Удаление происходит не через отметку об удалении, а через удаление объекта из базы данных, поэтому удаление Должности возможно только если нет ни одного сотрудника, привязанного к Должности.

Управление справочником Типов Документов

Tip

title	Цель

Тип документа - не является обязательным для создания документа, однако имеет большое значение в управлении ЛНА

и может быть связан с развитием функционала системы HRlink

API-методы

Примечания

1

Получение справочника типов документов
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/documentTypes

При создании пространства Клиента, HRlink передает базовый список типов документов, с которых уже можно начинать работу. Поэтому чтобы не создавать дублирующие типы заявлений может быть полезным сперва изучить заданные типы документов.

Однако созданный Типы документов можно наполнить идентификаторами ИС Клиента и управлять видимостью типов документов.

2

Обновление типа документа по ID своей ИС
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/documentTypes/:externalId/externalId

Обновления типа документа по ID HRL
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/documentTypes/:documentTypeId

Для типов документов, созданных Администратором можно обновить все параметры.

Для типов документов HRlink (дефолтный справочник) можно изменять только видимость типа документа и extertnalId

Управление справочником Шаблонов Заявлений

Tip

title	Цель

Подготовить справочник Шаблонов Заявлений, которыми сможет воспользоваться Сотрудник при подаче Заявлений.

К подготовке можно отнести актуализацию - корректировку имён шаблонов и видимость для Сотрудника при подаче

Note

title	Предусловие

Первичное создание шаблона заявления сейчас доступно только через обращение в Службу Заботы о Клиентах, дальнейшее использование и настройка - доступны как в ЛК, так и по API

Подробнее о заявлениях см. раздел Заявление

API-методы

Примечания

1

Получение типов заявлений
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/applicationTypes

Для того, чтобы Сотрудник мог подавать заявления из шаблона, требуется настроить шаблоны.

Настройка шаблонов идёт с указанием идентификатора шаблона

В данных типа заявления возвращаются кастомные поля

2

Получение файла шаблона заявления
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/clients/:clientId/applicationTypes/:applicationTypeId/templateFile

Шаблонный файл может быть доработан Клиентом в плане содержания статического текста и размещения доступных переменных, значения которых будут использоваться при генерации заявления из шаблона.

Клиент так же может задать собственное форматирование файла - шрифты, кегель, отступы и т.д.

Оформление шаблона происходит вне рамок информационных систем.

3

Получение системных полей для заявлений
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/applicationTypeFields/system

Системные поля - это поля, которые предопределены HRlink и являются общими для всех типов заявлений.

Кроме системных полей есть ещё кастомные поля, которые определены для каждого заявления в отдельности. Получение их указано в первом методе сценария.

4

Загрузка подготовленного файла шаблона заявления (doc, docx)
Status
subtle true
colour Yellow
title Gdoc

POST /api/v1/files

Поле, в котором передается файл, может иметь любое имя.

В одном запросе можно передать один или несколько файлов. В случае отправки нескольких файлов следует давать полям разные имена.

Для Каждого ЮЛ на один тип Заявления может быть задан собственный шаблон.

5

Обновление типа заявления
Status
subtle true
colour Yellow
title Gdoc

PUT /api/v1/applicationTypes/:applicationTypeId

При обновлении Кадровик

задаёт названия Шаблонов, используемых Клиентом,
привязывает идентификатор обновлённого шаблонного файла
задает видимость
задаёт какое поле с типом дата можно считать датой события
- например, для типа заявления = "Заявление на отпуск" датой события можно считать дату начала отпуска. Дата, которая обозначена как дата события будет отображаться в ЛК в реестре Заявлений Кадровика. Также при получении данных заявления можно будет получить информацию о дате события, что позволит оптимизировать обработку разных типов заявлений, для которых важна какая-либо дата

Предыдущий раздел

Следующий раздел

Поиск документации

Livesearch

spaceKey	WIKI
size	large

Page tree

Versions Compared

Old Version 5

New Version 6

Key

Управление структурой и Справочниками

Примечание

Обновление данных Юрлица

Управление справочником Отделов

Управление справочником Должностей

Управление справочником Типов Документов

Управление справочником Шаблонов Заявлений

Предыдущий раздел

Следующий раздел

Page tree

Page History

Versions Compared

Old Version 5

New Version 6

Key

Управление структурой и Справочниками

Примечание

Обновление данных Юрлица

Управление справочником Отделов

Управление справочником Должностей

Управление справочником Типов Документов

Управление справочником Шаблонов Заявлений

Предыдущий раздел

Следующий раздел