Бипуим: Документация
8-800-505-24-05Сайт Бипиум
  • 😎Отвечаем на ваши вопросы
  • 🎂Версии и обновления
  • ❗Обновление до версии 2.0
  • Документация
    • 🆕С чего начать
      • Регистрация и вход
      • Создаем каталоги и записи
      • Формируем отчёты
      • Настраиваем правовую политику
      • Применяем автоматизации
    • ⚙️Конструктор данных
      • Отделы
      • Каталоги
        • Редактирование структуры
        • Настройка отображения
        • Поиск и фильтрация
        • Импорт записей
          • 📗Импорт из Excel
        • Экспорт записей
        • Активность
      • Системные каталоги
        • Сотрудники
        • События
        • Внешние запросы
        • Сценарии
        • Процессы
        • Доступ к сервисам
        • Вебхуки
      • Виды
      • Записи
    • 📊Отчеты
      • Графики
    • 🔑Права
      • Правила
      • Привилегии
      • Правовые группы
      • Правовые виды
      • Права на поля
      • Комбинация прав
    • 🤖Автоматизации
      • События
        • Изменение данных
        • Внешние запросы
      • Сценарии
        • Компоненты
          • Начало процесса
          • Конец процесса
          • Таймер
          • Ошибка
          • Шлюз «ИЛИ» (условное ветвление)
          • Шлюз «И» (распараллеливание)
          • Получить запись
          • Найти записи
          • Изменить запись
          • Создать запись
          • Удалить запись
          • Структура каталога
          • Загрузить файл
          • Сгенерировать документ
          • Назначение переменных
          • Код (Javascript)
          • Веб-запрос
          • SQL-запрос
          • Конвертер
          • Парсер
          • Запуск процесса
          • Получение почты
          • Отправка почты
          • Соединяющая линия
          • Отправить сообщение
        • Переменные
        • Выражения
        • Входные и выходные параметры компонентов
        • Примеры настройки
          • Условие
          • Цикл
      • Ограничения
  • Лицензии
    • 🌐Тип лицензирования
  • Примеры
    • 🔑Права доступа к данным
    • 🤖Автоматизации
      • Выгрузка файлов на Яндекс Диск
      • Отправка на больничный
      • Автоматизация оплаты счетов
      • Создание наименований записей
      • Расчет скидок для клиентов
      • Запрет на создание дубликатов в каталоге
      • Автозаполнение данных по ИНН
      • Переброс данных между связанными каталогами
      • Очередь сценариев
      • Отслеживание заявок с сайта помощью UTM-меток
      • Просрочка задач по дедлайну
      • Реализация механизма согласования записей
      • Массовое изменение записей
      • Создание каталога для рассылки почты
      • Перенос данных между системами Бипиума
      • Импорт данных из Excel
      • Генерация счет-фактуры
      • Генерация excel-отчетов
      • Планировщик задач
      • Импорт банковских выписок
      • Производственный календарь
      • Складской учет
  • Интеграции
    • 🥂Методы интеграции
      • Интеграция данных
        • API
        • Вебхуки (webhooks)
      • Интеграция интерфейса
        • Веб-формы
        • Веб-расширения
      • Примеры интеграций
        • Тильда
          • Прием данных с формы Tilda
          • Интеграция веб-интерфейса в Tilda
        • Интеграция с сервисом «DaData»
        • Интеграция c «Единой информационной системой в сфере закупок»
        • Мессенджеры
          • Интеграция с Telegram-ботом
        • Почтовые сервисы
          • UniSender
          • MailChimp
        • Сервисы Google
          • Google Calendar
        • Телефония
          • Oktell
            • Панель телефонии Oktell
            • Компонент Bpium в Oktell
        • 1C
    • 🔌API
      • Данные
        • Каталоги (Catalogs)
        • Записи (Records)
        • Связи (Relations)
        • Истории (Histories)
        • Файлы (Files)
        • Отделы (Sections)
        • Виды (Views)
        • Сообщения (Messages)
      • Агрегация
        • Разложения (Values)
        • Сводка (Totals)
      • Отчеты
        • Дашборды (Boards)
        • Графики (Widgets)
      • Поисковые выборки
        • Доступные связи (AvailableRecords)
        • Доступные условия фильтра (AvailableFilterRecords)
        • Сотрудники (Users)
        • Контакты (Contacts)
      • Права (Rights)
      • Профиль (Profile/me)
  • Установка на сервер
    • 🧱Архитектура
      • Варианты разворачивания
    • 🖥️Требования
    • 📂Установка как служба
    • 🛳️Установка через Docker
    • 🎛️Мультидоменная среда
    • 🆘Материалы
      • TLS/SSL Сертификат
      • Параметры config.env
        • Для Bpium
        • Для Bpium S3
        • Для Bpium BPM
      • Запуск
      • Обсуживание
        • Активация
        • Обновление
        • Бэкап и восстановление базы
        • Брендирование (Whitelabel)
        • Удаление
      • Перенос базы из облака
      • Возможные проблемы в ходе установки и работы
  • Обучение
    • Базовый курс
      • Урок 1. Отделы
      • Урок 2. Каталоги с данными
      • Урок 3. Карточки записей
      • Урок 4. Связи между данными
      • Урок 5. Фильтры и виды
      • Урок 6. Приглашение сотрудников
      • Урок 7. Права доступа к данным
      • Урок 8. Графические отчеты
      • Урок 9. Бизнес-процессы
      • Урок 10. Интеграции
    • Технический курс
      • Урок 1. Принцип работы автоматизаций
      • Урок 2. Первая автоматизация изнутри
      • Урок 3. Валидация данных
      • Урок 4. Простые вычисления
      • Урок 5. Расчет суммы заказа
      • Урок 6. Генерация счетов/документов
      • Урок 7. Рассылка почтовых сообщений
      • Урок 8. Прием внешних данных
      • Урок 9. Отправка данных на сторонние сервисы
    • Паттерны проектирования ИС
      • Унификация
      • Упорядоченность
      • Разделение
      • Актуализация
      • Вынос параметров
      • Выделение позиций
      • Слияние
      • Дублирование
      • Типизация
      • Информирование
