метод REST
scope: crm
crm.requisite.userfield.get
Получить пользовательское поле по id
Описание
Метод возвращает пользовательское поле реквизита по идентификатору.
Параметры
id
integer
обязательный
Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list
Примеры запроса
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_webhook_here**/crm.requisite.userfield.get
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type RequisiteUserFieldGetResult = {
ID: string
ENTITY_ID: string
FIELD_NAME: string
USER_TYPE_ID: string
XML_ID: string | null
SORT: string
MULTIPLE: string
MANDATORY: string
SHOW_FILTER: string
SHOW_IN_LIST: string
EDIT_IN_LIST: string
IS_SEARCHABLE: string
EDIT_FORM_LABEL: Record<string, string>
LIST_COLUMN_LABEL: Record<string, string>
LIST_FILTER_LABEL: Record<string, string>
ERROR_MESSAGE: Record<string, string>
HELP_MESSAGE: Record<string, string>
SETTINGS: Record<string, unknown>
}
try {
const response = await $b24.actions.v2.call.make<RequisiteUserFieldGetResult>({
method: 'crm.requisite.userfield.get',
params: {
id: 235,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.ID, result.FIELD_NAME, result.USER_TYPE_ID)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getRequisiteUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.userfield.get',
params: {
id: 235,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.ID, result.FIELD_NAME, result.USER_TYPE_ID)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRequisiteUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.userfield.get(
bitrix_id=235,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
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.callMethod(
"crm.requisite.userfield.get",
{
id: 235
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.userfield.get',
[
'id' => 235
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.userfield.get", b24.Params{
"id": 235,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.userfield.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
EntityID string `json:"ENTITY_ID"`
FieldName string `json:"FIELD_NAME"`
UserTypeID string `json:"USER_TYPE_ID"`
Sort string `json:"SORT"`
Multiple string `json:"MULTIPLE"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.EntityID)
Ответ
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
}
}
Возвращаемые данные
result
object
Объект, содержащий значения полей, описывающих пользовательское поле реквизита
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"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 |
Недостаточно прав доступа для получения пользовательского поля |

