search string side menu

Объект организационной структуры

Используется для получения текущей организационной структуры в виде дерева, для создания нового дерева организационной структуры или ее нового элемента, а также для сохранения заданного дерева в качестве текущей оргструктуры.

const tree = await System.organisationStructure.fetchTree();

const newItem = System.organisationStructure.createItem('Директор по маркетингу', OrganisationStructureItemType.Position);

tree.getRoot().addChild(newItem);
const errs = await tree.validate();
if (errs.length === 0) {
    // Валидация успешна
    const sErrs = await System.organisationStructure.save(tree);
}

Hierarchy

  • OrganisationStructure

Methods

createItem

  • Метод позволяет создать новый элемент организационной структуры.

    Parameters

    • name: string

      Название создаваемого элемента.

    • type: OrganisationStructureItemType

      Тип создаваемого элемента.

      const item = System.organisationStructure.createItem('Директор по развитию', OrganisationStructureItemType.Position);

    Returns OrganisationStructureItem

createTree

  • Метод позволяет создать новое дерево организационной структуры.

    Parameters

    • rootName: string

      Название должности корневого элемента.

      const tree = System.organisationStructure.createTree('Генеральный директор');

      В результате будет создано дерево с единственным элементом — корневым.

    Returns OrganisationStructureTree

fetchTree

  • Метод позволяет загрузить дерево текущей организационной структуры.

    const tree = await System.organisationStructure.fetchTree();

    Returns Promise<OrganisationStructureTree>

save

  • Метод позволяет сохранить заданное дерево в качестве текущей организационной структуры.

    Перед сохранением организационная структура будет автоматически провалидирована.

    Parameters

    • tree: OrganisationStructureTree

      Сохраняемое дерево.

      const errs = await System.organisationStructure.save(tree);
if (errs.length === 0) {
     // Успешно сохранено
}
В случае если сохранение не было выполнено, метод возвращает массив с ошибками.
При успешном сохранении возвращается пустой массив.

    Returns Promise<ErrorObject[]>

search

  • Метод позволяет выполнять поиск по оргструктуре.

    С помощью данного метода можно фильтровать, выводить результаты начиная с определенного элемента, ограничивать выборку, сортировать, получать первый элемент и страницу результатов.

    Пример использования:

    const position = await System.organisationStructure.search().where(position => position.name.eq('Генеральный директор')).first();

    Returns OrganisationStructureSearch