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

userfieldtype.add

Регистрация нового типа пользовательских полей. Метод возвращает 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,
        ],
    ]
);

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
1
Денис Пряхин
Сообщение не промодерировано, возможны ошибки и неточности.
После создания поля данные в ключе 'USER_TYPE_ID' => 'custom_type' приобретает значение 'rest_№Приложения_custom_type'. При регистрации нового поля необходимо указывать userTypeId в формате 'rest_№Приложения_custom_type' иначе будет ошибка.
© «Битрикс», 2001-2022, «1С-Битрикс», 2022
Наверх