Versions Compared

Key

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

Table of Contents

Postman collection

Важные замечания

  • Пользовательская инструкция доступна по ссылке https://wiki.hr-link.ru/bin/view/Main/Administrator-/Spravochniki-/Pol%D1%8Czovatel%D1%8Cskie-spravochniki/
  • В примерах используется массовая синхронизация пользовательских справочников, но управление справочниками доступно и через единичные методы методы https://docs.myhrlink.ru/public/openapi/hr-link/#tag/directoriesCustomStructures
  • У администратора в UI HRlink есть возможность изменять загруженные справочники и их элементы. Изменения, которые внесет администратор в синхронизированных справочниках, будут потеряны при следующей выгрузке справочников через АПИ.
  • В примерах используется аутентификация через мастер-токен, но допускается использовать User-Api-Token (токен администратора/кадровика, который получается под аватаркой в UI)
  • В заголовках имперсонализации используются внешние идентификаторы пользователя, но допускается использовать другой доступный идентификатор (HRlink, из указанной системы и пр.).

Postman collection

View file
nameПользовательские справочники.postman_collection.json
height250

Выгрузить пользовательские справочники в HRlink

...

ПеременнаяОписаниеОбязательность

tenantHost

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

да

clientId

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

clientUserExternalId

Внешний ИД пользователя клиентада
employeeExternalIdВнешний ИД сотрудника пользователя клиентада
legalEntityExternalIdВнешний ИД юрлица клиентанет
elementExternalIdВнешний ИД элемента пользовательского справочникада
customStructureExternalIdВнешний ИД пользовательского справочникада
parentExternalIdВнешний ИД элемента пользовательского справочника, который будет являться родительским текущему элементунет
headManagerExternalIdВнешний ИД сотрудника-руководителя, который будет являться руководителем элемента (для использования в связанной функциональности)нет


Code Block
languagebash
titleПример запроса
curl --location 'https://{{tenantHost}}/api/v1/clients/{{clientId}}/bulkDataSyncTasks' \
--header 'Impersonated-User-Id: {{clientUserExternalId}}' \
--header 'Impersonated-User-Id-Type: EXTERNAL_ID' \
--data '{
    "type": "EMPLOYEE_CUSTOM_STRUCTURE_ELEMENTS",
    "data": [
        {
            "externalId": "{{employeeExternalId}}",
            "legalEntityExternalId": "{{legalEntityExternalId}}",
            "customStructureElements": [
                {
                    "externalId": "{{elementExternalId}}",
                    "customStructureExternalId": "{{customStructureExternalId}}"
                }
            ]
        }
    ]
}'

...