Powered by GitBook
On this page
  • Получить правила
  • Сохранение/пересохранение правил
  1. Интеграции
  2. API

Права (Rights)

Ресурс Rights — правила доступа сотрудников к другим ресурсам.

Получить правила

URL: {domain}/api/v1/rights{?sectionId}{?catalogId}{?recordId}{?withSearch}

Метод: GET

Параметры:

  • sectionId: (number, опционально) — идентификатор отдела

  • catalogId: (number, опционально) — идентификатор каталога

  • recordId: (number, опционально) — идентификатор записи

  • withSearch: true (boolean, опционально) — показывать ли автоматически создаваемые правила search — видеть объект в списке (по умолчанию false)

Ответ: 200 OK (application/json)

[{
    "object": {
        "sectionId": "1"
    },
    "rules": [{
            "rightSubject": { // правило для всех сотрудников
                "userAttr": "allUsers", // указатель, что правило для всех сотрудников
                "userAttrTitle": "",
                "catalogId": null,
                "catalogIcon": "",
                "recordId": null,
                "recordTitle": "Все сотрудники"
            },
            "privilegeCode": "view"
        }, {
            "rightSubject": { // правило для 5-го сотрудника
                "userAttr": "id", // указатель, что правило для сотрудника
                "userAttrTitle": "",
                "catalogId": "3", // идентификатор каталога сотрудников
                "catalogIcon": "users-1",
                "recordId": "1", // идентификатор сотрудника
                "recordTitle": "User Name" // имя сотрудника
            },
            "privilegeCode": "admin"
        }, {
            "rightSubject": { // правило для ролевой группы «Москва» в 8 поле анкеты сотрудника
                "userAttr": "8", // идентификатор поля в анкете сотрудника
                "userAttrTitle": "Город обслуживания", // название поля в анкете
                "catalogId": "34", // идентификатор связанного каталога
                "catalogIcon": "places-24", // иконка связанного каталога
                "recordId": "1", // идентификатор связанной записи
                "recordTitle": "Москва" // текстовое наименование связанной записи
            },
            "privilegeCode": "edit"
        }
    ]
}]

В примере выше три правила:

  • «Все сотрудники» могут «видеть» все записи внутри всех каталогов отдела

  • Сотрудник со свойством {id: 1} может «администрировать» отдел и все каталоги внутри неё

  • Сотрудники со свойством «Город обслуживания» ("userAttr": "8") и значением {"Город"("catalogId": "34"): "Москва"("recordId": "1")} могут «редактировать» все записи внутри всех каталогов отдела

Возможные привилегии

  • search — право видеть иконку каталога или отдела в меню, чтобы видеть некоторые записи внутри

  • view — право видеть все записи каталога (или во всех каталогов отдела)

  • edit — право редактировать все записи каталога (или каталогах отдела)

  • create — право создавать записи в каталоге (или каталогах отдела)

  • export — право выгружать в Excel записи каталога (или каталогов отдела)

  • delete — право удалять записи в каталоге (или каталогах отдела)

  • access — право задавать права на записи в каталоге (или каталогах отдела)

  • admin — право изменять отдел, создавать или менять структуру каталогов

Сохранение/пересохранение правил

URL: {domain}/api/v1/rights

В примере, создаются (или перезатираются) права на отдел 1 (sectionId: 1). Операция удаляет все ранее существующие правила на объект.

Метод: POST

Запрос: (application/json)

        {
            "object": {
                "sectionId": "1"
            },
            "rules": [
                {
                    "rightSubject": { // правило
                        "userAttr": "allUsers", // для всех сотрудников
                        "catalogId": null,
                        "recordId": null
                    },
                    "privilegeCode": "view"
                },
                {
                    "rightSubject": { // правило для сотрудника
                        "userAttr": "id", // c идентификатором
                        "catalogId": "3",
                        "recordId": "1" // один
                    },
                    "privilegeCode": "admin"
                },
                {
                    "rightSubject": { // правило для сотрудников
                        "userAttr": "8", // у кого в 8 поле анкеты сотрудника (связанный объект)
                        "catalogId": "34", // выбрана запись из 34 каталога
                        "recordId": "1" // c номером 1
                    },
                    "privilegeCode": "edit"
                }
            ]
        }

В ходе создания правил могут автоматически создасться правила с привилегиями search на родительских объектах. Для записи или вида — это каталог и отдел, для каталога — отдел.

Ответ: 200 OK (application/json)

PreviousКонтакты (Contacts)NextПрофиль (Profile/me)

Last updated 5 years ago

Подробнее о групповых правилах в статье «»

Подробнее о привилегиях в статье «»

🔌
Правовые группы
Привилегии