Получить список полей задачи tasks.task.field.list
Scope:
tasksКто может выполнять метод: любой пользователь
Метод tasks.task.field.list возвращает список доступных полей задачи.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Список полей описания, которые нужно вернуть в ответе. Доступные поля:
|
Примеры кода
Как использовать примеры в документации
Вызов нового api отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/tasks.task.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"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.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/tasks.task.field.list
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
try
{
const response = await $b24.callMethod(
'tasks.task.field.list',
{
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
}
);
const result = response.getData().result;
console.log('Field list:', result);
}
catch( error )
{
console.error('Error:', error);
}
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
try {
$response = $b24Service
->core
->call(
'tasks.task.field.list',
[
'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();
}
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
BX24.callMethod(
'tasks.task.field.list',
{
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
require_once('crest.php');
$result = CRest::call(
'tasks.task.field.list',
[
'select' => [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"name": "id",
"type": "int",
"title": "id",
"description": null,
"filterable": true,
"sortable": true,
"multiple": false
},
{
"name": "title",
"type": "string",
"title": "title",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "description",
"type": "string",
"title": "description",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "creatorId",
"type": "int",
"title": "creatorId",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "creator",
"type": "object",
"title": "creator",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "created",
"type": "object",
"title": "created",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "responsibleId",
"type": "int",
"title": "responsibleId",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "responsible",
"type": "object",
"title": "responsible",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
// ...
{
"name": "inMute",
"type": "array",
"title": "inMute",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "source",
"type": "object",
"title": "source",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "dependsOn",
"type": "array",
"title": "dependsOn",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "scenarios",
"type": "array",
"title": "scenarios",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
}
]
},
"time": {
"start": 1773648753,
"finish": 1773648753.478823,
"duration": 0.4788229465484619,
"processing": 0,
"date_start": "2026-03-16T11:12:33+03:00",
"date_finish": "2026-03-16T11:12:33+03:00",
"operating_reset_at": 1773649353,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
items |
Массив объектов с описанием полей. Структура ответа зависит от |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
"message": "Неизвестное поле `unknownField` для сущности `DtoFieldDto`"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте права пользователя и scope |
Ошибки в параметре select
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте только поля из списка: |
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение select |
Передайте |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить поле задачи tasks.task.field.get
- Получить задачу tasks.task.get
- Задачи в REST 3.0: обзор методов