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

userfieldconfig.list

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

userfieldconfig.list({moduleId: string, select: ?{}, order: ?{}, filter: ?{}, start: number = 0})

Метод вернет список настроек пользовательских полей.

Параметры

Параметр Описание С версии
moduleId Строковый идентификатор модуля. Обязательный.
select Массив с полями, которые надо показать. По умолчанию выводятся все, кроме вариантов для списка и языковых фраз. Чтобы получить фразы в списке, необходимо передать идентификатор языка по ключу language
order Список для определения порядка отображения, где ключ - название поля, а значение - ASC или DESC
filter Список для фильтрации

Пример

Пример запроса

Найти все множественные настройки пользовательских полей из модуля rpa, отсортированные по убыванию id, со всеми полями и языковыми фразами для языка ru.

{
	"moduleId": "rpa",
	"select": {
		"0": "*",
		"language": "ru"
	},
	"order": {
		"id": "DESC"
	},
	"filter": {
		"multiple": "Y"
	}
}

Формат ответа в части языковых фраз немного отличается, так как здесь фразы только для одного языка.

{
	"fields": [
		{
			"id": "165",
			"entityId": "RPA_1",
			"fieldName": "UF_RPA_1_1585069397",
			"userTypeId": "file",
			"xmlId": null,
			"sort": "100",
			"multiple": "Y",
			"mandatory": "N",
			"showFilter": "E",
			"showInList": "Y",
			"editInList": "Y",
			"isSearchable": "Y",
			"settings": {
				"SIZE": 20,
				"LIST_WIDTH": 0,
				"LIST_HEIGHT": 0,
				"MAX_SHOW_SIZE": 0,
				"MAX_ALLOWED_SIZE": 0,
				"EXTENSIONS": []
			},
			"languageId": {
				"ru": "ru"
			},
			"editFormLabel": {
				"ru": "Множественный файл"
			},
			"listColumnLabel": null,
			"listFilterLabel": null,
			"errorMessage": null,
			"helpMessage": null
		},
		{
			... 
		}
	]
}


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