Бипуим: Документация
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
  • Свойства
  • Секция «Получить запись»
  • Секция «Получить»
  • Секция «Результат»
  • Формат значения полей (values)
  • Пограничные события
  1. Документация
  2. Автоматизации
  3. Сценарии
  4. Компоненты

Получить запись

PreviousШлюз «И» (распараллеливание)NextНайти записи

Last updated 7 months ago

Используется для получения значений полей конкретной записи из Бипиума по её идентификатору. Процессы имеют доступ к записям минуя правовую политику.

Свойства

Секция «Получить запись»

Указать каталог Способ выбора каталога для получения записи. Доступные варианты: из списка и через переменную. Вариант «из списка» подойдет, когда вы знаете из какого каталога хотите получить запись. Вариант «через переменную» используется, если нужно получить запись из разных каталогов в зависимости от логики в сценарии.

Каталог Свойство доступно при выбранном значении Указать каталог = Из списка. Выбор каталога из числа доступных в системе для получения записи. Формат: выбор из списка каталогов.

ID каталога Свойство доступно при выбранном значении Указать каталог = Через переменную. Идентификатор (ID) каталога, из которого нужно получить запись. Формат: значение/выражение.

ID записи Идентификатор (ID) записи, которую нужно получить. Формат: значение/выражение.

Секция «Получить»

Поля Способ указания какие поля записи должны вернуться в результате. Доступные варианты: все поля и заданные. Вариант «все поля» вернет все поля каталога, включая расширенные поля связанных записей, которые заданы в настройках полей каталога. Вариант «заданные» позволяет указать какие именно поля вернуть, в том числе и расширенные поля у связанных записей.

ID полей Свойство доступно при выбранном значении Поля = Заданные. Массив идентификаторов (API ID) полей каталога, указанных через запятую. Ограничение списка полей уменьшает размер данных в сценарии, и увеличивает скорость их получения. Также компонент позволяет получить любые расширенные поля у связанных записей. Формат: значение/выражение.

Формат указания :

[
  {
    fieldId: IDполя1,
    fields: {
      IDкаталога1: [ IDрасширенногоПоля1, IDрасширенногоПоля2, ... ],
      IDкаталога2: [ IDрасширенногоПоля3, IDрасширенногоПоля4, ... ],
      ...
    }
  },
  {
    fieldId: IDполя2,
    ...
  }
]
  • IDполяX — поле выбранного каталога

  • IDрасширенногоПоляХ — идентификаторы полей связанного каталога, которые нужно получить.

Пример

[ 4, {fieldId: 5, fields: { 27: [2,6]} }, 8, {fieldId: 9, fields: { 19: [3,4]} } ]

Получает 4, 5, 8 и 9 поля. Для 5 поля дополнительно возвращаются 2 и 6 поле у связанных записей из каталога 27, а для 9 поля — 3 и 4 поле у записей из каталога 19.

Секция «Результат»

Сохранить в Выходной параметр. Сохранит результат в указанную переменную. Формат: имя переменной.

{
    id: '11',
    title: 'Название записи',
    values: {
        'field_id' : field_value,
        ...
    }
}

В поле «Сохранить в» можно указать ключ объекта и результат сохранится как значения этого ключа.

Пример

Если указать в поле «Сохранить в» переменнуюdata.temp, то результат будет выглядеть следующим образом:

data: {
    "temp": {
        id: '11',
        title: 'Название записи',
        values: {
            'field_id' : field_value,
            ...
        }
    }
}

Формат значения полей (values)

Переменная с результатом («сохранить в») содержит объект values — значения полей записи. Ключи объекта — идентификаторы полей. Формат значений для разных типов полей разный:

  • Однострочный текст = "Однострочный текст"

  • Многострочный текст = "Многострочный текст"

  • Дата = "2015-11-06T21:00:00.000Z"

  • Категория / набор галочек = [2] или несколько значений [2,3,4], без значения []

  • Вопрос = 2

  • Число = 3.2

  • Прогресс = 28(допустимо от 0 до 100)

  • Звезды = 5 (допустимо от 0 до 5)

  • Контакт = массив объектов [{"contact": "8-901-234-56-78", comment: "Секретарь"}, {...}]

  • Адрес = объект предоставляемый из DaData

