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

Получить карточку узла оргструктуры

GET 

/api/v1/clients/:clientId/orgStructures/:id/elements/:elementId

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

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

Для Юридической оргструктуры elementId трактуется как реальный IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. отдела. Синтетический узел «Сотрудники без отдела» поддерживается и возвращается всегда, независимо от количества активных сотрудников без отдела — с нулевыми счётчиками, если такие сотрудники отсутствуют.

By-externalIdexternalIdВнешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. на уровне узлов не поддерживается.

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

  • IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID; клиент существует, не удалён, к нему относится пользователь, выполняющий операцию.

  • IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. оргструктуры соответствует формату UUID; оргструктура существует и принадлежит указанному клиенту.

  • Видимость оргструктуры пользователю: пользователь с правом ORG_STRUCTURES_UPDATE видит любую оргструктуру; обычный сотрудник — только опубликованную с типом доступа PUBLIC либо RESTRICTED, в которой он состоит. Для Юридической проверка пропускается — она видна всем активным пользователям клиента.

  • IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. узла соответствует формату UUID; узел существует и принадлежит указанной оргструктуре.

  • Функционал оргструктур включён в настройках клиента (org_structures_enabled_date задан).

Request

Responses

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