userfieldconfig.update

Scope: userfieldconfig, scope модуля Права на выполнение: для всех

Описание и параметры

userfieldconfig.update({moduleId: string, id: number, field: {}})

Метод изменяет значение поля.

Параметры

Параметр	Описание	С версии
moduleId	Строковый идентификатор модуля. Обязательный.
id	Идентификатор настроек поля. Обязательный.
field	Список с полями настройки нового поля. Аналогично методу userfieldconfig.add, но: fieldName - не может быть изменен userTypeId - не может быть изменен entityId - не может быть изменен editInList - не может быть изменен multiple - не может быть изменен isSearchable - изменение этого флага не вызовет автоматическое перестроение поискового индекса. Перестроение происходит при изменении сущностей, к которым привязаны поля enum - полный список всех вариантов значений для свойства типа "список". Чтобы это поле учитывалось, в fields должен присутствовать userTypeId id - идентификатор варианта. Должен присутствовать, если надо обновить вариант

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

Возвращаемое значение и пример

Возвращаемое значение

Метод вернет такие же данные, как метод userfieldconfig.get на измененном поле.

Примеры

Обновление флагов и языковых фраз, без изменения вариантов значений

{
	"moduleId": "rpa",
	"id": 170,
	"field": {
		"mandatory": "Y",
		"editFormLabel": {
			"ru": "Новое название поля"
		}	 
	} 
}

Пример удаление всех вариантов значений.

{
	"moduleId": "rpa",
	"id": 170,
	"field": {
		"userTypeId": "enumeration",
		"enum": [
			[""]
		]	 
	}
}

Пример частичного обновления вариантов значений.

{
	"moduleId": "rpa",
	"id": 170,
	"field": {
		"userTypeId": "enumeration",
		"enum": [
			{
				"id": 29,
			},
			{
				"id": 30,
				"value": "Обновленное значение"
			},
			{
				"value": "Новое значение"
			}
		]	 
	}
}

В этом примере:

вариант значения с id=29 останется без изменений,
у варианта с id=30 поменяется значение
добавится новый вариант "Новое значение"
все остальные варианты будут удалены

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Александр Зайцев 04.02.2023 15:29:06

Сообщение не промодерировано, возможны ошибки и неточности.

по добавлению варианта значения перечисления (тестировал на импорте в пользовательские поля типа список)
чтобы не потерять предыдущие значения - необходимо кроме существующего id указывать существующее value

Код

$arData =  
[
 "moduleId" => "crm",    //модуль CRM
 "id" => 1090,           //id свойства
 "field" => [
       "userTypeId" => "enumeration",
       "enum" => [
                   ["id" => 29, "value"=> "СУЩЕСТВУЮЩЕЕ ЗНАЧЕНИЕ"],
                   ["id" => 30, "value"=> "Обновленное значение"],
                   ["value" => "Новое значение"],
                 ]
             ]    
];  

$result = CRest::call("userfieldconfig.update",$arData)

в этом примере значение id=29 не исчезнет

Наверх