Значки на канбане

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

Описание

Значок на канбане - поле, имеющее специальный внешний вид и дающее возможность отметить элементы канбана, требующие внимания. Если к одному элементу добавлено несколько значков, показан будет только один, добавленный последним.

В продукте используется ряд штатных значков для разных сценариев.

В сделки и другие сущности CRM через Rest можно добавить конфигурируемое дело. Если поле badgeCode такого дела содержит код одного из зарегистрированных значков, то этот значок будет показываться на канбане сущности, к которой привязано дело, до тех пор, пока дело не будет закрыто.

crm.activity.badge.get

crm.activity.badge.get(code: string)

Информация о значке.

Параметры

Параметр	Описание	Тип
code	Код значка

Метод вернет массив, содержащий поля значка.

Пример:

{
	"code": "missedCall",
	"title": {
		"ru": "Статус звонка",
		"en": "Call status"
	},
	"value": "Пропущен",
	"type": "failure"
}

crm.activity.badge.list

crm.activity.badge.list()

Список доступных значков.

Без параметров.

Метод вернет массив, содержащий список всех зарегистрированных значков. Каждый элемент массива содержит поля значка.

crm.activity.badge.add

crm.activity.badge.add(code: string, title: string|array, value: string|array, type: string)

Добавить значок.

Параметры

Параметр	Описание	Тип
code	Код значка
title	Заголовок значка. Может быть как строкой, так и массивом строк для разных языков.
value	Заголовок значка. Может быть как строкой, так и массивом строк для разных языков.
type	Тип значка

Доступ к выполнению этого метода есть только у администратора CRM.

crm.activity.badge.delete

crm.activity.badge.delete(code: string)

Удалить значок

Параметры

Параметр	Описание	Тип
code	Код значка

Доступ к выполнению этого метода есть только у администратора CRM.

Поля записи о значке

Поле	Описание	Тип
code	Код значка	string
title	Заголовок значка. Может быть как строкой, так и массивом строк для разных языков.	string/array
value	Заголовок значка. Может быть как строкой, так и массивом строк для разных языков.	string/array
type	Тип значка	string

Если title или value содержит массив, то ключами в нем должны быть коды языков, а значениями текст на этих языках, например:

{
	"ru": "Внимание",
	"en": "Alarm"
}

Если перевод для текущего языка не найден, то будет использоваться английский. Если и английский не найден, то будет использоваться первый элемент массива.

Тип значка может принимать следующие значения:

success - Зеленый фон
failure - Красный фон
warning - Желтый фон
primary - Голубой фон
secondary - Серый фон