tasks.template.fields — метод REST API Битрикс24

Описание

Метод 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>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.tasks.template.fields().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.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

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