Получить список полей шаблона documentgenerator.template.getfields
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
documentgeneratorКто может выполнять метод: пользователь с правом на изменение шаблонов генератора документов
Метод documentgenerator.template.getfields возвращает карточку полей шаблона.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор шаблона. Получить идентификатор шаблона можно после создания шаблона или методом получения списка шаблонов |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":57}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.getfields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":57,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/documentgenerator.template.getfields
// 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
type TemplateField = {
title?: string
value: unknown
default: unknown
required?: string
type?: string
group?: string[]
chain?: string | unknown[]
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type TemplateGetFieldsResult = {
templateFields: Record<string, TemplateField>
}
try {
const response = await $b24.actions.v2.call.make<TemplateGetFieldsResult>({
method: 'documentgenerator.template.getfields',
params: {
id: 57,
},
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(Object.keys(result.templateFields))
}
} 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: 'documentgenerator.template.getfields',
params: {
id: 57,
},
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(Object.keys(result.templateFields))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTemplateFields)
</script>
try {
$response = $b24Service->core->call(
'documentgenerator.template.getfields',
[
'id' => 57,
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.template.getfields',
{
id: 57
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'documentgenerator.template.getfields',
[
'id' => 57,
]
);
print_r($result);
Обработка ответа
HTTP-статус: 200
{
"result": {
"templateFields": {
"DocumentNumber": {
"title": "Номер",
"value": "9",
"required": "Y",
"group": [
"Документ"
],
"chain": "this.DOCUMENT.DOCUMENT_NUMBER",
"default": "9"
},
"CurrentDate": {
"value": "",
"default": ""
},
"ClientName": {
"value": "",
"default": ""
},
"ClientPhone": {
"value": "",
"default": ""
},
"Total": {
"value": "",
"default": ""
},
"Comment": {
"value": "",
"default": ""
},
"UserName": {
"value": "",
"default": ""
},
"DocumentTitle": {
"title": "Название документа",
"value": "SUPPLY_CONTRACT_NEW Template 1773843147554 9",
"group": [
"Документ"
],
"chain": [
{},
"getTitle"
],
"required": "Y",
"default": "SUPPLY_CONTRACT_NEW Template 1773843147554 9"
}
}
},
"time": {
"start": 1774332782,
"finish": 1774332783.055467,
"duration": 1.055466890335083,
"processing": 1,
"date_start": "2026-03-24T09:13:02+03:00",
"date_finish": "2026-03-24T09:13:03+03:00",
"operating_reset_at": 1774333382,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
templateFields |
Объект полей шаблона. Ключ — поле шаблона, значение — описание поля (подробное описание). Набор полей в описании зависит от типа поля |
Объект templateField
|
Название |
Описание |
|
title |
Название поля, может отсутствовать |
|
value |
Текущее значение поля |
|
default |
Значение поля по умолчанию |
|
required |
Признак обязательности.
|
|
type |
Тип поля, например |
|
group |
Группы, к которым относится поле |
|
Путь поля в провайдере данных |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Cannot get fields from deleted template"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Bitrix\DocumentGenerator\Template constructor must be is public |
Не передан обязательный параметр |
|
|
|
Шаблон не найден |
Шаблон с указанным |
|
|
|
Cannot get fields from deleted template |
Нельзя получить поля удаленного шаблона |
|
|
|
You do not have permissions to modify templates |
Недостаточно прав для работы с шаблонами |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |