Получение данных по сущности: Сделка

Активити (робот) "Получение данных по сущности: Сделка" предназначено для использования в роботах и бизнес-процессах и может быть полезно в следующих сценариях:

Получение всех данных сделки по её ID;
Получение значений пользовательских полей сделки;
Получение данных связанных контактов сделки;
Формирование отчётов и документов на основе данных сделки;
Передача данных сделки в другие системы или активити;
Подготовка данных для печати (с форматированием);
Получение данных сделки из другой воронки или направления;
Анализ и аудит данных сделок;
Копирование данных между сделками;
Интеграция с внешними системами через REST API.

Как работает активити (робот):
- Активити (робот) получает все данные сделки по указанному ID через REST API (crm.deal.get);
- Автоматически получает список всех доступных полей сделки, включая пользовательские поля;
- Может получать данные связанных контактов сделки (crm.deal.contact.items.get);
- Поддерживает форматирование данных для печати;
- Возвращает все поля сделки как отдельные параметры для использования в бизнес-процессе;
- Работает с любыми сделками, к которым есть доступ у указанного пользователя.

Описание параметров активити (робота)

Название поля	Описание и примеры использования
ID сущности	В данном поле указывается ID сущности "сделка", данные которой необходимо получить. Это обязательный параметр. Примеры: - {=Document:ID} - получить данные текущей сделки; - 123 - получить данные сделки с ID 123; - {=Variable:DEAL_ID} - использовать ID из переменной предыдущего активити (робота); - {=A1988_22222_92566_99999:search_result_first_string} - использовать первый ID из результата поиска.
Для печати	Варианты: да/нет. Данное поле позволяет включить вывод данных в удобном для печати текстовом виде. При включении этой опции данные форматируются для удобного отображения в документах и отчётах.
Сообщение об ошибке	Варианты: да/нет. Позволяет выводить ошибки в журнал БП. Рекомендуется включать при отладке бизнес-процесса.
Запускать от имени	Данное поле необходимо для того, чтобы установить сотрудника, с правами которого выполнять действие данного активити (робота). Если у сотрудника не будет прав на выполнение действия, то активити (робот) не сработает. Рекомендуем выбирать всегда сотрудника с правами администратора системы.
Устанавливать текст статуса	Данное поле позволяет включать возможность установки статуса бизнес-процесса. Это необходимо для того, чтобы во время работы активити (робота) информировать пользователя в истории о том, что бизнес-процесс остановился на конкретном шаге. Это особенно важно в момент отладки и выяснения причин неполадок в работе механизма.
Текст статуса	В данном поле указывается текстовый вариант статуса, который Вы можете изменять.
Ожидать ответа	Данное поле Вами не управляется. Оно необходимо для того, чтобы определить, нужно ли ожидать реакции от нашего активити (робота) после запуска.
Период ожидания (Время ожидания ответа от приложения)	Данная опция позволяет ограничить срок ожидания ответа от приложения. Технические особенности платформы Битрикс24 иногда создают ситуацию, при которой создаётся очередь из огромного числа запросов. Это может помешать работе нашего активити (робота), и бизнес-процесс будет ожидать длительный период времени. Для того, чтобы не останавливать дальнейшие действия, вы можете установить своё время ожидания. Если время истекло и результат не получен, то бизнес-процесс будет двигаться далее по заложенной вами логике.

Примеры использования активити (робота)

Описание примера	Решение
Получение данных текущей сделки	Параметры: ID сущности - {=Document:ID}. Активити (робот) вернёт все данные текущей сделки, включая стандартные и пользовательские поля.
Получение данных сделки с форматированием для печати	Параметры: ID сущности - {=Document:ID}, Для печати - Да. Активити (робот) вернёт данные сделки в формате, удобном для использования в документах.
Получение данных связанной сделки из переменной	Параметры: ID сущности - {=Variable:RELATED_DEAL_ID}. Активити (робот) получит данные сделки, ID которой хранится в переменной RELATED_DEAL_ID.
Получение данных сделки из результата поиска	Параметры: ID сущности - {=A1988_22222_92566_99999:search_result_first_string}. Активити (робот) получит данные первой найденной сделки из предыдущего активити поиска.
Получение данных сделки для копирования в новую сделку	Параметры: ID сущности - {=Document:ID}. После получения данных, используйте возвращаемые параметры (TITLE, OPPORTUNITY, STAGE_ID и др.) для создания новой сделки.
Получение данных сделки для формирования отчёта	Параметры: ID сущности - {=Document:ID}, Для печати - Да. Используйте возвращаемые параметры для формирования текстового отчёта о сделке.
Получение данных сделки и её контактов	Параметры: ID сущности - {=Document:ID}. Активити (робот) автоматически получит данные связанных контактов и вернёт их имена в отдельных параметрах.
Получение данных сделки через итератор	Параметры: ID сущности - {=Iterator:Value}. Для каждого ID сделки из итератора активити (робот) получит все данные этой сделки.
Получение данных сделки для отправки во внешнюю систему	Параметры: ID сущности - {=Document:ID}. Используйте возвращаемые параметры для формирования запроса к внешней системе (webhook, API интеграция).
Получение данных сделки для проверки условий	Параметры: ID сущности - {=Variable:CHECK_DEAL_ID}. После получения данных используйте возвращаемые параметры в условиях бизнес-процесса для принятия решений.

Возвращаемые параметры данного активити (робота):
- Все поля сделки - активити (робот) возвращает все стандартные и пользовательские поля сделки как отдельные параметры. Например: ID, TITLE, STAGE_ID, OPPORTUNITY, CURRENCY_ID, ASSIGNED_BY_ID, COMPANY_ID, CONTACT_ID и другие.
- Данные контактов - если к сделке привязаны контакты, их имена будут возвращены в отдельных параметрах.
- Сообщение об ошибке (s_error_logs) - строка с описанием ошибки или сообщением об успешном выполнении. При успешном выполнении содержит сообщение "deal_get_data_error_2: [количество полей]".
- Соответствует условиям (math_search_results) - строка, указывающая результат получения данных. Возможные значения: Y (данные получены) или N (сделка не найдена).

Важно о возвращаемых параметрах: Если сделка не найдена или у пользователя нет доступа к ней, параметр math_search_results будет равен N. Всегда проверяйте значение этого параметра перед использованием данных сделки в дальнейших шагах бизнес-процесса.

Важно! Ограничения и рекомендации:

Обязательный параметр:
Для успешного получения данных обязательно должен быть указан параметр "ID сущности". Без указания ID сделки активити (робот) не сможет получить данные.

Права доступа:
Убедитесь, что пользователь, указанный в поле "Запускать от имени", имеет права на просмотр указанной сделки. Если у пользователя нет прав, активити (робот) вернёт ошибку.

Пользовательские поля:
Активити (робот) автоматически получает все пользовательские поля сделки. Названия параметров для пользовательских полей соответствуют их символьным кодам (например, UF_CRM_1234567890).

Связанные контакты:
Если к сделке привязаны контакты, активити (робот) автоматически получит их данные через отдельный запрос (crm.deal.contact.items.get) и вернёт имена контактов в отдельных параметрах.

Форматирование для печати:
При включении опции "Для печати" данные форматируются для удобного отображения. Это особенно полезно при формировании документов и отчётов.

Ваша корзина пуста

Получение данных по сущности: Сделка