Документация для разработчиков
Темная тема

Направления смарт-процессов

Описание


Обязательный параметр entityTypeId

На вход всех методов обязательно должен передаваться параметр entityTypeId, где должен быть записан идентификатор типа сущности CRM.

Если тип сущности не поддерживает работу с направлениями (например, лиды или предложения), то методы работать не будут.


Направления по умолчанию

У каждого типа сущности одновременно может быть только одно направление по умолчанию. В связи с этим есть ряд ограничений:

  • нельзя удалить направление по умолчанию;
  • при создании нового направления и передаче ему флага "isDefault": "Y" старое направление по умолчанию перестанет быть направлением по умолчанию;
  • при изменении направления по умолчанию нельзя сделать его направлением не по умолчанию;
  • при изменении направления направления не по умолчанию с передачей ему флага "isDefault": "Y" старое направление по умолчанию перестанет быть направлением по умолчанию.

Если для имеющегося смарт-процесса отключен показ направлений в интерфейсе, то работа с направлениями через rest всё равно возможна.

Методы

Scope: crm Права на выполнение: для всех

Методы работы с направлениями сделок и смарт-процессов описаны в отдельном разделе.

МетодыОписание
crm.category.fieldsОтдает информацию о полях направлений.
crm.category.getОтдает информацию о направлении с идентификатором id.
crm.category.listВозвращает массив направлений, которые относятся к типу сущности с идентификатором entityTypeId.
crm.category.addСоздаёт у типа сущности с идентификатором entityTypeId новое направление с полями fields.
crm.category.updateОбновляет направление с идентификатором id, задав ему новые значения полей из fields.
crm.category.deleteУдаляет направление с идентификатором id, которое относится к типу сущности с идентификатором entityTypeId.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024