Получить список полей шаблона documentgenerator.template.getfields

Scope: documentgenerator

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

Метод documentgenerator.template.getfields возвращает карточку полей шаблона.

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

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор шаблона.

Получить идентификатор шаблона можно после создания шаблона или методом получения списка шаблонов

Примеры кода

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

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
        
try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.getfields',
                {
                    id: 57
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
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
object

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

templateFields
object

Объект полей шаблона. Ключ — поле шаблона, значение — описание поля (подробное описание).

Набор полей в описании зависит от типа поля

Объект templateField

Название
тип

Описание

title
string

Название поля, может отсутствовать

value
any

Текущее значение поля

default
any

Значение поля по умолчанию

required
char

Признак обязательности.

  • Y — обязательное
  • N — необязательное

type
string

Тип поля, например IMAGE

group
array

Группы, к которым относится поле

chain
string | array

Путь поля в провайдере данных

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Cannot get fields from deleted template"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Bitrix\DocumentGenerator\Template constructor must be is public

Не передан обязательный параметр id

400

0

Шаблон не найден

Шаблон с указанным id не найден

400

0

Cannot get fields from deleted template

Нельзя получить поля удаленного шаблона

400

0

You do not have permissions to modify templates

Недостаточно прав для работы с шаблонами

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

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

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

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

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

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

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