Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

МетодСсылка на документацию OpenAPI

POST https://{host}/api/v1/clients/{clientId}/bulkDataSyncTasks

type = EMPLOYEE_VACATIONS_PLANNING

https://docs.myhrlink.ru/public/openapi/hr-link/#tag/otherDataSync/operation/createBulkDataSyncTask

Дополнительная информация

...

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

МетодСсылка на документацию OpenAPI

PUT https://{host}/api/v1/clients/{clientId}/vacations/setPlanningState


https://docs.myhrlink.ru/public/openapi/hr-link/#tag/vacationScheduleManage/operation/setPlanningState


Дополнительная информация

  • Разрешить планирование может только  как Администратор.
    • Пользователь должен иметь право VACATIONS_CHANGE_PLANNING_STATE на уровне пользователя клиента или на уровне активного сотрудника.
ПеременнаяОписаниеОбязательность

tenantHost

Хост тенанта, на который должен быть выполнен запрос

да

clientId

ИД клиента HRlinkда
planningState

Состояние планирования отпусков в системе HRlink.

Может принимать два состояния:

  • ENABLED - Планирование разрешено.
  • DISABLED - Планирование запрещено.
да
planningYear

Год, на который устанавливается настройка планирования.

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


Code Block
languagebash
titleПример запроса
curl --request PUT \
--url 'https://{{tenantHost}}/api/v1/clients/{clientId}/vacations/setPlanningState?planningState=ENABLED&planningYear=2026' \
--header 'Impersonated-User-Id: {{clientUserExternalId}}' \
--header 'Impersonated-User-Id-Type: EXTERNAL_ID' \
--header 'master-api-token: master_token_value

...

ШАГ 3. Выгрузить спланированные отпуска 

Установить состояние возможности планирования отпусковПолучить данные о запланированных отпусках сотрудников

МетодСсылка на документацию OpenAPI
PUT https

POST https://{

host

host}/api/v1/clients/{clientId}/

vacations

employees/

setPlanningState

getPlannedVacationPeriod


https://docs.myhrlink.ru/public/openapi/hr-link/#tag/
vacationScheduleManage
vacationScheduleGet/operation/
setPlanningState
getPlannedVacationPeriod


Дополнительная информация

  • Разрешить планирование может только  Получить спланированные периоды отпусков может  как Администратор,  так и Кадровик.
    • Пользователь должен иметь право VACATIONSEMPLOYEE_CHANGE_PLANNING_STATE на PLANNED_VACATIONS на уровне пользователя клиента или на уровне активного сотрудника.
ПеременнаяОписаниеОбязательность

tenantHost

Хост тенанта, на который должен быть выполнен запрос

да

clientId

ИД клиента HRlinkда
planningState

Состояние планирования отпусков в системе HRlink.

Может принимать два состояния:

  • ENABLED - Планирование разрешено.
  • DISABLED - Планирование запрещено.
даplanningYear

Год, на который устанавливается настройка планирования.

  • Допустимо указывать значение только текущего или следующего года.
  • vacations{}Данные для фильтрации периодов планируемых отпусковда
    startDateFromНачало периода, в который должно попадать начало запрашиваемого планируемого отпуска.нет
    startDateToКонец периода, в который должно попадать начало запрашиваемого планируемого отпусканет
    status

    Статус запрашиваемых планируемых отпусков сотрудников.

    нет
    employees[]

    Список сотрудников, по которым необходимо получить отпуска.

    Если массив пуст ...

    да

    id

    ID сотрудника в системе HRlink.нет
    externalIdID сотрудника во внешней системе.нет
    department[]

    Список отделов, по которым необходимо получить отпуска.

    Если массив пуст ...

    да

    id

    ID отдела в системе HRlink.нет
    externalIdID отдела клиента во внешней системе.нет
    legalEntity[]

    Список юрлиц, по которым необходимо получить отпуска.

    Если массив пуст...

    да

    id

    ID юрлица клиента в системе HRlink.нет
    externalIdID юрлица клиента во внешней системе.нет
    limitКоличество возвращаемых при запросе элементов.нет
    offsetКоличество элементов, которые нужно пропустить при выборке.нет
    withoutDismissedEmployees

    Вернуть ответ без уволенных сотрудников?

    По умолчанию, уволенные сотрудники включены  в результат ответа.

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

    нет


    Code Block
    languagebash
    titleПример запроса
    curl --request PUTPOST \
    --url 'https://{{tenantHost}}/api/v1/clients/{clientId}/vacations/setPlanningState?planningState=ENABLED&planningYear=2026employees/getPlannedVacationPeriod' \
    --header 'Impersonated-User-Id: {{clientUserExternalId}}' \
    --header 'Impersonated-User-Id-Type: EXTERNAL_ID' \
    --header 'master-api-token: master_token_value
    --data '{
      "vacations": {
        "startDateFrom": "2026-01-01",
        "startDateTo": "2026-12-01",
        "status": "ALL"
      },
      "employees": [
        {
          "externalId": "{{Внешний ИД сотрудника}}"
        }
      ],
      "department": [
        {
          "externalId": "{{Внешний ИД отдела}}"
        }
      ],
      "legalEntity": [
        {
          "externalId": "{{Внешний ИД юрлица}}"
        }
      ],
      "limit": null,
      "offset": null,
      "withoutDismissedEmployees": true
    }'
    


    Пример ответа

    No Format
    {
      "result": true,
      "employeePlannedVacationPeriods": [
        {
          "id": "{{Внутренний ИД сотрудника}}",
          "externalId": "{{Внешний ИД сотрудника}}",
          "periods": [
            {
              "vacationType": "Основной",
              "vacationStatus": "Ожидает согласования",
              "result": true"dateFrom": "2026-09-15",
              "dateTo": "2026-09-28"
            },
            {
              "vacationType": "Дополнительный",
              "vacationStatus": "Согласовано",
              "dateFrom": "2026-10-01",
              "dateTo": "2026-10-03"
            } 
          ]
        }
      ]
    }




    Загрузка отпусков из внешней системы в HRlink

    ...