task.item.userfield.get
Получить пользовательское поле задачи по идентификатору
Описание
Метод task.item.userfield.get получает описание пользовательского поля задачи по идентификатору.
Параметры
ID
integer
обязательный
Идентификатор пользовательского поля.
Идентификатор пользовательского поля задачи можно получить при создании поля или методом получения списка полей
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ID": 1325
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ID": 1325,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/task.item.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 user field object returned in result
// Shape of the payload returned in result (match the "response handling" section of the page)
type UserFieldResult = {
ID: string
ENTITY_ID: string
FIELD_NAME: string
USER_TYPE_ID: string
XML_ID: string
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: {
SIZE: number
ROWS: number
REGEXP: string
MIN_LENGTH: number
MAX_LENGTH: number
DEFAULT_VALUE: string
}
}
try {
const response = await $b24.actions.v2.call.make<UserFieldResult>({
method: 'task.item.userfield.get',
params: {
ID: 1325,
},
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 getUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.item.userfield.get',
params: {
ID: 1325,
},
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', getUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.task.item.userfield.get(
bitrix_id=1325,
).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(
'task.item.userfield.get',
[
'ID' => 1325
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'task.item.userfield.get',
{
ID: 1325
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.userfield.get',
[
'ID' => 1325
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.item.userfield.get", b24.Params{
"ID": 1325,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("task.item.userfield.get: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": {
"ID": "1325",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
"USER_TYPE_ID": "string",
"XML_ID": "UF_TASK_CLIENT_REQUEST",
"SORT": "220",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 10,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": "Уточнить цель и ожидаемый результат"
},
"EDIT_FORM_LABEL": {
"ar": "",
"br": "",
"de": "",
"en": "Description of client request",
...,
"ru": "Описание запроса клиента",
...
},
"LIST_COLUMN_LABEL": {
"ar": "Запрос клиента",
"br": "Запрос клиента",
...
},
"LIST_FILTER_LABEL": {
"ar": "Запрос клиента",
"br": "Запрос клиента",
...
},
"ERROR_MESSAGE": {
"ar": "Запрос клиента",
"br": "Запрос клиента",
...
},
"HELP_MESSAGE": {
"ar": "Запрос клиента",
"br": "Запрос клиента",
...
}
},
"total": 0,
"time": {
"start": 1772718119,
"finish": 1772718119.677154,
"duration": 0.6771540641784668,
"processing": 0,
"date_start": "2026-03-05T16:41:59+03:00",
"date_finish": "2026-03-05T16:41:59+03:00",
"operating_reset_at": 1772718719,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект пользовательского поля (подробное описание)
total
integer
Сейчас возвращает 0
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_CORE",
"error_description": "ID is not defined or invalid."
}
| Код | Описание | Значение |
|---|---|---|
400 |
ERROR_CORE |
No parameters found |
400 |
ERROR_CORE |
ID is not defined or invalid |
400 |
ERROR_NOT_FOUND |
The entity with ID '{ID}' is not found |

