История движения по стадиям

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

Описание

crm.stagehistory.list(
	{
		entityTypeId: number,
		order: ?{} = null,
		filter: ?{} = null,
		select: ?{} = null,
		start: ?number = 0
	}
)

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

Параметры

Параметр	Описание	С версии
entityTypeId	Идентификатор типа сущности. Может принимать значения: 1 - лид 2 - сделка 5 - счет
order	Список для сортировки, где ключ - поле, а значение - ASC или DESC
filter	Список для фильтрации. Фильтр поддерживает использование точных значений, массивов значений, а также модификаторы =, !=, <, >, >=, <=. Поиск по like не поддерживается.
start	Сдвиг для постраничной навигации. Логика работы с постраничкой стандартная для списочных рест методов.

Возвращаемое значение

Метод вернет массив записей из истории:

{
	"items": []
}

Каждый элемент массива - массив с ключами:

ID - идентификатор записи
TYPE_ID - тип записи. Может принимать значения: 1 - создание сущности, 2 - перевод на промежуточную стадию, 3 - перевод на финальную стадию
OWNER_ID - идентификатор сущности, в которой изменилась стадия
CREATED_TIME - дата и время попадания на стадию

Помимо этого, имеются специфичные для разных типов сущностей поля:

для лидов и счетов это
- STATUS_SEMANTIC_ID - семантика статуса P - промежуточная стадия,
  S - успешная стадия,
  F - провальная стадия (стадии).
- STATUS_ID - идентификатор статуса (стадии)
для сделок это
- CATEGORY_ID - идентификатор направления (воронки)
- STAGE_SEMANTIC_ID - семантика статуса P - промежуточная стадия,
  S - успешная стадия,
  F - провальная стадия (стадии).
- STAGE_ID - идентификатор стадии

Пример вызова

Получение истории движения по стадиям для сделки с ID=1

BX24.callMethod(
	"crm.stagehistory.list",
	{
		entityTypeId: 2,
		order: { "ID": "ASC" },
		filter: { "OWNER_ID": 1 },
		select: [ "ID", "STAGE_ID", "CREATED_TIME" ]
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
		{
			console.dir(result.data());
			if(result.more())
				result.next();
		}
	}
);