userfieldconfig.add

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

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

userfieldconfig.add({moduleId: string, field: {}})

Метод добавит новое пользовательского поле.

Параметры

Параметр	Описание	С версии
moduleId	Строковый идентификатор модуля. Обязательный.
field	Список с полями настройки нового поля: entityId - строковый идентификатор сущности. Обязательное. fieldName - код поля. Должен быть сформирован по шаблону `UF_ + {идентификатор сущности} + _ + {произвольная строка в UPPER_CASE}`. Код поля не может быть больше 50 символов. Обязательное. userTypeId - строковый идентификатор типа поля Типы полей идентичны полям для главного модуля Подробнее... . Обязательное. xmlId - внешний идентификатор. sort - индекс сортировки. multiple - флаг множественности (N или Y), по умолчанию N. Этот флаг можно указать только при создании поля. mandatory - флаг обязательности (N или Y), по умолчанию N. showFilter - флаг показа поля в фильтре (N или Y), по умолчанию N. showInList - флаг показа поля в списке (N или Y), по умолчанию Y. editInList - флаг разрешения редактирования поля в списке (N или Y), по умолчанию Y. isSearchable - флаг наличия значения поля в полнотекстовом индексе Добавляйте в поиск только нужные поля. На построение индекса уходит время при изменении каждого значения поля, что может существенно замедлить работы при большом количестве таких полей. (N или Y), по умолчанию N. settings - список с дополнительными настройками поля. editFormLabel - список с языкозависимыми названиями поля, где ключ - идентификатор языка, а значение - фраза. enum - массив с вариантами значений для свойств типа "список": value - значение варианта. Обязательное def - флаг значения по умолчанию (N или Y), по умолчанию N. Только один может быть вариантом по умолчанию sort - индекс сортировки. Если не задан, генерируется автоматически на основе порядка передачи вариантов значений xmlId - внешний идентификатор варианта

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

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

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

Примеры

Пример простого запроса. Этого запроса достаточно для создания поля типа "строка".

{
	"moduleId": "rpa",
	"field": {
		"entityId": "RPA_1",
		"fieldName": "UF_RPA_1_NEW_REST_STRING",
		"userTypeId": "string",
	} 
}

Создание поля типа "список"

{
	"moduleId": "rpa",
	"field": {
		"entityId": "RPA_1",
		"fieldName": "UF_RPA_1_NEW_REST_STRING",
		"userTypeId": "enumeration"
	} 
}

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

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

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

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

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

Наверх