{
            "value": "г Москва, Кремлевская наб",
            "provider": "dadata",
            "data": {
                "flat_type": null,
                "house": null,
                "city_kladr_id": "7700000000000",
                "postal_code": null,
                "area_with_type": null,
                "settlement_kladr_id": null,
                "street": "Кремлевская",
                "fias_id": "ede88e7f-8788-4851-a4d8-ff6d748f9bfe",
                "house_fias_id": null,
                "street_kladr_id": "77000000000160300",
                "region_with_type": "г Москва",
                "street_fias_id": "ede88e7f-8788-4851-a4d8-ff6d748f9bfe",
                "city": "Москва",
                "house_kladr_id": null,
                "kladr_id": "77000000000160300",
                "block_type": null,
                "block": null,
                "settlement_fias_id": null,
                "city_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                "geo_lat": "55.748711",
                "area_fias_id": null,
                "country": "Россия",
                "region_kladr_id": "7700000000000",
                "street_with_type": "Кремлевская наб",
                "house_type": null,
                "flat": null,
                "region_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                "geo_lon": "37.61697",
                "settlement_with_type": null,
                "area_kladr_id": null,
                "city_with_type": "г Москва"
            }
        }
  • Связанная запись = массив объектов[ {catalogId: '11',recordId: '91', catalogTitle: 'Название каталога', recordTitle: 'Название записи', isRemoved: false}, {...} ]

  • Сотрудник = массив объектов [{id: '21', title: 'Имя', isRemoved: false}, {...}]

  • Файл = массив объектов

Как получить значение поля?

Допустим, вы сохранили найденную запись в переменную r. Чтобы обратиться к коллекции значений полей, используйте выражение r.values.

Как получить значение сложного поля?

Для сложных типов полей (значения которых представлены массивом, например: категория, связанный объект, контакт, сотрудник, файл) значение поля будет массивом. Чтобы узнать сколько элементов в массиве используйте выражение r.values['4'].length, а чтобы получить значение, например, 0-го элемента массива: r.values['4'][0], чтобы обратится к его свойству, например recordId у поля типа связанный объект: r.values['4'][0].recordId.

Однако, если вы обратитесь к параметру (например recordId) к элементу массива, которого нет (например, когда в поле не выбрано никакое значение), то сценарий прервется с ошибкой. Поэтому, прежде чем получить свойство у объекта в массиве, нужно сначала проверить что массив не пустой. Это можно сделать с помощью компонентов ветвления сценария (шлюзов) и проверки условий на исходящих соединительных линиях, или с помощью выражения: r.values['4'].length && r.values['4'][0].recordId.

Это выражение проверяет что в 4-м поле в массиве есть элементы, и если есть хотя бы один, то возвращает значение свойства recordId в 0-м элементе. Именно это значение будет присвоено переменной. Если элементов нет, то переменной будет присвоено 0.

Пограничные события

Компонент поддерживает 2 типа пограничных событий:

  • Ошибка — выход из компонента, если произошла какая-либо ошибка

  • Таймаут — выход из компонента, спустя заданное ограничение по времени

Если компонент завершился с ошибкой, но на нем не было пограничного события, то процесс завершается. Сообщение ошибки возвращается в результатах процесса.

IDкаталогаХ — Идентификатор каталога связанного каталога. Поле «» может иметь несколько источников. Например каталог «Договор» в поле контрагент может ссылаться на каталоги «Клиентов», «Партнеров» и «Подрядчиков». Для каждого каталога источника можно указать какие именно поля требуется получить.

[ {title: "имя", url: "http://путь", size: 45654, mimeType: "image/png"}, {...} ] где mimeType— ​

Чтобы получить значение, например, 4-го поля записи, используйте компонент и укажите выражение r.values['4'].

🤖
допустимые значения
назначение переменных
расширенных полей
связанные каталог