Получить список полей шаблона задачи tasks.template.fields

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь

Метод tasks.template.fields возвращает описание полей шаблона задачи.

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.fields

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.fields

// 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 TemplateFieldsResult = {
  [fieldName: string]: {
    title: string
    type: string
    required?: boolean
    default?: string | number | null
    values?: Record<string, string | null>
    primary?: boolean
  }
}

try {
  const response = await $b24.actions.v2.call.make<TemplateFieldsResult>({
    method: 'tasks.template.fields',
    params: {},
    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('Template fields:', Object.keys(result))
  }
} 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 getTemplateFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'tasks.template.fields',
        params: {},
        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('Template fields:', Object.keys(result))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getTemplateFields)
</script>

try {
    $response = $b24Service
        ->core
        ->call(
            'tasks.template.fields',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);

} catch (Throwable $e) {
    echo 'Ошибка получения полей шаблона: ' . $e->getMessage();
}

BX24.callMethod(
    'tasks.template.fields',
    {},
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'tasks.template.fields',
    []
);

print_r($result);

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.template.fields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("tasks.template.fields: %w", err)
}

keys, ok := b24.Keys(res.Result)
if !ok {
	return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "ID": {
            "title": "ID",
            "type": "integer",
            "primary": true
        },
        "PARENT_ID": {
            "title": "Родительская задача",
            "type": "integer",
            "default": 0
        },
        "TITLE": {
            "title": "Название",
            "type": "string",
            "required": true
        },
        "DESCRIPTION": {
            "title": "Описание",
            "type": "string"
        },
        "PRIORITY": {
            "title": "Приоритет",
            "type": "enum",
            "values": {
                "2": null,
                "1": null,
                "0": null
            },
            "default": 1
        },
        "GROUP_ID": {
            "title": "Проект",
            "type": "integer",
            "default": 0
        },
        "STAGE_ID": {
            "title": "Стадия",
            "type": "integer",
            "default": 0
        },
        "CREATED_BY": {
            "title": "Постановщик",
            "type": "integer",
            "required": true
        },
        "RESPONSIBLE_ID": {
            "title": "Исполнитель",
            "type": "integer",
            "required": true
        },
        "DEPENDS_ON": {
            "title": "Зависимость",
            "type": "integer",
            "required": true
        },
        "RESPONSIBLES": {
            "title": "Исполнители",
            "type": "array"
        },
        "ACCOMPLICES": {
            "title": "Соисполнители",
            "type": "array"
        },
        "AUDITORS": {
            "title": "Наблюдатели",
            "type": "array"
        },
        "STATUS": {
            "title": "Статус",
            "type": "enum",
            "values": {
                "2": null,
                "3": null,
                "4": null,
                "5": null,
                "6": null
            },
            "default": 2
        },
        "MULTITASK": {
            "title": "Множественная задача",
            "type": "enum",
            "values": {
                "Y": "Да",
                "N": "Нет"
            },
            "default": "N"
        },
        "REPLICATE": {
            "title": "Повторяющаяся задача",
            "type": "enum",
            "values": {
                "Y": "Да",
                "N": "Нет"
            },
            "default": "N"
        },
        "SITE_ID": {
            "title": "SITE_ID",
            "type": "string"
        },
        "TASK_CONTROL": {
            "title": "Принять работу",
            "type": "enum",
            "values": {
                "Y": "Да",
                "N": "Нет"
            },
            "default": "N"
        },
        "ADD_IN_REPORT": {
            "title": "Добавить в отчет",
            "type": "enum",
            "values": {
                "Y": "Да",
                "N": "Нет"
            },
            "default": "N"
        },
        "XML_ID": {
            "title": "XML_ID",
            "type": "string",
            "default": null
        },
        "DEADLINE_AFTER": {
            "title": "Крайний срок после",
            "type": "datetime",
            "default": null
        },
        "START_DATE_PLAN_AFTER": {
            "title": "Планируемый старт после",
            "type": "datetime",
            "default": null
        },
        "END_DATE_PLAN_AFTER": {
            "title": "Планируемое завершение после",
            "type": "datetime",
            "default": null
        },
        "TPARAM_TYPE": {
            "title": "Для новых пользователей",
            "type": "enum",
            "values": {
                "1": "Да",
                "0": "Нет"
            },
            "default": 0
        },
        "TPARAM_REPLICATION_COUNT": {
            "title": "Кол-во созданных задач",
            "type": "integer",
            "default": 0
        },
        "REPLICATE_PARAMS": {
            "title": "Параметры постановки задач",
            "type": "string"
        },
        "BASE_TEMPLATE_ID": {
            "title": "Родительский шаблон",
            "type": "integer",
            "default": null
        },
        "TEMPLATE_CHILDREN_COUNT": {
            "title": "Кол-во подшаблонов",
            "type": "integer",
            "default": null
        },
        "UF_CRM_TASK": {
            "title": "Привязка к элементам CRM",
            "type": "crm"
        },
        "UF_TASK_WEBDAV_FILES": {
            "title": "Файл (Диск)",
            "type": "disk_file"
        },
        "UF_AUTO_291715100499": {
            "title": "Строка",
            "type": "string"
        },
        "UF_AUTO_152207278904": {
            "title": "Число",
            "type": "double"
        }
    },
    "time": {
        "start": 1771919518,
        "finish": 1771919518.633086,
        "duration": 0.6330859661102295,
        "processing": 0,
        "date_start": "2026-02-24T10:51:58+03:00",
        "date_finish": "2026-02-24T10:51:58+03:00",
        "operating_reset_at": 1771920118,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с полями шаблона задачи. Для каждого поля возвращается объект с описанием (подробное описание)

time
time

Информация о времени выполнения запроса

Объект описания поля

Название
тип

Описание

title
string

Название поля для отображения

type
string

Тип значения поля

required
boolean

Признак обязательного поля. Возвращается не для всех поле

default
string

Значение по умолчанию. Может быть строкой, числом или null

values
object

Список допустимых значений для полей типа список enum. Ключ объекта — значение, значение объекта — его подпись

primary
boolean

Признак первичного поля

Обработка ошибок

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжить изучение

Предыдущая
Удалить шаблон задачи
Следующая
Обзор методов