Scope: lists Права на выполнение: для всех
Описание
lists.field.add (params)
Метод создает поле списка. В случае успешного создания поля ответ true, иначе Exception.
Параметры
| Параметр | Описание |
|---|
| IBLOCK_TYPE_ID | id типа инфоблока (обязательно):
- lists - тип инфоблока списка
- bitrix_processes - тип инфоблока процессов
- lists_socnet - тип инфоблока списков групп
|
| IBLOCK_CODE/IBLOCK_ID | код или id инфоблока (обязательно) |
| SOCNET_GROUP_ID | id группы (обязательно, если список создается для группы); |
| 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());
}
);