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

Получить реестр оргструктур клиента

POST 
/api/v1/clients/:clientId/orgStructures/getRegistry

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

Возвращает страницу реестра оргструктур клиента. Синтетическая Юридическая оргструктура инжектится первым элементом, если попадает под фильтр статуса, режима и поиска. Реальные (управленческие) оргструктуры сортируются по createdDate ASC, id ASC.

Режим запроса (registryType) сам по себе не порождает ошибку доступа — бэк использует значение в связке с правом ORG_STRUCTURES_UPDATE у пользователя клиента как флаг фильтрации: режим HR без этого права обрабатывается как EMPLOYEE.

Допустимые статусы по режиму: в HR-режиме — statuses из тела (null/пустой список — все три статуса без фильтра); в режиме EMPLOYEE — пересечение с {PUBLISHED} (null/пустой список — только PUBLISHED; непустой список без PUBLISHED — пустой результат).

Фильтр доступа в режиме EMPLOYEE: оргструктуры с доступом PUBLIC видны всем; с доступом RESTRICTED — только если пользователь клиента состоит в структуре хотя бы одним активным сотрудником; с доступом PRIVATE — не видны. К Юридической оргструктуре фильтр доступа не применяется — она всегда видна.

Query-параметр ids задаёт точечную выборку без пагинации: непустой список означает «вернуть только эти структуры» — limit/offset из тела при этом игнорируются, а фильтры по статусу, поиску и режиму применяются. IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях., которых нет у клиента либо не проходящие фильтры, молча пропускаются; дубликаты отбрасываются молча.

Поле верхнего уровня ответа — orgStructures (страница реестра). Поле totalCount не возвращается — пагинацию на фронте строят по факту orgStructures.length < limit.

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

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

  • Тело запроса задано.

  • registryType задан и распознан как допустимое значение.

  • statuses, если заданы, — список допустимых значений статуса без null-элементов.

  • limit не отрицательный; превышение максимального значения пагинации недопустимо. Игнорируется при непустом query-параметре ids.

  • offset не отрицательный. Игнорируется при непустом query-параметре ids.

  • ids (query), если задан, — список корректных UUID; размер исходного списка до дедупликации не превышает максимальное значение пагинации.

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

Дополнительных проверок прав доступа нет — реестр доступен любому активному пользователю клиента.

Request​

Responses​

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