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

lists.field.update

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

Описание

lists.field.update (params, fields)

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

Параметры

ПараметрОписание
IBLOCK_TYPE_IDid типа инфоблока (обязательно):
  • lists - тип инфоблока списка
  • bitrix_processes - тип инфоблока процессов
  • lists_socnet - тип инфоблока списков групп
IBLOCK_CODE/IBLOCK_IDкод или id инфоблока (обязательно)
SOCNET_GROUP_IDid группы (обязательно, если список создается для группы);
FIELD_IDID поля. (обязательно. Если поле свойство инфоблока, то формат: "PROPERTY_propertyId")
FIELDS (ключи такие же как при создании поля из интерфейса Битрикс24)
  • NAME название (обязательно)
  • IS_REQUIRED метка обязательности
  • MULTIPLE метка множественности
  • TYPE тип (обязательно)
  • 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',
	'FIELD_ID': 'PROPERTY_61',
	'FIELDS': {
		'NAME': 'List field (Update)',
		'IS_REQUIRED': 'N',
		'MULTIPLE': 'N',
		'TYPE': 'L',
		'SORT': '20',
		'CODE': 'fieldList',
		'LIST': {
			'58': {
				'SORT': '10',
				'VALUE': 'one'
			},
			'59': {
				'SORT': '20',
				'VALUE': 'two'
			},
			'60': {
				'SORT': '30',
				'VALUE': 'three'
			}
		},
		'LIST_DEF': {
			'0': '59'
		},
		'SETTINGS': {
			'SHOW_ADD_FORM': 'Y',
			'SHOW_EDIT_FORM': 'Y',
			'ADD_READ_ONLY_FIELD': 'N',
			'EDIT_READ_ONLY_FIELD': 'Y',
			'SHOW_FIELD_PREVIEW': 'N'
		}
	}
};
BX24.callMethod(
	'lists.field.update',
	params,
	function(result)
	{
		if(result.error())
			alert("Error: " + result.error());
		else
			alert("Success: " + result.data());
	}
);


© «Битрикс», 2001-2024, «1С-Битрикс», 2024