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

Получить карточку оргструктуры по внешнему ID

GET 
/api/v1/clients/:clientId/orgStructuresByExternalId/:externalId

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

Возвращает карточку оргструктуры по externalId: метаданные структуры и полное дерево элементов плоским списком elements[] (с массивом headEmployees и счётчиком employeesCount на каждом узле). UI строит иерархию по parentId; порядок узлов стабильный — name ASC, id ASC. Сотрудники узлов, кроме руководителей, отдаются отдельным эндпоинтом с пагинацией.

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

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

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

  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.

  • Оргструктура с заданным externalId существует в клиенте.

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

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

Request​

Responses​

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