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

lists.field.add

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

Описание

lists.field.add (params)

Метод создает поле списка. В случае успешного создания поля ответ true, иначе Exception.

Параметры

ПараметрОписание
IBLOCK_TYPE_IDid типа инфоблока (обязательно):
  • lists - тип инфоблока списка
  • bitrix_processes - тип инфоблока процессов
  • lists_socnet - тип инфоблока списков групп
IBLOCK_CODE/IBLOCK_IDкод или id инфоблока (обязательно)
SOCNET_GROUP_IDid группы (обязательно, если список создается для группы);
FIELDS (ключи такие же как при создании поля из интерфейса Битрикс24)
  • NAME название (обязательно)
  • IS_REQUIRED метка обязательности
  • MULTIPLE метка множественности
  • TYPE тип (обязательно)
    • S - Строка
    • N - Число
    • L - Список
    • F - Файл
    • G - Привязка к разделам
    • E - Привязка к элементам
    • S:Date - Дата
    • S:DateTime - Дата/Время
    • S:HTML - HTML/текст
    • E:EList - Привязка к элементам в виде списка. При создании поля с этим типом необходимо обязательно указать LINK_IBLOCK_ID id информационного блока, элементы которого будут отображаться в селекторе этого поля.
    • N:Sequence - Счетчик
    • S:Money - Деньги
    • S:DiskFile - Файл (Диск)
    • S:map_yandex - Привязка к Яндекс.Карте
    • S:employee - Привязка к сотруднику
    • S:ECrm - Привязка к элементам CRM
  • SORT сортировка
  • DEFAULT_VALUE значение по умолчанию
  • LIST - может использоваться для добавления значений поля типа "Список".
    • n0 - строка пункта
      • SORT - значение сортировки
      • VALUE - значение пункта
  • LIST_TEXT_VALUES - может использоваться для добавления значений поля типа "Список" с помощью строки.(Каждая уникальная строчка станет отдельным значением списка)
  • LIST_DEF - значение по умолчанию для поля типа "Список"(Формат: массив с значением, где значение id пункта списка)
  • CODE код (обязательно, если поле является свойством инфоблока)
  • SETTINGS все ключи должны присутствовать, иначе будет происходить затирание значениями по умолчанию
    • SHOW_ADD_FORM - показывать в форме добавления
    • SHOW_EDIT_FORM - показывать в форме редактирования
    • ADD_READ_ONLY_FIELD - только для чтения (форма добавления)
    • EDIT_READ_ONLY_FIELD - только для чтения (форма редактирования)
    • SHOW_FIELD_PREVIEW - показать поле при формировании ссылки на элемент списка
  • USER_TYPE_SETTINGS - ключ для передачи пользовательских настроек
  • ROW_COUNT/COL_COUNT - настройка для полей textarea
  • LINK_IBLOCK_ID - id привязываемого списка (раздела инфоблока)

Пример

var params = {
	'IBLOCK_TYPE_ID': 'lists_socnet',
	'IBLOCK_CODE': 'rest_1',
	'SOCNET_GROUP_ID': '7'
	'FIELDS': {
		'NAME': 'List field',
		'IS_REQUIRED': 'Y',
		'MULTIPLE': 'N',
		'TYPE': 'L',
		'SORT': '20',
		'CODE': 'fieldList',
		'LIST_TEXT_VALUES': 'one\ntwo\nthree',
		'SETTINGS': {
			'SHOW_ADD_FORM': 'Y',
			'SHOW_EDIT_FORM': 'Y',
			'ADD_READ_ONLY_FIELD': 'N',
			'EDIT_READ_ONLY_FIELD': 'N',
			'SHOW_FIELD_PREVIEW': 'N'
		}
	}
};
BX24.callMethod(
	'lists.field.add',
	params,
	function(result)
	{
		if(result.error())
			alert("Error: " + result.error());
		else
			alert("Success: " + result.data());
	}
);


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Павел Аксёнов
Сообщение не промодерировано, возможны ошибки и неточности.
Цитата
 'FIELDS': {             'NAME': 'List field',             'IS_REQUIRED': 'Y',             'MULTIPLE': 'N',             'TYPE': 'L',             'SORT': '20',             'CODE': 'fieldList',             'LIST_TEXT_VALUES': 'one\ntwo\nthree',             'SETTINGS': {                 'SHOW_ADD_FORM': 'Y',                 'SHOW_EDIT_FORM': 'Y',                 'ADD_READ_ONLY_FIELD': 'N',                 'EDIT_READ_ONLY_FIELD': 'N',                 'SHOW_FIELD_PREVIEW': 'N'             }
В примере параметр "FIELDS" выглядит как объект (массив). По факту, за один запрос создает только одно поле. Если передать объект (массив), создаст только первое поле из переданного массива.
Пробовал на списках групп.
Если в php передать параметр как массив, возвращает ошибку:
Цитата
[error] => ERROR_REQUIRED_PARAMETERS_MISSING
[error_description] => Required parameter "TYPE" is missing
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх