Выбрать курс
- Приложение для Битрикс24 "Лаборатория роботов"
- Приложение для Битрикс24 "Сквозная аналитика 2.0"
- Приложение для Битрикс24 "Уничтожитель дубликатов"
- Приложение для Битрикс24 "Межпортальные задачи"
- Приложение для Битрикс24 "Немой чат-бот"
- Приложение для Битрикс24 "Доходы и расходы CRM"
- Приложение для Битрикс24 "Продуктивный Jivosite"
157
/
330
Получение данных по сущности: реквизит
Активити (робот) "Получение данных по сущности: реквизит" предназначено для использования в роботах и может быть полезно в следующих сценариях:
- Получение всех данных реквизита по ID для дальнейшей обработки в бизнес-процессе;
- Извлечение конкретных полей (ИНН, КПП, наименование, адрес, контакты) для подстановки в документы или письма;
- Проверка содержимого реквизита перед изменением, удалением или созданием связанного банковского реквизита;
- Получение данных реквизита после активити «Добавление реквизита» для проверки или передачи в следующие шаги;
- Извлечение реквизитов для формирования отчётов, выгрузок или интеграции с 1С;
- Проверка наличия реквизита и его полей по условию (например, заполнен ли ИНН);
- Получение данных реквизита компании или контакта для заполнения полей сделки, задачи или другого активити;
- Массовое получение данных реквизитов в цикле по списку ID из поиска или итератора;
- Копирование данных реквизита в переменные для использования в условиях или расчётах;
- Валидация и сравнение реквизитов (например, совпадение ИНН у компании и контрагента).
Сценарий работы активити бизнес-процесса
Как работает активити (робот):
- Активити (робот) получает данные реквизита по указанному ID через методы REST API Битрикс24 crm.requisite.get и при необходимости crm.requisite.list (для пользовательских полей UF_CRM_*);
- Обязателен один параметр — идентификатор реквизита (id_requisite). Реквизит с этим ID должен существовать в CRM;
- В возвращаемых параметрах доступны все поля реквизита: ID, название, тип сущности, ID сущности, пресет, ИНН, КПП, наименования, ФИО руководителя, контакты, адрес, код, внешний код, активность, сортировка, а также пользовательские поля (UF_CRM_*). Список полей формируется при установке активити (робота) из crm.requisite.fields;
- Если реквизит не найден, в журнал бизнес-процесса записывается сообщение об ошибке; возвращаемые параметры не заполняются.
- Активити (робот) получает данные реквизита по указанному ID через методы REST API Битрикс24 crm.requisite.get и при необходимости crm.requisite.list (для пользовательских полей UF_CRM_*);
- Обязателен один параметр — идентификатор реквизита (id_requisite). Реквизит с этим ID должен существовать в CRM;
- В возвращаемых параметрах доступны все поля реквизита: ID, название, тип сущности, ID сущности, пресет, ИНН, КПП, наименования, ФИО руководителя, контакты, адрес, код, внешний код, активность, сортировка, а также пользовательские поля (UF_CRM_*). Список полей формируется при установке активити (робота) из crm.requisite.fields;
- Если реквизит не найден, в журнал бизнес-процесса записывается сообщение об ошибке; возвращаемые параметры не заполняются.
Описание параметров активити (робота)
| Название поля | Описание и примеры использования |
|---|---|
| Идентификатор реквизита | Обязательный параметр. ID реквизита, данные которого нужно получить. Примеры: - {=Variable:REQUISITE_ID} — ID из переменной предыдущего шага; - {=A1988_22222_92566_99999:id_requisite} — ID из возвращаемого параметра активити (робота) «Добавление реквизита»; - {=A1988_22222_92566_99999:search_result_first_string} — первый ID из результата активити (робота) «Поиск реквизитов»; - {=Iterator:Value} — для получения данных каждого реквизита в цикле по списку ID; - {=Document:ID} — если ID реквизита хранится в поле документа. |
| Запускать от имени | Сотрудник, от имени которого выполняется действие. Рекомендуется выбирать сотрудника с правами администратора. От прав зависит доступ к полям реквизита. |
| Устанавливать текст статуса | Позволяет включать установку статуса бизнес-процесса для отображения в истории, на каком шаге остановился процесс. Удобно при отладке. |
| Текст статуса | Текстовый статус, отображаемый в истории бизнес-процесса при включённом параметре «Устанавливать текст статуса». |
| Ожидать ответа | Параметр не управляется пользователем; определяет, нужно ли ожидать ответа от активити (робота) после запуска. |
| Период ожидания. Время ожидания ответа от приложения | Ограничение времени ожидания ответа (в секундах, минутах, часах, днях). Рекомендуется не менее 5 минут и не более 1 часа. При истечении времени бизнес-процесс продолжит выполнение по заданной логике. |
Примеры использования активити (робота)
| Описание примера | Решение |
|---|---|
| Получить данные реквизита после его создания | Идентификатор реквизита — {=A1988_22222_92566_99999:id_requisite} (код активити «Добавление реквизита»). Активити (робот) вернёт все поля созданного реквизита (ID, NAME, ИНН, КПП, наименование и др.) для использования в следующих шагах. |
| Извлечь ИНН и наименование для подстановки в счёт | Идентификатор реквизита — {=Variable:REQUISITE_ID}. В следующих активити (роботах) используйте возвращаемые параметры с кодами полей ИНН и полного наименования организации (названия полей соответствуют crm.requisite.fields). |
| Проверить, заполнен ли реквизит, перед отправкой документа | Идентификатор реквизита — {=Variable:REQUISITE_ID}. Получите данные реквизита, затем в условии проверьте нужное поле (например, ИНН или полное наименование). Если поле пустое — выполните ветку «Заполнить реквизит» или «Уведомить ответственного». |
| Получить данные первого реквизита из результата поиска | После активити (робота) «Поиск реквизитов» укажите идентификатор реквизита — {=A1988_22222_92566_99999:search_result_first_string}. Все поля найденного реквизита будут доступны в возвращаемых параметрах. |
| Массовое получение данных реквизитов в цикле | В цикле по итератору: идентификатор реквизита — {=Iterator:Value}. Для каждого ID реквизита активити (робот) вернёт полный набор полей. Используйте для выгрузки или обработки списка реквизитов. |
| Заполнить поля сделки или задачи данными из реквизита компании | Идентификатор реквизита — {=Variable:COMPANY_REQUISITE_ID}. Возьмите из возвращаемых параметров нужные поля (телефон, e-mail, адрес, наименование) и подставьте их в активити (робот) «Изменение сделки» или «Изменение задачи». |
| Сравнить ИНН реквизита компании и контрагента | Получите данные реквизита компании: идентификатор реквизита — {=Variable:REQUISITE_ID_1}. Сохраните значение поля ИНН в переменную. Получите данные реквизита контрагента (id_requisite — {=Variable:REQUISITE_ID_2}). В условии сравните два значения ИНН. |
| Получить контактные данные реквизита для письма | Идентификатор реквизита — {=Variable:REQUISITE_ID}. Используйте возвращаемые параметры E-Mail, Телефон, Контактное лицо (и при необходимости ФИО первого руководителя) в активити (роботе) отправки письма или уведомления. |
| Проверить наличие реквизита перед удалением | Идентификатор реквизита — {=Variable:REQUISITE_ID}. Выполните получение данных; если реквизит не найден, в журнал попадёт ошибка. При успехе используйте тот же ID в активити (роботе) «Удаление реквизита» или в условии по полям. |
| Выгрузка реквизитов для интеграции с 1С | В цикле по итератору передайте идентификатор реквизита — {=Iterator:Value}. Соберите возвращаемые параметры (ID, код, внешний код, ИНН, КПП, наименование и др.) в переменные или передайте в следующий шаг для отправки во внешнюю систему. |
Возвращаемые параметры данного активити (робота):
Активити (робот) возвращает все доступные поля реквизита в виде отдельных возвращаемых параметров. Список формируется при установке активити (робота) из метода crm.requisite.fields и может включать: ID, NAME (название), ENTITY_TYPE_ID, ENTITY_ID, PRESET_ID, поля с ИНН, КПП, полным и сокращённым наименованием, ФИО и должностью руководителя, контактами (E-Mail, Телефон, Факс), адресом, кодом, внешним кодом, активностью, сортировкой, а также пользовательские поля (UF_CRM_*). Названия возвращаемых параметров совпадают с кодами полей API. Используйте нужные параметры в следующих шагах бизнес-процесса (условия, подстановка в документы, изменение других сущностей).
Активити (робот) возвращает все доступные поля реквизита в виде отдельных возвращаемых параметров. Список формируется при установке активити (робота) из метода crm.requisite.fields и может включать: ID, NAME (название), ENTITY_TYPE_ID, ENTITY_ID, PRESET_ID, поля с ИНН, КПП, полным и сокращённым наименованием, ФИО и должностью руководителя, контактами (E-Mail, Телефон, Факс), адресом, кодом, внешним кодом, активностью, сортировкой, а также пользовательские поля (UF_CRM_*). Названия возвращаемых параметров совпадают с кодами полей API. Используйте нужные параметры в следующих шагах бизнес-процесса (условия, подстановка в документы, изменение других сущностей).
Важно о возвращаемых параметрах: Если реквизит с указанным ID не найден, данные не возвращаются и в журнал бизнес-процесса записывается сообщение об ошибке. Проверяйте наличие реквизита или обрабатывайте ошибку в следующих шагах (например, по условию или через обработку исключений).
Важно! Ограничения и рекомендации:
Обязательный параметр:
Для выполнения активити (робота) обязательно указать идентификатор реквизита. Реквизит с указанным ID должен существовать в CRM. Если реквизит не найден, вызов завершится с записью об ошибке в журнал.
Состав возвращаемых полей:
Перечень возвращаемых параметров зависит от настроек портала и набора полей в crm.requisite.fields (включая пользовательские поля UF_CRM_*). После добавления новых полей или шаблонов реквизитов в CRM может потребоваться переустановка активити (робота), чтобы новые поля появились в возвращаемых параметрах.
Права доступа:
Сотрудник, указанный в поле «Запускать от имени», должен иметь права на просмотр реквизитов в CRM. Рекомендуется использовать сотрудника с правами администратора. От прав может зависеть доступ к отдельным полям.
Источник ID реквизита:
ID реквизита можно получить из активити (робота) «Добавление реквизита» (id_requisite), «Поиск реквизитов», «Изменение реквизита» (если ID был сохранён в переменную), а также из переменных или полей документа на предыдущих шагах.
Обязательный параметр:
Для выполнения активити (робота) обязательно указать идентификатор реквизита. Реквизит с указанным ID должен существовать в CRM. Если реквизит не найден, вызов завершится с записью об ошибке в журнал.
Состав возвращаемых полей:
Перечень возвращаемых параметров зависит от настроек портала и набора полей в crm.requisite.fields (включая пользовательские поля UF_CRM_*). После добавления новых полей или шаблонов реквизитов в CRM может потребоваться переустановка активити (робота), чтобы новые поля появились в возвращаемых параметрах.
Права доступа:
Сотрудник, указанный в поле «Запускать от имени», должен иметь права на просмотр реквизитов в CRM. Рекомендуется использовать сотрудника с правами администратора. От прав может зависеть доступ к отдельным полям.
Источник ID реквизита:
ID реквизита можно получить из активити (робота) «Добавление реквизита» (id_requisite), «Поиск реквизитов», «Изменение реквизита» (если ID был сохранён в переменную), а также из переменных или полей документа на предыдущих шагах.