Документация REST действия
Получение данных по счетам
Получение данных по счетам
Наносимая польза
Вы научитесь получать из сущностей данные для дальнейшей работы.
Данный пример взят из бизнес-процесса "Контроль дебиторки". Там из счёта получаем данные по сроку оплаты и сравниваем его с текущей датой. Далее по результатам сравнения выстраивается логика уведомлений для клиентов и сотрудников.
Подготовка
Важно! Не импортируйте файл примера в бизнес-процессы CRM, чтобы не наделать себе лишних полей. Используйте бизнес-процессы (далее по тексту БП) в живой ленте.
- Скачайте шаблон БП «Получение данных по счетам» по ссылке https://getmorecash.bitrix24.ru/~bfL5o
- В главном меню Битрикс24 перейдите на вклдаку «Бизнес-процессы»
- Перейдите в «Процессы в ленте»
- Нажмите на зелёную кнопку «Создать новый»
- В поле «Название процесса» впишите название (Получения данных по счетам), подписи и доступ пока задавать не будем.
- Перейдите в список созданного БП
- Далее нажмите на копку «Действия», рядом с синей кнопкой «Добавить», и выберите пункт «Настроить бизнес-процессы»
- Нажмите на «Создать последовательный бизнес-процесс»
- Задайте название (Получения данных по счетам), снимите галочку с пунта «Автоматический запуск» - «При добавлении». Сохраните.
- Нажмите на «Импорт», откроется окно «Текущий шаблон бизнес-процесса будет заменен импортируемым. Продолжить?», жмёте «Ок».
- Выберите ранее загруженный шаблон (из шага 1) и нажмите «Импортировать».
- Шаблон импортируется.
- Нажмите на «Параметры шаблона»
- Перейдите в вкладку «Константы» и в строке «Кому отладка» нажмите на «Изменить»
- В поле «Значение константы» выберите себя. Нажмите «Ок» и «Сохранить»
- Нажмите «Сохранить», чтобы сохранить бизнес-процесс.
Настройка действия
- Заходим в созданных бизнес-процесс
- Жмём на шестерёнку к действия «[РЕСТ Действия] Получить параметр через REST»
- В открывшемся окне будут следующие поля:
- Заголовок - Тут можно указать любое название действия, удобно для дальнейшего поиска действия и получения от него данных.
- REST-метод - сюда указываем требуемый метод рест. В шаблоне указан «crm.invoice.get» ссылка на хелп https://dev.1c-bitrix.ru/rest_help/crm/invoice/crm_invoice_get.php
- Параметры REST-запроса - указываем параметры запроса, соответствующие выбранному методу. В шаблоне указан { "id": {{ID счёта}}}. В документации { "id": id }. Валидность запроса удобно проверять сервисом https://jsonformatter.curiousconcept.com/
- JSONPath - указываем выражение для фильтрации, поле множественное. Можно указать до 10 выражений. Если выполнение метода не предполагает фильтрации, то указываем знак доллара
$
. Для фильтрации результатов выполнении get-запросов поля можно получить через fields-запросы или стандартные в хелпе реста, пример для счетов https://dev.1c-bitrix.ru/rest_help/crm/invoice/crm_invoice_fields.php В шаблоне указаны:
$.STATUS_ID - статус счёта$.DATE_INSERT - Дата создания$.UF_CONTACT_ID - Контакт, привязанный к счёту$.UF_DEAL_ID - Сделка привязанная к счёту$.DATE_PAY_BEFORE - Срок оплаты$.PRICE - Сумма- Запускать от имени - укажите от какого пользователя будет выполнятся действие. В примере указана константа пользователя отладки.
- Установить текст статуса - переключатель Да/Нет. Рекомендую оставить в положении «Да».
- Текст статуса - Укажите информативный статус, чтобы потом при выполнении бизнес-процесса знать какое действие выполняется. В шаблоне указан «Получаем данные по счёту»
- Ожидать ответ - строго «Да».
- Период ожидания - сколько времени действие будет ждать ответ от нашего сервера, перед тем как продолжиться выполнение бизнес-процесса. Не оставляйте это поле пустым, иначе при не получении ответа от нашего сервера Ваш процесс зависнет. Стандартно ставим 10 минут, как и в шаблоне.
- Сохраняем действие.
- Сохраняем бизнес-процесс
- Для перехода к списку нажимаем «К списку» в верхнем правом углу.
Тестирование работы бизнес-процесса
Для тестирования БП нужно чтобы были созданы счета в Битрикс24.
Получение ID счёта
- Откройте счёт
- Перейдите в адресную строку браузера, там вы увидите примерно следующее https://mydomain.bitrix24.ru/crm/invoice/show/208/
- «208» и будет ID счёта
Добавление ID счёта в список и запуск БП
- Жмём голубую кнопку «Добавить»
- В поле «ID счёта» Указываем ID счёта
- Сохраняем.
- В левой части строки с нашим ID счёта нажимаем на бургер (три горизонтальные полоски)
- В меню выбираем «Запустить бизнес-процесс» - «Получения данных по счетам»
- БП запуститься, отработает и в колокольчик придёт уведомление.