tasks.task.file.field.get
Получить поле файлов задачи
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод tasks.task.file.field.get возвращает описание поля файлов задачи по имени.
Параметры
name
string
обязательный
Имя поля, описание которого нужно получить
select
array
необязательный
Список полей описания, которые нужно вернуть в ответе.
Доступные поля:
- name — имя поля
- type — тип данных
- title — заголовок
- description — описание
- validationRules — правила валидации
- requiredGroups — группы обязательности
- filterable — признак доступности в фильтре
- sortable — признак доступности в сортировке
- editable — признак редактируемости
- multiple — признак множественного значения
- elementType — тип элемента для составных полей
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"taskId","select":["name","type","title","description","filterable","sortable","multiple"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.file.field.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"taskId","select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/tasks.task.file.field.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 FileFieldGetResult = {
item: {
name: string
type: string
title: string
description: string | null
filterable: boolean
sortable: boolean
multiple: boolean
}
}
try {
const response = await $b24.actions.v3.call.make<FileFieldGetResult>({
method: 'tasks.task.file.field.get',
params: {
name: 'taskId',
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple',
],
},
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('Field item:', result.item)
}
} 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 getFileField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'tasks.task.file.field.get',
params: {
name: 'taskId',
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple',
],
},
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('Field item:', result.item)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFileField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
select = [
"name",
"type",
"title",
"description",
"filterable",
"sortable",
"multiple",
]
try:
bitrix_response = client.tasks.task.file.field.get(
name='taskId',
select=select,
).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(
'tasks.task.file.field.get',
[
'name' => 'taskId',
'select' => [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.task.file.field.get',
{
name: 'taskId',
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.task.file.field.get',
[
'name' => 'taskId',
'select' => [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.task.file.field.get", b24.Params{
"name": "taskId",
"select": []string{"name", "type", "title", "description", "filterable", "sortable", "multiple"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.task.file.field.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
Name string `json:"name"`
Type string `json:"type"`
Title string `json:"title"`
Filterable bool `json:"filterable"`
Sortable bool `json:"sortable"`
Multiple bool `json:"multiple"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Type)
Ответ
HTTP-статус: 200
{
"result": {
"item": {
"name": "taskId",
"type": "int",
"title": "taskId",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
}
},
"time": {
"start": 1773649754,
"finish": 1773649754.213566,
"duration": 0.21356606483459473,
"processing": 0,
"date_start": "2026-03-16T11:29:14+03:00",
"date_finish": "2026-03-16T11:29:14+03:00",
"operating_reset_at": 1773650354,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с данными ответа
item
object
Объект с описанием поля. Структура ответа зависит от select
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"field": "name",
"message": "Обязательное поле `name` не указано"
}
]
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
| — | Доступ запрещен | Проверьте права пользователя и scope task |

