При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить пользовательское поле по id crm.requisite.userfield.get», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.
Получить пользовательское поле по id crm.requisite.userfield.get
> Scope: crm
>
> Кто может выполнять метод: любой пользователь
Метод возвращает пользовательское поле реквизита по идентификатору.
Параметры метода
Названиетип | Описание |
|---|---|
id*integer | Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list |
Примеры кода
- cURL (Webhook)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.requisite.userfield.get- cURL (OAuth)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.get- JS
try
{
const response = await $b24.callMethod(
'crm.requisite.userfield.get',
{
id: 235
}
);
const result = response.getData().result;
if (result.error())
{
console.error(result.error());
}
else
{
console.dir(result);
}
}
catch(error)
{
console.error('Error:', error);
}- PHP
try {
$response = $b24Service
->core
->call(
'crm.requisite.userfield.get',
[
'id' => 235
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting user field: ' . $e->getMessage();
}- BX24.js
BX24.callMethod(
"crm.requisite.userfield.get",
{
id: 235
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);- PHP CRest
require_once('crest.php');
$result = CRest::call(
'crm.requisite.userfield.get',
[
'id' => 235
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": "235",
"ENTITY_ID": "CRM_REQUISITE",
"FIELD_NAME": "UF_CRM_NEWTECH_V1_STRING",
"USER_TYPE_ID": "string",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
},
"EDIT_FORM_LABEL": {
"en": "ПП - Строка",
"ru": "ПП - Строка"
},
"LIST_COLUMN_LABEL": {
"en": "ПП - Строка",
"ru": "ПП - Строка"
},
"LIST_FILTER_LABEL": {
"en": "ПП - Строка",
"ru": "ПП - Строка"
},
"ERROR_MESSAGE": {
"en": "UF_CRM_NEWTECH_V1_STRING",
"ru": "UF_CRM_NEWTECH_V1_STRING"
},
"HELP_MESSAGE": {
"en": "UF_CRM_NEWTECH_V1_STRING",
"ru": "UF_CRM_NEWTECH_V1_STRING"
}
},
"time": {
"start": 1717686921.82579,
"finish": 1717686922.874864,
"duration": 1.0490741729736328,
"processing": 0.05396890640258789,
"date_start": "2024-06-06T17:15:21+02:00",
"date_finish": "2024-06-06T17:15:22+02:00",
"operating": 0
}
}Возвращаемые данные
Названиетип | Описание |
|---|---|
resultobject | Объект, содержащий значения полей, описывающих пользовательское поле реквизита |
timetime | Информация о времени выполнения запроса |
Описание полей пользовательского поля реквизита
Названиетип | Описание |
|---|---|
IDint | Идентификатор пользовательского поля |
ENTITY_IDstring | Идентификатор сущности, к которой относится пользовательское поле. Для реквизитов это всегда CRM_REQUISITE |
FIELD_NAMEstring | Символьный код. Для реквизитов всегда начинается с префикса UF_CRM_ |
USER_TYPE_IDstring | Тип данных (string, boolean, double или datetime) |
XML_IDstring | Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком |
SORTint | Сортировка |
MULTIPLEchar | Признак множественности. Возможные значения: — Y — да— N — нет |
MANDATORYchar | Признак обязательности. Возможные значения: — Y — да— N — нет |
SHOW_FILTERchar | Показывать ли в фильтре списка. Возможные значения: — N — не показывать— I — точное совпадение— E — маска— S — подстрока |
SHOW_IN_LISTchar | Показывать ли в списке. Возможные значения: — Y — да— N — нет |
EDIT_IN_LISTchar | Разрешать ли редактирование пользователем. Возможные значения: — Y — да— N — нет |
IS_SEARCHABLEchar | Участвуют ли значения поля в поиске. Возможные значения: — Y — да— N — нет |
EDIT_FORM_LABELstring | Подпись в форме редактирования |
LIST_COLUMN_LABELstring | Заголовок в списке |
LIST_FILTER_LABELstring | Подпись фильтра в списке |
ERROR_MESSAGEstring | Сообщение об ошибке |
HELP_MESSAGEstring | Помощь |
LISTuf_enum_element | Элементы списка. Для получения подробной информации смотрите раздел [](../../universal/user-defined-fields/crm-userfield-enumeration-fields) |
SETTINGSobject | Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел [](../../universal/user-defined-fields/crm-userfield-settings-fields) |
Обработка ошибок
HTTP-статус: 40x, 50x
{
"error": "ERROR_NOT_FOUND",
"error_description": "The entity with ID '235' is not found."
}Возможные ошибки
| Код | Текст ошибки | Описание |
|---|---|---|
| Пустая строка | ID is not defined or invalid | Идентификатор пользовательского поля не задан или имеет недопустимое значение |
ERROR_NOT_FOUND | The entity with ID '235' is not found | Пользовательское поле с указанным идентификатором не найдено |
| Пустая строка» | Access denied | Недостаточно прав доступа для получения пользовательского поля |
- [](./crm-requisite-userfield-add)
- [](./crm-requisite-userfield-update)
- [](./crm-requisite-userfield-list)
- [](./crm-requisite-userfield-delete)
💡 Экспертное мнение и рекомендации
Практические рекомендации:
- При написании кастомных компонентов для «Получить пользовательское поле по id crm.requisite.userfield.get» всегда разделяйте бизнес-логику и представление (шаблон).
- Используйте отладку SQL-запросов через конструкцию
$wpdb->last_queryили стандартный трекер Битрикса, чтобы контролировать нагрузку.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru