api.ou Работа с оргструктурой

Работа с отделами

• api.ou.nestedEmployees(ou)

  Получение сотрудников отдела.

  Параметр метода:

  • ou — объект-отдел, для которого ищутся сотрудники.

  Возвращает сотрудников в этом отделе и во всех вложенных.

• api.ou.nestedOUs(ou)

  Получение вложенных отделов.

  Параметр метода:

  • ou — объект-отдел, для которого ищутся вложенные отделы.

  Возвращает UUID отделов, вложенных в отдел. Список результатов включает отдел OU.

• api.ou.listNestedOUs(ou_uuid)

  Получение вложенных отделов по UUID.

  Параметр метода:

  • ou_uuid — UUID отдела, для которого ищутся вложенные отделы.

  Возвращает UUID отделов, вложенных в отдел с ou_uuid. Список результатов не включает сам отдел с ou_uuid.

Распространение соглашений

• api.ou.distributeAgreements(agreement, recipients)

  api.ou.distributeAgreements(agreement, rootRecipient) (РЕКОМЕНДУЕМЫЙ) — распространение соглашений. Для работы только с активными объектами.

  api.ou.distributeAgreements(agreement, recipients, ignoreRemoved)

  api.ou.distributeAgreements(agreement, rootRecipient, ignoreRemoved)

  Работа либо только с активными объектами, либо с архивными и активными одновременно.

  Параметры метода:

  • agreement — соглашение, либо его UUID, либо коллекция соглашений, либо их UUID;
  • recipients — коллекция UUID получателей соглашения (сотрудник, отдел, команда). Соглашение распространяется только на указанных получателей;
  • rootRecipient — UUID команды или отдела. Соглашение будет распространено на все объекты, вложенные в указанный;

  • ignoreRemoved — условие отбора объектов для добавления соглашений:

    • true — только с активными объектами;
    • false — активные и архивные объекты.

• api.ou.assignAgreementToEmployee(employee, agreement)

  Распространение соглашений.

  Параметры метода:

  • recipients — сотрудник, который связывается с соглашением;
  • agreement — соглашение, связываемое с сотрудником.

Отзыв соглашений

• api.ou.removeAgreements(agreement, recipients)

  api.ou.removeAgreements(agreement, rootRecipient)

  Для работы только с активными объектами.

  api.ou.removeAgreements(agreement, recipients, searchMode)

  api.ou.removeAgreements(agreement, rootRecipient, searchMode)

  Работа с объектами, в зависимости от выбранного типа поиска — с активными, архивными или с архивными и активными одновременно.

  Параметры метода:

  • agreement — соглашение, либо его UUID, либо коллекция соглашений, либо их UUID;
  • recipients — коллекция UUID получателей соглашения (сотрудник, отдел, команда);
  • rootRecipient — UUID команды или отдела. Соглашение будет отозвано у всех вложенных объектов;

  • searchMode — тип поиска объектов: только для активных объектов (active), только для архивных объектов (removed) или всех(активные и архивные (all).

Получение списка участников команд

• api.team.getTeamMembers(teamUUIDs, removed)

  Параметры метода:

  • teamUUIDs — коллекция уникальных идентификаторов команд
  • removed — true (если необходимо вернуть только архивных участников команд); false (если необходимо вернуть только неархивных участников команд).

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

  Если необходимо получить UUID участников команд:

  api.team.getTeamMembers(Collection<String> teamUUIDs, boolean removed)?.UUID