Бипуим: Документация
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
  3. Данные

Каталоги (Catalogs)

Ресурс Catalog — каталог с записями.

Список каталогов

URL: {domain}/api/v1/catalogs?sectionId={sectionId}

Метод: GET

Параметры:

  • sectionId (строка) — фильтр по отделу

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

[{
    "id": "1",
    "sectionId": "1",
    "icon": "user-2",
    "name": "My catalog",
    "fieldPrivilegeCodes": {
        "9": "edit",
        "22": "edit"
    }
},
{
    "id": "2",
    "sectionId": "2",
    "icon": "user-3",
    "name": "Another catalog",
    "fieldPrivilegeCodes": {}
}]

Получить каталог

URL: {domain}/api/v1/catalogs/{catalogId}
    {?fields}

Метод: GET

Параметры:

  • catalogId (строка) — идентификатор каталога

  • fields (json array, опционально) — набор возвращаемых полей записей, формат: ["2", "3"]. Доступно с версии API 1.9.1.

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

{
    "id": "1",
    "sectionId": "1",
    "icon": "icon1",
    "name": "My catalog",
    "privilegeCode": "admin", // право на каталог
    "fieldPrivilegeCodes": { // права на поля для пользователя от имени которого пришел запрос
        "9": "edit",
        "22": "edit"
    },
    "fields": [
        {
            "id": "1",
            "name": "User",
            "type": "group"
        },
        {
            "id": "2",
            "name": "Username",
            "type": "text",
            "config": {
                "type": "mail"
            }
        },
        {
            "id": "3",
            "name": "Birthday",
            "type": "date",
            "config": {
                "time": false
            },
        {
            "id": "28",
            "name": "Связанный каталог",
            "type": "object",
            "hint": "",
            "required": false,
            "apiOnly": false,
            "config": {
                "multiselect": true,
                "accessOnly": false,
                "catalogs": [
                    {
                        "id": "25",
                        "title": "Связанный каталог",
                        "icon": "business-23",
                        "removed": false
                    }
                ],
                "views": [],
                "fields": {
                    "25": [
                        {
                            "id": "2",
                            "name": "Число",
                            "type": "number",
                            "hint": "",
                            "required": false,
                            "apiOnly": false,
                            "config": {
                                "unit": "",
                                "defaultEmptyValue": null
                            }
                        },
                        {
                            "id": "3",
                            "name": "Дата",
                            "type": "date",
                            "hint": "",
                            "required": false,
                            "apiOnly": false,
                            "config": {
                                "time": false,
                                "defaultValue": false
                            }
                        },
                        {
                            "id": "4",
                            "name": "Связанный каталог",
                            "type": "object",
                            "hint": "",
                            "required": false,
                            "apiOnly": false,
                            "config": {
                                "catalogs": [],
                                "views": [],
                                "defaultEmptyValue": [],
                                "fields": {}
                            }
                        }
                    ]
                },
                "defaultEmptyValue": []
            }
        }
    ]
}

Создать каталог

URL: {domain}/api/v1/catalogs/

Метод: POST

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

{
    "name": "New catalog",
    "icon": "icon",
    "sectionId": "2",
    "fields": [{
        "name": "Секция",
        "hint": "",
        "type": "group",
        "config": {}
    }, {
        "name": "Текст",
        "hint": "Подсказка к полю текст",
        "type": "text",
        "config": {
            "type": "text"
        }
    }, {
        "name": "Дата",
        "hint": "",
        "type": "date",
        "config": {
            "time": false,
            "notificationField": null
        }
    }, {
        "name": "Набор галочек",
        "hint": "",
        "type": "checkboxes",
        "config": {
            "items": [{
                "name": "1"
            }, {
                "name": "2"
            }, {
                "name": "3"
            }]
        }
    }, {
        "name": "Прогресс",
        "hint": "",
        "type": "progress",
        "config": {}
    }, {
        "name": "Сотрудник",
        "hint": "",
        "type": "user",
        "config": {
            "multiselect": false
        }
    }, {
        "name": "Связанный объект",
        "hint": "",
        "type": "object",
        "config": {
            "multiselect": false,
            "catalogs": [{
                "id": "11"
            }]
        }
    }, {
        "name": "Файл",
        "hint": "",
        "type": "file",
        "config": {
            "multiselect": false
        }
    }]
}

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

{
    "id": "3" // идентификатор созданного каталога
    "values": {
        // значения полей аналогично получению каталога
    }
}

Изменить каталог

URL: {domain}/api/v1/catalogs/{catalogId}

Метод: PATCH

Параметры:

  • catalogId (строка) — идентификатор каталога

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

{
    "name": "My catalog1",
    // если не передать параметр (например icon), то он изменен не будет
    "fields" : [
        {
            "id": "1", // чтобы сохранить существующее поле, нужно указать его id
            "name": "User",
            "type": "group"
        },
        {
            "id": "2",
            "name": "User full name", // в существующем поле можно изменить имя
            "type": "text", // тип заменить нельзя
            "config": { // в существующем поле можно изменить его параметры
                "type": "mail"
            }
        },

        // поле 3 в новом наборе полей не передали: если оно было, оно будет удалено

        // создали новое поле
        {
            "name": "Age",
            "type": "number"
        }
    ]
}

Ответ: 200 OK

Удалить каталог

URL: {domain}/api/v1/catalogs/{catalogId}

Метод: DELETE

Параметры:

  • catalogId (строка) — идентификатор каталога

Ответ: 200 OK

PreviousДанныеNextЗаписи (Records)

Last updated 2 years ago

Возможные значения для icon описаны в .

🔌
документации