userfieldtype.add

Scope: в зависимости от места встройки Права на выполнение: для всех

Регистрация нового типа пользовательских полей. Метод возвращает true или ошибку с описанием причины.

Параметры

Параметр	Тип	Описание	Ограничения
USER_TYPE_ID	Строка	Строковой код типа. Обязательный параметр.	a-z0-9 Должен быть уникальным.
HANDLER	URL	Адрес обработчика пользовательского типа. Обязательный параметр.	Должен быть в том же домене, что и основной адрес приложения уникальным
TITLE	Строка	Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей.
DESCRIPTION	Строка	Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей.
OPTIONS	Многомерный массив	Дополнительные настройки. На данный момент доступен один ключ: height - указывает высоту пользовательского поля по умолчанию в пикселях. По умолчанию - 0 При указании значения 0 - будет использована высота стандартная для отображения данной встройки. . Применится любое положительное значение.

Примеры

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

BX24.callMethod(
	'userfieldtype.add', 
	{
		USER_TYPE_ID: 'test',
		HANDLER: 'https://www.myapplication.com/handler/',
		TITLE: 'Test type',
		DESCRIPTION: 'Test userfield type for documentation'
	}
);

Пример запроса

POST https://sometestportal.bitrix24.com/rest/userfieldtype.add HTTP/1.1

USER_TYPE_ID=test&HANDLER=https%3A%2F%2Fwww.myapplication.com%2Fhandler%2F&TITLE=Test+type&DESCRIPTION=Test+userfield+type+for+documentation&auth=63t6r4z9cugaciaxocrh2r47zlodp12y

HTTP/1.1 200 OK

{
	"result": true
}

Пример с использованием параметра OPTIONS:

CRest::call(
	'userfieldtype.add',
	[
		'USER_TYPE_ID' => 'custom_type',
		'HANDLER' => 'https://example.com/field.php',
		'TITLE' => 'title',
		'OPTIONS' => [
			'height' => 60,
		],
	]
);