Документация REST действия

Получение данных по счетам

Получение данных по счетам

Наносимая польза

Вы научитесь получать из сущностей данные для дальнейшей работы.

Данный пример взят из бизнес-процесса "Контроль дебиторки". Там из счёта получаем данные по сроку оплаты и сравниваем его с текущей датой. Далее по результатам сравнения выстраивается логика уведомлений для клиентов и сотрудников.

Подготовка

Важно! Не импортируйте файл примера в бизнес-процессы CRM, чтобы не наделать себе лишних полей. Используйте бизнес-процессы (далее по тексту БП) в живой ленте.

  1. Скачайте шаблон БП «Получение данных по счетам» по ссылке https://getmorecash.bitrix24.ru/~bfL5o
  2. В главном меню Битрикс24 перейдите на вклдаку «Бизнес-процессы»
  3. Перейдите в «Процессы в ленте»
  4. Нажмите на зелёную кнопку «Создать новый»
  5. В поле «Название процесса» впишите название (Получения данных по счетам), подписи и доступ пока задавать не будем.
  6. Перейдите в список созданного БП
  7. Далее нажмите на копку «Действия», рядом с синей кнопкой «Добавить», и выберите пункт «Настроить бизнес-процессы»
  8. Нажмите на «Создать последовательный бизнес-процесс»
  9. Задайте название (Получения данных по счетам), снимите галочку с пунта «Автоматический запуск» - «При добавлении». Сохраните.
  10. Нажмите на «Импорт», откроется окно «Текущий шаблон бизнес-процесса будет заменен импортируемым. Продолжить?», жмёте «Ок».
  11. Выберите ранее загруженный шаблон (из шага 1) и нажмите «Импортировать».
  12. Шаблон импортируется.
  13. Нажмите на «Параметры шаблона»
  14. Перейдите в вкладку «Константы» и в строке «Кому отладка» нажмите на «Изменить»
  15. В поле «Значение константы» выберите себя. Нажмите «Ок» и «Сохранить»
  16. Нажмите «Сохранить», чтобы сохранить бизнес-процесс.

Настройка действия

  1. Заходим в созданных бизнес-процесс
  2. Жмём на шестерёнку к действия «[РЕСТ Действия] Получить параметр через REST»
  3. В открывшемся окне будут следующие поля:
    1. Заголовок - Тут можно указать любое название действия, удобно для дальнейшего поиска действия и получения от него данных.
    2. REST-метод - сюда указываем требуемый метод рест. В шаблоне указан «crm.invoice.get» ссылка на хелп https://dev.1c-bitrix.ru/rest_help/crm/invoice/crm_invoice_get.php
    3. Параметры REST-запроса - указываем параметры запроса, соответствующие выбранному методу. В шаблоне указан { "id": {{ID счёта}}}. В документации { "id": id }. Валидность запроса удобно проверять сервисом https://jsonformatter.curiousconcept.com/
    4. 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 - Сумма
    1. Запускать от имени - укажите от какого пользователя будет выполнятся действие. В примере указана константа пользователя отладки.
    2. Установить текст статуса - переключатель Да/Нет. Рекомендую оставить в положении «Да».
    3. Текст статуса - Укажите информативный статус, чтобы потом при выполнении бизнес-процесса знать какое действие выполняется. В шаблоне указан «Получаем данные по счёту»
    4. Ожидать ответ - строго «Да».
    5. Период ожидания - сколько времени действие будет ждать ответ от нашего сервера, перед тем как продолжиться выполнение бизнес-процесса. Не оставляйте это поле пустым, иначе при не получении ответа от нашего сервера Ваш процесс зависнет. Стандартно ставим 10 минут, как и в шаблоне.
  4. Сохраняем действие.
  5. Сохраняем бизнес-процесс
  6. Для перехода к списку нажимаем «К списку» в верхнем правом углу.

Тестирование работы бизнес-процесса

Для тестирования БП нужно чтобы были созданы счета в Битрикс24.

Получение ID счёта

  1. Откройте счёт
  2. Перейдите в адресную строку браузера, там вы увидите примерно следующее https://mydomain.bitrix24.ru/crm/invoice/show/208/
  3. «208» и будет ID счёта

Добавление ID счёта в список и запуск БП

  1. Жмём голубую кнопку «Добавить»
  2. В поле «ID счёта» Указываем ID счёта
  3. Сохраняем.
  4. В левой части строки с нашим ID счёта нажимаем на бургер (три горизонтальные полоски)
  5. В меню выбираем «Запустить бизнес-процесс» - «Получения данных по счетам»
  6. БП запуститься, отработает и в колокольчик придёт уведомление.
Edit this page on GitHub